Shipping zones determine the available shipping methods for a given shipping address. The match is evaluated against a set of regular expressions on the address country, state or zip code (learn more).
A shipping zone object is returned as part of the response body of each successful create, list, retrieve, or update API call.
Field | Type | Description |
type |
|
|
id |
| The shipping zone unique identifier |
links.self |
| The shipping zone endpoint URL |
attributes.name |
| The shipping zone's internal name. |
attributes.country_code_regex |
| The regex that will be evaluated to match the shipping address country code. |
attributes.not_country_code_regex |
| The regex that will be evaluated as negative match for the shipping address country code. |
attributes.state_code_regex |
| The regex that will be evaluated to match the shipping address state code. |
attributes.not_state_code_regex |
| The regex that will be evaluated as negative match for the shipping address state code. |
attributes.zip_code_regex |
| The regex that will be evaluated to match the shipping address zip code. |
attributes.not_zip_code_regex |
| The regex that will be evaluated as negative match for the shipping zip country code. |
attributes.id |
| Unique identifier for the resource (hash). |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add your own identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool or a CRM. |
attributes.metadata |
| 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. |
meta.mode |
| The resource environment (can be one of |