Guides
Fetching Shipping Zones From a Platform
Introduction
Getting Started
- Apps
- Pagination
- Authentication
- Environments
- Definitions
Checkout
- Overview
- Getting Started
- Merchants
- Catalog
- Carts and Bags
- Discounts
- Payments
- Payouts
- Webhooks
- Guides
- FAQs
- Resources
- Current Platforms
Violet Connect
- Overview
- Setup
- Payouts
- Commissions
- Guides
- Testing
- FAQs
Relay
Product Info
Guides
Fetching Shipping Zones From a Platform
Relay Get Shipping Zones
Using Relay the shipping zone and shipping method data in an external commerce platform is translated into a single common schema in real time. You can fetch these shipping zones using the Relay Get Shipping Zones endpoint.
Get Shipping Zones
The response will contain all shipping zones and all methods within those zones. There is no pagination when using this endpoint.
GET /v1/relay/merchants/{merchant_id}/shipping-zones
{
"content": [{
"external_id": "457216524578",
"name": "Domestic",
"display_order": 1,
"enabled": true,
"regions": [{
"name": "United States",
"code": "US",
"type": "COUNTRY",
"enabled": true,
"display_order": 1,
"sub_regions": [{
"name": "Washington",
"code": "WA",
"type": "PROVINCE",
"enabled": true,
"display_order": 55,
"metadata": [{
"type": "STRING",
"key": "tax_name",
"value": "State Tax"
},
{
"type": "DECIMAL",
"key": "tax",
"value": 0.065
},
{
"type": "DECIMAL",
"key": "tax_percentage",
"value": 6.5
}
]
}],
"metadata": [{
"type": "DECIMAL",
"key": "tax",
"value": 0.0
},
{
"type": "STRING",
"key": "tax_name",
"value": "Federal Tax"
}
]
}],
"methods": [{
"external_id": "641084293410",
"name": "Free Ground Shipping Over $50",
"price": 0,
"type": "PRICE",
"min_price": 5000,
"price_type": "SUBTOTAL"
},
{
"external_id": "641084326178",
"name": "Economy",
"price": 490,
"type": "WEIGHT",
"min_weight": 0.0,
"max_weight": 5.0,
"weight_unit": "POUND"
},
{
"external_id": "641084358946",
"name": "Economy",
"price": 1990,
"type": "WEIGHT",
"min_weight": 5.0,
"max_weight": 70.0,
"weight_unit": "POUND"
},
{
"external_id": "641084457250",
"name": "First Class Package",
"carrier_name": "USPS",
"type": "CARRIER",
"metadata": [{
"type": "DECIMAL",
"key": "percent_modifier",
"value": 0.0
},
{
"type": "DECIMAL",
"key": "flat_modifier",
"value": 0.0
}
]
},
{
"external_id": "641084457250",
"name": "Priority Mail Express",
"carrier_name": "USPS",
"type": "CARRIER",
"metadata": [{
"type": "DECIMAL",
"key": "percent_modifier",
"value": 0.0
},
{
"type": "DECIMAL",
"key": "flat_modifier",
"value": 0.0
}
]
},
{
"external_id": "641084457250",
"name": "Priority Mail",
"carrier_name": "USPS",
"type": "CARRIER",
"metadata": [{
"type": "DECIMAL",
"key": "percent_modifier",
"value": 0.0
},
{
"type": "DECIMAL",
"key": "flat_modifier",
"value": 0.0
}
]
}
],
"free_shipping": {
"enabled": true,
"min_price": 5000,
"price_type": "SUBTOTAL",
"exclude_products_with_custom_shipping": true
}
}]
}
Supported Platforms
- Shopify
- BigCommerce
- WooCommerce
Was this page helpful?
On this page