Get location

🔒
Requires read_shop_navigation access scope. More access scope

Retrieve detailed information about a specific location by its ID.

This API is especially useful for:

Request Parameters

📘
Public Request Parameters

Parameter	Type	Required	Description	Example
`location_id`	string	Yes	Unique identifier of the location	`"loc_123"`

📘
Public Response Parameters

Parameter	Type	Example	Description
`code`	`string`	`"success"`	Status code of the response
`message`	`string`		Descriptive message of the response
`data.location.id`	string	`"loc_123"`	Unique location identifier
`data.location.active`	boolean	`true`	Whether the location is active
`data.location.default`	boolean	`false`	Whether this is the default location
`data.location.country`	string	`"United States"`	Full country name
`data.location.country_code`	string	`"US"`	ISO country code
`data.location.province`	string	`"California"`	State/province name
`data.location.province_code`	string	`"CA"`	State/province code
`data.location.city`	string	`"San Francisco"`	City name
`data.location.area`	string	`"Downtown"`	District/area name
`data.location.address`	string	`"123 Main St"`	Full address string
`data.location.address1`	string	`"Suite 100"`	Additional address line
`data.location.name`	string	`"Main Warehouse"`	Location name
`data.location.phone`	string	`"+14155551234"`	Contact phone number
`data.location.zip`	string	`"94105"`	Postal/ZIP code
`data.location.company`	string	`"Acme Inc"`	Associated company name
`data.location.latitude`	string	`"37.7749"`	GPS latitude
`data.location.longitude`	string	`"-122.4194"`	GPS longitude
`data.location.created_at`	string	`"2023-01-01T00:00:00Z"`	Creation timestamp (ISO 8601)
`data.location.updated_at`	string	`"2023-06-01T12:34:56Z"`	Last update timestamp (ISO 8601)

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