Shipping V2
Get All Shipping Zones
GET /stores/{store_hash}/v2/shipping/zones
Request
Returns a list of all Shipping Zones.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
Body
idinteger
Zone ID
Example: 1
namestring
Zone name. Required for PUT requests.
Example: United States
typestring
Allowed: zip | country | state | global
locationsarray[object]
Array of zone locations.
free_shippingobject
handling_feesobject
One of:percentage surcharge fixed_surchargestring
Flat-rate handling fee applied to shipping cost.
Example: 0
display_separatelyboolean
Indicates whether store displays handling fee separately at checkout.
Example: true
enabledboolean
Whether this shipping zone is enabled.
Example: true
Example 1: Zones are Country Zones
Example 2: Zone is Selection of States in a Country
Create a Shipping Zone
POST /stores/{store_hash}/v2/shipping/zones
Request
Creates a Shipping Zone.
Authentication
- X-Auth-Token in headerrequired
Show details
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
namestring
requiredZone name. Required for PUT requests.
Example: United States
typestring
requiredAllowed: zip | country | state | global
locationsarray[object] Array of zone locations.
free_shippingobject handling_feesobject
One of:fixed surcharge percentage surcharge fixed_surchargestring
Flat-rate handling fee applied to shipping cost.
Example: 0
display_separatelyboolean
Indicates whether store displays handling fee separately at checkout.
Example: true
enabledboolean
Whether this shipping zone is enabled.
Example: true
Type: ZIP
Type: Country
Type: State
Type: Global
Response
Body
idinteger
Zone ID.
Example: 1
namestring
Zone name.
Example: United States
typestring
Allowed: zip | country | state | global
locationsarray[object] Array of zone locations.
free_shippingobject handling_feesobject
One of:fixed surcharge percentage surcharge fixed_surchargestring
Flat-rate handling fee applied to shipping cost.
Example: 0
display_separatelyboolean
Indicates whether store displays handling fee separately at checkout.
Example: true
enabledboolean
Whether this shipping zone is enabled.
Example: true
Get a Shipping Zones
GET /stores/{store_hash}/v2/shipping/zones/{id}
Request
Returns a single Shipping Zone.
Authentication
- X-Auth-Token in headerrequired
Show details
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- id in path - integerrequired
ID of the shipping zone.
example
Response
Body
idinteger
Zone ID
Example: 1
namestring
Zone name.
Example: United States
typestring
Allowed: zip | country | state | global
locationsarray[object] Array of zone locations.
free_shippingobject handling_feesobject
One of:fixed surcharge percentage surcharge fixed_surchargestring
Flat-rate handling fee applied to shipping cost.
Example: 0
display_separatelyboolean
Indicates whether store displays handling fee separately at checkout.
Example: true
enabledboolean
Whether this shipping zone is enabled.
Example: true
example
Update a Shipping Zone
PUT /stores/{store_hash}/v2/shipping/zones/{id}
Request
Updates a Shipping Zone.
Required Fields
- name
Read Only Fields
- id
Authentication
- X-Auth-Token in headerrequired
Show details
Parameters
- store_hash in path - string
- id in path - integerrequired
ID of the shipping zone.
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
idinteger
read-onlyZone ID. Read-only.
Example: 1
namestring
requiredZone name. Required for PUT requests.
Example: United States
typestring
Allowed: zip | country | state | global
locationsarray[object] Array of zone locations.
free_shippingobject handling_feesobject
One of:fixed surcharge percentage surcharge fixed_surchargestring
Flat-rate handling fee applied to shipping cost.
Example: 0
display_separatelyboolean
Indicates whether store displays handling fee separately at checkout.
Example: true
enabledboolean
Whether this shipping zone is enabled.
Example: true
example
Response
Body
idinteger
read-onlyZone ID. Read-only.
Example: 1
namestring
requiredZone name. Required for PUT requests.
Example: United States
typestring
Allowed: zip | country | state | global
locationsarray[object] Array of zone locations.
free_shippingobject handling_feesobject
One of:fixed surcharge percentage surcharge fixed_surchargestring
Flat-rate handling fee applied to shipping cost.
Example: 0
display_separatelyboolean
Indicates whether store displays handling fee separately at checkout.
Example: true
enabledboolean
Whether this shipping zone is enabled.
Example: true
example
Delete a Shipping Zone
DELETE /stores/{store_hash}/v2/shipping/zones/{id}
Request
Deletes a Shipping Zone.
Authentication
- X-Auth-Token in headerrequired
Show details
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- id in path - integerrequired
ID of the shipping zone.