The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
You can use the ShippingZone resource to view shipping zones and their countries, provinces, and shipping rates. A shipping zone belongs to a delivery profile, which provides shops with the ability to create shipping rates per product variant and per location. For example, the merchant might want to use a shipping rate that applies only to fragile products. When querying the ShippingZone resource, each shipping zone is returned with its corresponding profile ID, location group ID, and countries. Its possible for the same country to exist in multiple shipping zones, if the shipping zones with overlapping countries have different delivery profiles.
Was this section helpful?
Properties
The unique numeric identifier for the shipping zone.
The name of the shipping zone, specified by the user.
The ID of the shipping zone's delivery profile. Shipping profiles allow merchants to create product-based or location-based shipping rates.
location_group_id
read-only
The ID of the shipping zone's location group. Location groups allow merchants to create shipping rates that apply only to the specific locations in the group.
The sub-regions of a country. The term provinces also encompasses states.
Information about carrier shipping providers and the rates used.
Information about a price-based shipping rate.
Information about a weight-based shipping rate.
Was this section helpful?
Get a list of all shipping zones
api_version
string
required
fields
Show only specific fields by providing a comma-separated list of field names.
Was this section helpful?
Was this section helpful?