GET
List delivery zones
Company space For: Manager, Stock keeper · Permission: order_delivery_zones.list Part of Deliver orders.

Authorizations

Authorization
string
header
required

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

Query Parameters

per_page
integer

Number of items per page.

Required range: 1 <= x <= 100
cursor
string

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string>

Field the list is sorted by.

Available options:
id,
name,
fee_minor,
is_active,
created_at,
updated_at
sort_order
enum<string>

asc for ascending order, desc for descending order.

Available options:
asc,
desc

Response

Paginated set of OrderDeliveryZoneResource

data
OrderDeliveryZoneResource · object[]
required

List of delivery zones of the page.

meta
object
required

Pagination data of the cursor page.