Create a shipping zone

How to create a shipping zone via API

To create a new shipping zone, send a POST request to the /api/shipping_zones endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/shipping_zones

Arguments

Body ParameterTypeRequired

type

string

Required

attributes.name

string

Required

attributes.country_code_regex

string

Optional

attributes.not_country_code_regex

string

Optional

attributes.state_code_regex

string

Optional

attributes.not_state_code_regex

string

Optional

attributes.zip_code_regex

string

Optional

attributes.not_zip_code_regex

string

Optional

attributes.reference

string

Optional

attributes.reference_origin

string

Optional

attributes.metadata

object

Optional

Example

The following request creates a new shipping zone:

curl -g -X POST \
  'https://yourdomain.commercelayer.io/api/shipping_zones' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "shipping_zones",
    "attributes": {
      "name": "Europe (main countries)"
    }
  }
}'

Last updated