Shipping Zones

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.

The shipping zone object

A shipping zone object is returned as part of the response body of each successful create, list, retrieve or update API call. The following table contains the list of all its fields along with their type, description and example values.
Object fields:
name
string
The shipping zone's internal name.
Example:
Europe (main countries)
country_code_regex
string
The regex that will be evaluated to match the shipping address country code.
Example:
AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT
not_country_code_regex
string
The regex that will be evaluated as negative match for the shipping address country code.
Example:
AT|BE|BG|CZ|DK|EE|DE
state_code_regex
string
The regex that will be evaluated to match the shipping address state code.
Example:
A[KLRZ]|C[AOT]|D[CE]|FL
not_state_code_regex
string
The regex that will be evaluated as negative match for the shipping address state code.
Example:
A[KLRZ]|C[AOT]
zip_code_regex
string
The regex that will be evaluated to match the shipping address zip code.
Example:
(?i)(JE1|JE2|JE3|JE4|JE5)
not_zip_code_regex
string
The regex that will be evaluated as negative match for the shipping zip country code.
Example:
(?i)(JE1|JE2|JE3)
id
integer
Unique identifier for the resource.
Example:
1234
created_at
datetime
Time at which the resource was created.
Example:
2018-01-01T12:00:00.000Z
updated_at
datetime
Time at which the resource was last updated.
Example:
2018-01-01T12:00:00.000Z
reference
string
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
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.
Example:
{"foo":"bar"}

Create a shipping zone

To create a new shipping zone, send a POST request to the /api/shipping_zones endpoint, passing the resource arguments in the request body. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.
Arguments:
name
required
The shipping zone's internal name.
Example:
Europe (main countries)
country_code_regex
optional
The regex that will be evaluated to match the shipping address country code.
Example:
AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT
not_country_code_regex
optional
The regex that will be evaluated as negative match for the shipping address country code.
Example:
AT|BE|BG|CZ|DK|EE|DE
state_code_regex
optional
The regex that will be evaluated to match the shipping address state code.
Example:
A[KLRZ]|C[AOT]|D[CE]|FL
not_state_code_regex
optional
The regex that will be evaluated as negative match for the shipping address state code.
Example:
A[KLRZ]|C[AOT]
zip_code_regex
optional
The regex that will be evaluated to match the shipping address zip code.
Example:
(?i)(JE1|JE2|JE3|JE4|JE5)
not_zip_code_regex
optional
The regex that will be evaluated as negative match for the shipping zip country code.
Example:
(?i)(JE1|JE2|JE3)
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
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.
Example:
#
Example request:
POST /api/shipping_zones HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "shipping_zones",
    "attributes": {
      "name": "Europe (main countries)"
    }
  }
}
Example response: 201 Created
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "shipping_zones",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/shipping_zones/1234"
    },
    "attributes": {
      "name": "Europe (main countries)",
      "country_code_regex": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT",
      "not_country_code_regex": "AT|BE|BG|CZ|DK|EE|DE",
      "state_code_regex": "A[KLRZ]|C[AOT]|D[CE]|FL",
      "not_state_code_regex": "A[KLRZ]|C[AOT]",
      "zip_code_regex": "(?i)(JE1|JE2|JE3|JE4|JE5)",
      "not_zip_code_regex": "(?i)(JE1|JE2|JE3)",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all shipping zones

To fetch a collection of shipping zones, send a GET request to the /api/shipping_zones endpoint.

Example request:
GET /api/shipping_zones HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "1234",
      "type": "shipping_zones",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/shipping_zones/1234"
      },
      "attributes": {
        "name": "Europe (main countries)",
        "country_code_regex": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT",
        "not_country_code_regex": "AT|BE|BG|CZ|DK|EE|DE",
        "state_code_regex": "A[KLRZ]|C[AOT]|D[CE]|FL",
        "not_state_code_regex": "A[KLRZ]|C[AOT]",
        "zip_code_regex": "(?i)(JE1|JE2|JE3|JE4|JE5)",
        "not_zip_code_regex": "(?i)(JE1|JE2|JE3)",
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 shipping_zones (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/shipping_zones?page[number]=1&page[size]=25",
    "prev": "/api/shipping_zones?page[number]=2&page[size]=25",
    "next": "/api/shipping_zones?page[number]=4&page[size]=25",
    "last": "/api/shipping_zones?page[number]=5&page[size]=25"
  }
}
Available filters
idreferenceidscreated_at_fromcreated_at_toupdated_at_fromupdated_at_to
Sortable attributes
nameidcreated_atupdated_atreference

Retrieve a shipping zone

To fetch a single shipping zone, send a GET request to the /api/shipping_zones/{{id}} endpoint, where {{id}} is the id of the resource that you want to retrieve.
Example request:
GET /api/shipping_zones/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "shipping_zones",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/shipping_zones/1234"
    },
    "attributes": {
      "name": "Europe (main countries)",
      "country_code_regex": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT",
      "not_country_code_regex": "AT|BE|BG|CZ|DK|EE|DE",
      "state_code_regex": "A[KLRZ]|C[AOT]|D[CE]|FL",
      "not_state_code_regex": "A[KLRZ]|C[AOT]",
      "zip_code_regex": "(?i)(JE1|JE2|JE3|JE4|JE5)",
      "not_zip_code_regex": "(?i)(JE1|JE2|JE3)",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a shipping zone

To update an existing shipping zone, send a PATCH request to the /api/shipping_zones/{{id}} endpoint, where {{id}} is the id of the resource that you want to update. The following table contains the list of all the possible arguments that you can pass with the request body, along with their type, description and examples values. Please note that all arguments are optional.
Arguments:
name
optional
The shipping zone's internal name.
Example:
Europe (main countries)
country_code_regex
optional
The regex that will be evaluated to match the shipping address country code.
Example:
AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT
not_country_code_regex
optional
The regex that will be evaluated as negative match for the shipping address country code.
Example:
AT|BE|BG|CZ|DK|EE|DE
state_code_regex
optional
The regex that will be evaluated to match the shipping address state code.
Example:
A[KLRZ]|C[AOT]|D[CE]|FL
not_state_code_regex
optional
The regex that will be evaluated as negative match for the shipping address state code.
Example:
A[KLRZ]|C[AOT]
zip_code_regex
optional
The regex that will be evaluated to match the shipping address zip code.
Example:
(?i)(JE1|JE2|JE3|JE4|JE5)
not_zip_code_regex
optional
The regex that will be evaluated as negative match for the shipping zip country code.
Example:
(?i)(JE1|JE2|JE3)
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
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.
Example:
#
Example request:
PATCH /api/shipping_zones/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "shipping_zones",
    "id": 1234,
    "attributes": {
      "name": "Europe (main countries)"
    },
    "relationships": {
    }
  }
}
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "shipping_zones",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/shipping_zones/1234"
    },
    "attributes": {
      "name": "Europe (main countries)",
      "country_code_regex": "AT|BE|BG|CZ|DK|EE|DE|HU|LV|LT",
      "not_country_code_regex": "AT|BE|BG|CZ|DK|EE|DE",
      "state_code_regex": "A[KLRZ]|C[AOT]|D[CE]|FL",
      "not_state_code_regex": "A[KLRZ]|C[AOT]",
      "zip_code_regex": "(?i)(JE1|JE2|JE3|JE4|JE5)",
      "not_zip_code_regex": "(?i)(JE1|JE2|JE3)",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a shipping zone

To delete a shipping zone, send a DELETE request to the /api/shipping_zones/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.
Example request:
DELETE /api/shipping_zones/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 204 No Content
HTTP/1.1 204 No Content

Get our machine-readable JSON schema that follows the OpenAPI Specification (formerly Swagger).

Get our Postman collection in one click and start making real calls to Commerce Layer API in minutes.

Get in touch with our support team if you have any questions or want to learn more about Commerce Layer.