v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Shipping::Zone

List Zones

List zones for a location group

get/shipping/location_groups/{location_group_id}/zones

Path parameters

location_group_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

idinteger

Zone ID

public_idstring nullable

Zone public ID

location_group_idinteger

Location group ID

namestring

Name

address_filter_idstring nullable

Zone

{"stackTrail":"components:schemas:ShippingZoneAttributes:properties:region_ids","oasType":"schema","type":"unknown","description":"Region IDs"}

{"stackTrail":"components:schemas:ShippingZoneAttributes:properties:country_ids","oasType":"schema","type":"unknown","description":"Country IDs"}

includes_rest_of_worldboolean nullable

Includes Rest of the World

created_atstring date-time nullable

Added

updated_atstring nullable

Updated

Example response

[
  {
    "id": 2,
    "public_id": "iYwKFa",
    "location_group_id": 3,
    "name": "Example Shipping Zone",
    "address_filter_id": null,
    "region_ids": [],
    "country_ids": [],
    "includes_rest_of_world": false,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": null
  }
]