MYmyclickfunnels
Shipping::Zone

List Zones

Changed on

List zones for a location group

get/shipping/location_groups/{location_group_id}/zones

Request

Path parameters

location_group_idstring required

Query parameters

afterstring

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

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More 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

OK

idinteger

Zone ID

public_idstring nullable

Zone public ID

location_group_idinteger

Location group ID

namestring

Name

address_filter_idstring nullable

Zone

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
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter location_group_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status