# The shipping zone object

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, max size is 5000.                                                                                                      |
| attributes.**not\_country\_code\_regex** | `string`   | The regex that will be evaluated as negative match for the shipping address country code, max size is 5000.                                                                                         |
| attributes.**state\_code\_regex**        | `string`   | The regex that will be evaluated to match the shipping address state code, max size is 5000.                                                                                                        |
| attributes.**not\_state\_code\_regex**   | `string`   | The regex that will be evaluated as negative match for the shipping address state code, max size is 5000.                                                                                           |
| attributes.**zip\_code\_regex**          | `string`   | The regex that will be evaluated to match the shipping address zip code, max size is 5000.                                                                                                          |
| attributes.**not\_zip\_code\_regex**     | `string`   | The regex that will be evaluated as negative match for the shipping zip country code, max size is 5000.                                                                                             |
| 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.                                                                                                                                                                             |
| relationships.**event\_stores**          | `array`    | The associated event stores.                                                                                                                                                                        |
| meta.**mode**                            | `string`   | The resource environment (can be one of `test` or `live`)                                                                                                                                           |