🔒
Requires read_shop_navigation access scope. More access scope

The List locations API retrieves all locations for shipping, inventory, and order fulfillment.

This API is especially useful for:

Managing multiple warehouse or store locations.
Configuring shipping and fulfillment settings.
Synchronizing location data with other systems.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Query Parameters

Parameter	Type	Required	Description	Example
`cursor`	string	No	Cursor for pagination (next page).	`"abc123"`
`per_page`	int32	No	Number of items per page (default varies).	`50`
`status`	integer	No	Filter locations by status: `0`: All locations `1`: Enabled only `2`: Disabled only	`1`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`"success"`	Error code indicating request status.
`message`	string		Descriptive message about the response.
`data.locations`	array[object]	-	List of location objects.
`data.locations.id`	string	`"loc_123"`	Unique location identifier.
`data.locations.active`	boolean	`true`	Whether the location is active.
`data.locations.default`	boolean	`false`	Whether this is the default location.
`data.locations.country`	string	`"United States"`	Full country name.
`data.locations.country_code`	string	`"US"`	ISO country code.
`data.locations.province`	string	`"California"`	State/province name.
`data.locations.province_code`	string	`"CA"`	State/province code.
`data.locations.city`	string	`"San Francisco"`	City name.
`data.locations.area`	string	`"Downtown"`	District/area name.
`data.locations.address`	string	`"123 Main St"`	Full address string.
`data.locations.address1`	string	`"Suite 100"`	Additional address line.
`data.locations.name`	string	`"Main Warehouse"`	Location name.
`data.locations.phone`	string	`"+14155551234"`	Contact phone number.
`data.locations.zip`	string	`"94105"`	Postal/ZIP code.
`data.locations.company`	string	`"Acme Inc"`	Associated company name.
`data.locations.latitude`	string	`"37.7749"`	GPS latitude.
`data.locations.longitude`	string	`"-122.4194"`	GPS longitude.
`data.locations.created_at`	string	`"2023-01-01T00:00:00Z"`	Creation timestamp (ISO 8601).
`data.locations.updated_at`	string	`"2023-06-01T12:34:56Z"`	Last update timestamp (ISO 8601).
`data.total`	integer	`"150"`	Total number of locations available.
`data.cursor`	string	`"def456"`	Pagination cursor for next page.
`data.has_more`	boolean	`true`	Whether more results are available.

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message