Retrieve a location

Retrieve details of a specific location, based on its ID.

Request

Path Parameters
Path Parameters

The ID of the location.

Header Parameters
Header Parameters

Example: "Bearer sk_1234567890ABCdefGHIjklMNOpqrSTUvwxYZ_1234567890-Ab_cdeFGHijkLMNopq"

This parameter accepts the Merchant API Secret key to authorise requests coming from the merchant's backend.

It ensures that ensures that each request is authenticated and authorised by verifying the secret key. The secret key should be included in all request headers as a Bearer token.

info

For more information, see: Authentication

Response

OK

Response body
Body object

Unique ID representing the location where merchants sells products.

info

For more information, see: Locations.

Name of the location.

caution

The name parameter's value must be unique across all locations.

Possible values: [online, physical]

Type of the location.

ValueDescription
onlineRepresents an online store.
physicalRepresents a physical point of sale.

Additional details of the location.

Domain address of the location. Required for online locations.

caution

The domain parameter's value must be unique across all locations.

Was this page helpful?