Comment on page

The shipping zone object

A comprehensive list of the shipping zone resource's attributes and relationships

A shipping zone object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/shipping_zones endpoint.
Fields
Field
Type
Description
type
string
shipping_zones
id
string
The shipping zone unique identifier
links.self
string
The shipping zone endpoint URL
attributes.name
string
The shipping zone's internal name.
attributes.country_code_regex
string
The regex that will be evaluated to match the shipping address country code.
attributes.not_country_code_regex
string
The regex that will be evaluated as negative match for the shipping address country code.
attributes.state_code_regex
string
The regex that will be evaluated to match the shipping address state code.
attributes.not_state_code_regex
string
The regex that will be evaluated as negative match for the shipping address state code.
attributes.zip_code_regex
string
The regex that will be evaluated to match the shipping address zip code.
attributes.not_zip_code_regex
string
The regex that will be evaluated as negative match for the shipping zip country code.
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.attachments
array
The associated attachments.
relationships.versions
array
The associated changes.
meta.mode
string
The resource environment (can be one of test or live)

Field	Type	Description
type	`string`	`shipping_zones`
id	`string`	The shipping zone unique identifier
links.self	`string`	The shipping zone endpoint URL
attributes.name	`string`	The shipping zone's internal name.
attributes.country_code_regex	`string`	The regex that will be evaluated to match the shipping address country code.
attributes.not_country_code_regex	`string`	The regex that will be evaluated as negative match for the shipping address country code.
attributes.state_code_regex	`string`	The regex that will be evaluated to match the shipping address state code.
attributes.not_state_code_regex	`string`	The regex that will be evaluated as negative match for the shipping address state code.
attributes.zip_code_regex	`string`	The regex that will be evaluated to match the shipping address zip code.
attributes.not_zip_code_regex	`string`	The regex that will be evaluated as negative match for the shipping zip country code.
attributes.created_at	`datetime`	Time at which the resource was created.
attributes.updated_at	`datetime`	Time at which the resource was last updated.
attributes.reference	`string`	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	`string`	Any identifier of the third party system that defines the reference code
attributes.metadata	`object`	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.attachments	`array`	The associated attachments.
relationships.versions	`array`	The associated changes.
meta.mode	`string`	The resource environment (can be one of `test` or `live`)

Shipping zones

Create a shipping zone

Last modified 3mo ago