v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Shipping::LocationGroup

List Location Groups

List location groups for a profile

get/shipping/profiles/{profile_id}/location_groups

Path parameters

profile_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

Location group ID

public_idstring nullable

Location group public ID

profile_idinteger

Profile ID

namestring

Name

{"stackTrail":"components:schemas:ShippingLocationGroupAttributes:properties:fulfillments_location_ids","oasType":"schema","type":"unknown","description":"Fulfillments Locations"}

created_atstring date-time nullable

Added

updated_atstring date-time nullable

Updated

Example response

[
  {
    "id": 1,
    "public_id": "UsrOxZ",
    "profile_id": 1,
    "name": "Example Location Group",
    "fulfillments_location_ids": [],
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]