Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
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.
Path Parameters
Response
The display order of the shipping zone in the external commerce platform.
Is the shipping zone enabled in the external commerce platform.
The ID of the shipping zone in the external commerce platform.
A summary of the free shipping (if any) for a shipping zone.
Is the shipping method enabled in the external commerce platform.
Are products with custom shipping overrides excluded from free shipping. May be null when there is no free shipping available.
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 Additional data about the shipping zone.
ID of the meta object in the external commerce platform
Type of the value in the external commerce platform
The key of meta value
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN The meta value. Values of type JSON will be stringified
Schema version
The methods included for this shipping zone.
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 ID of the shipping method in the external commerce platform.
The maximum price of a price constrained shipping method in the external commerce platform. Will be null when not of type PRICE.
The maximum weight of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.
Additional data about the shipping method.
ID of the meta object in the external commerce platform
Type of the value in the external commerce platform
The key of meta value
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN The meta value. Values of type JSON will be stringified
Schema version
The minimum price of a price constrained shipping method in the external commerce platform. Will be null when not of type PRICE.
The minimum weight of a weight constrained shipping method in the external commerce platform. Will be null when not of type WEIGHT.
The name of the shipping method 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 the price, whether it applies to the subtotal or the total. Will be null when not of type PRICE.
SUBTOTAL, TOTAL, SUBTOTAL, TOTAL The type of shipping method in the external commerce platform
ORDER, WEIGHT, PRICE, CARRIER, ORDER, WEIGHT, PRICE, CARRIER 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 The name of the shipping zone in the external commerce platform.
The regions included for this shipping zone.
The display order of the shipping zone region in the external commerce platform.
Is the shipping zone region enabled in the external commerce platform.
The ID of the shipping zone region in the external commerce platform.
Additional data about the shipping zone region.
ID of the meta object in the external commerce platform
Type of the value in the external commerce platform
The key of meta value
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN The meta value. Values of type JSON will be stringified
Schema version
The abbreviated code of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The display order of the shipping zone region in the external commerce platform.
Is the shipping zone region enabled in the external commerce platform.
The ID of the shipping zone region in the external commerce platform.
Additional data about the shipping zone region.
ID of the meta object in the external commerce platform
Type of the value in the external commerce platform
The key of meta value
The source the meta object originated from, either EXTERNAL or INTERNAL, with EXTERNAL representing data from the external commerce platform
INTERNAL, EXTERNAL Type of the value
STRING, JSON, INTEGER, LONG, DECIMAL, BOOLEAN The meta value. Values of type JSON will be stringified
Schema version
The abbreviated code of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The display order of the shipping zone region in the external commerce platform.
Is the shipping zone region enabled in the external commerce platform.
The ID of the shipping zone region in the external commerce platform.
Additional data about the shipping zone region.
The abbreviated code of the shipping zone region in the external commerce platform.
Sub regions (if any) that belong to this parent shipping region.
The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT The type of the shipping zone region in the external commerce platform.
COUNTRY, PROVINCE, POSTCODE, CONTINENT Was this page helpful?