- Get API Keys
- Welcome
- Access
- Merchant
- Configuration
- Explore
- Offers
- SKUs
- Categories
- Collections
- Currencies
- Cart
- Items
- Customer
- Discounts
- Shipping
- Payment
- Completion
- Refunds
- Orders
- Webhooks
- Webhook Events
- Wekbhook Headers
- Merchant/App Installs
- Connection
- Shipping
Overview
Login
Merchants
Catalog
Orders & Checkout
Events
Apps
Operations
Relay
Relay - Get Shipping Zones
Get realtime shipping zone data directly from the merchant’s ecom platform.
Most metadata returned in the response is unique to a commerce platform. This is data that does not fit into a universal schema but may still provide value.
Headers
Path Parameters
Response
The ID of the shipping zone in the external commerce platform.
The name of the shipping zone in the external commerce platform.
The display order of the shipping zone in the external commerce platform.
Is the shipping zone enabled in the external commerce platform.
The regions included for this shipping zone.
The ID of the shipping zone region in the external commerce platform.
The abbreviated code of the shipping zone region in the external commerce platform.
The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT, COUNTRY, PROVINCE, POSTCODE, CONTINENT Is the shipping zone region enabled in the external commerce platform.
The display order of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The ID of the shipping zone region in the external commerce platform.
The abbreviated code of the shipping zone region in the external commerce platform.
The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT, COUNTRY, PROVINCE, POSTCODE, CONTINENT Is the shipping zone region enabled in the external commerce platform.
The display order of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The ID of the shipping zone region in the external commerce platform.
The abbreviated code of the shipping zone region in the external commerce platform.
The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT, COUNTRY, PROVINCE, POSTCODE, CONTINENT Is the shipping zone region enabled in the external commerce platform.
The display order of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The ID of the shipping zone region in the external commerce platform.
The abbreviated code of the shipping zone region in the external commerce platform.
The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT, COUNTRY, PROVINCE, POSTCODE, CONTINENT Is the shipping zone region enabled in the external commerce platform.
The display order of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The ID of the shipping zone region in the external commerce platform.
The abbreviated code of the shipping zone region in the external commerce platform.
The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT, COUNTRY, PROVINCE, POSTCODE, CONTINENT Is the shipping zone region enabled in the external commerce platform.
The display order of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The ID of the shipping zone region in the external commerce platform.
The abbreviated code of the shipping zone region in the external commerce platform.
The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT, COUNTRY, PROVINCE, POSTCODE, CONTINENT Is the shipping zone region enabled in the external commerce platform.
The display order of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
Additional data about the shipping zone region.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Additional data about the shipping zone region.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Additional data about the shipping zone region.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Additional data about the shipping zone region.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Additional data about the shipping zone region.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Additional data about the shipping zone region.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL The methods included for this shipping zone.
The ID of the shipping method in the external commerce platform.
The name of the shipping method in the external commerce platform.
The name of the carrier (if any) in the external commerce platform. May be null or empty when not of type CARRIER.
The display order of the shipping method in the external commerce platform.
Is the shipping method enabled in the external commerce platform.
The price of the shipping method in the external commerce platform. May be null for carrier rates.
The type of shipping method in the external commerce platform
ORDER, WEIGHT, PRICE, CARRIER, ORDER, WEIGHT, PRICE, CARRIER The minimum price of a price constrained shipping method in the external commerce platform. Will be null when not of type PRICE.
The maximum price of a price constrained shipping method in the external commerce platform. Will be null when not of type PRICE.
The type of the price, whether it applies to the subtotal or the total. Will be null when not of type PRICE.
SUBTOTAL, TOTAL, SUBTOTAL, TOTAL The minimum weight of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.
The maximum weight of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.
The weight unit of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.
CARAT, GRAM, OUNCE, POUND, KILOGRAM, TON, TONNE Additional data about the shipping method.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL A summary of the free shipping (if any) for a shipping zone.
Is the shipping method enabled in the external commerce platform.
The minimum price threshold to unlock free shipping in the external commerce platform. May be null when there is no free shipping available.
The type of the price, whether it applies to the subtotal or the total. May be null when there is no free shipping available.
SUBTOTAL, TOTAL, SUBTOTAL, TOTAL Are products with custom shipping overrides excluded from free shipping. May be null when there is no free shipping available.
Additional data about the shipping zone.
Schema version
Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN Type of the value in the external commerce platform
The key of meta value
The meta value. Values of type JSON will be stringified
ID of the meta object in the external commerce platform
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Was this page helpful?