GET
View a delivery zone
Company space For: Manager, Stock keeper · Permission: order_delivery_zones.retrieve Part of Deliver orders.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

deliveryZone
string
required

Identifier of the delivery zone.

Response

200 - application/json

OrderDeliveryZoneResource

id
string
required

Identifier of the delivery zone (27-character KSUID string).

name
string
required

Name of the zone, unique inside the company.

fee
number
required

Delivery fee of the zone in major units of the company currency (stored in minor units).

is_active
boolean
required

Whether the zone can be chosen for new deliveries. Defaults to true at creation.

created_at
string<date-time>
required

Date and time the record was created (ISO 8601, UTC).

updated_at
string<date-time>
required

Date and time the record was last changed (ISO 8601, UTC).