Zones

Zones allow defining ShippingRates for specific Locations.

Representations

Zone

Groups locations to a zone. A location can only be assigned to exactly one zone. A zone is used to define a ShippingRate for a set of locations.

ZoneDraft

ZoneDrafts are used as payloads given with Create Zone requests.

Location

A geographical location representing a country with an optional state.

Get Zone by ID

Endpoint: /{projectKey}/zones/{id}
Method: GET
OAuth2 Scopes: view_orders:{projectKey}
Response Representation: Zone

Query Zones

Endpoint: /{projectKey}/zones
Method: GET
OAuth2 Scopes: view_orders:{projectKey}
Response Representation: PagedQueryResult with the results array of Zone
Query Parameters:

Create Zone

Endpoint: /{projectKey}/zones
Method: POST
OAuth2 Scopes: manage_orders:{projectKey}
Request Representation: ZoneDraft
Response Representation: Zone

Update Zone

Endpoint: /{projectKey}/zones/{id}
Method: POST
OAuth2 Scopes: manage_orders:{projectKey}
Response Representation: Zone
Fields:

Update Actions
Please find below the individual update actions provided on this endpoint.


Change Name

Set Description

Add Location

Remove Location

Delete Zone

Endpoint: /{projectKey}/zones/{id}
Method: DELETE
OAuth2 Scopes: manage_orders:{projectKey}
Query Parameters: