Shipping Zones

Manage shipping zones

Retrieving shipping zones

get

Retrieves shipping zones for the specified site.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

: Needed to manage shipping settings.
: Needed to read shipping settings.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Query parameters

activeMethodsstringOptional

If set to true, only active methods are included.
If set to false, only inactive methods are included.
If not specified, all expanded shipping methods are included.

expandstringOptional

methods: To return zones with expanded shipping methods.
fees: To expand the configured fees for those shipping methods.

Example: methods,fees

Header parameters

Accept-LanguagestringOptional

The Accept-Language request HTTP header defines which languages the client is able to understand, and which locale variant is preferred. It can be a priority list working as a fallback mechanism. If the Accept-Language header is empty, all languages for localized fields are returned in a map format where the key is language code and the value is a translation.

Example: fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7

Responses

200

Resource successfully retrieved.

application/json

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

500

Some server side error occurred.

application/json

get

/shipping/{tenant}/{site}/zones

GET /shipping/{tenant}/{site}/zones HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "zone1",
    "name": "Zone 1",
    "shipTo": [
      {
        "country": "DE",
        "postalCode": "70190"
      }
    ],
    "default": true
  },
  {
    "id": "zone2",
    "name": "Zone 2",
    "shipTo": [
      {
        "country": "DE",
        "postalCode": "70192"
      }
    ],
    "default": false
  }
]

Creating a shipping zone

post

Creates a new shipping zone for the specified site.

Required scopes

This endpoint requires the following scopes:

: Needed to manage shipping settings.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Header parameters

Content-LanguagestringOptional

The Content-Language request HTTP header defines language of the payload. When the Content-Language header is empty, all localized fields in a payload should be in a map format, where the key is a language code and the value is a translation.

Example: fr

Body

The zone is an area where shipments can be delivered.

idstringRequired

Delivery zone's unique identifier.

defaultbooleanOptional

Flag indicating whether the zone is the default delivery zone for the site.

nameone ofRequired

stringOptional

String value in the specified language.

Example: FedEx 2Day

Responses

201

Resource successfully created.

application/json

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

404

The requested resource does not exist.

application/json

409

Creation failed because there was a conflict with another resource. Details of the error are included in the response payload.

application/json

500

Some server side error occurred.

application/json

post

/shipping/{tenant}/{site}/zones

POST /shipping/{tenant}/{site}/zones HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "shipTo": [
    {
      "country": "DE",
      "postalCode": "70190"
    }
  ],
  "name": "Zone 1",
  "id": "zone1",
  "default": true
}

{
  "id": "zone1"
}

Retrieving a shipping zone

get

Retrieves the specified shipping zone's details.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

: Needed to manage shipping settings.
: Needed to read shipping settings.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

zoneIdstringRequired

Shipping zone's unique identifier.

Query parameters

activeMethodsstringOptional

If set to true, only active methods are included.
If set to false, only inactive methods are included.
If not specified, all expanded shipping methods are included.

expandstringOptional

methods: To return zones with expanded shipping methods.
fees: To expand the configured fees for those shipping methods.

Example: methods,fees

Header parameters

Accept-LanguagestringOptional

Example: fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7

Responses

200

Resource successfully retrieved.

application/json

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

get

/shipping/{tenant}/{site}/zones/{zoneId}

GET /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "zone1",
  "name": "Zone 1",
  "shipTo": [
    {
      "country": "DE",
      "postalCode": "70190"
    }
  ],
  "default": true
}

Updating a shipping zone

put

Fully updates the specified shipping zone.

Required scopes

This endpoint requires the following scopes:

: Needed to manage shipping settings.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

zoneIdstringRequired

Shipping zone's unique identifier.

Header parameters

Content-LanguagestringOptional

Example: fr

Body

The zone is an area where shipments can be delivered.

idstringRequired

Delivery zone's unique identifier.

defaultbooleanOptional

Flag indicating whether the zone is the default delivery zone for the site.

nameone ofRequired

stringOptional

String value in the specified language.

Example: FedEx 2Day

Responses

200

Resource successfully updated.

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

put

/shipping/{tenant}/{site}/zones/{zoneId}

PUT /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "shipTo": [
    {
      "country": "DE",
      "postalCode": "70190"
    }
  ],
  "name": "Zone 1",
  "id": "zone1",
  "default": true
}

No content

Deleting a shipping zone

delete

Deletes the specified shipping zone.

Required scopes

This endpoint requires the following scopes:

: Needed to manage shipping settings.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

zoneIdstringRequired

Shipping zone's unique identifier.

Responses

204

Resource successfully deleted.

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

delete

/shipping/{tenant}/{site}/zones/{zoneId}

DELETE /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially updating a shipping zone

patch

Partially updates the specified shipping zone.

Required scopes

This endpoint requires the following scopes:

: Needed to manage shipping settings.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

zoneIdstringRequired

Shipping zone's unique identifier.

Header parameters

Content-LanguagestringOptional

Example: fr

Body

The zone is an area where shipments can be delivered.

idstringRequired

Delivery zone's unique identifier.

defaultbooleanOptional

Flag indicating whether the zone is the default delivery zone for the site.

nameone ofRequired

stringOptional

String value in the specified language.

Example: FedEx 2Day

Responses

200

Resource successfully updated.

400

Request syntactically incorrect. Details of the error are included in the response payload.

application/json

401

Unauthorized

application/json

403

Given authorization scopes are not sufficient and do not match required scopes.

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

patch

/shipping/{tenant}/{site}/zones/{zoneId}

PATCH /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "shipTo": [
    {
      "country": "DE",
      "postalCode": "70190"
    }
  ],
  "name": "Zone 1",
  "id": "zone1",
  "default": true
}

No content

PreviousShipping Methods NextShipping Groups

Last updated 8 days ago

Was this helpful?

Good evening

Retrieving shipping zones

Creating a shipping zone

Retrieving a shipping zone

Updating a shipping zone

Deleting a shipping zone

Partially updating a shipping zone