Locations collection
Get all sales locations, the starting_after have to be set to location_id scopes:
- admin:locations
- read:locations
Authorizations
Path Parameters
An id that uniquely identifies the account.
9Query Parameters
A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.
1 <= x <= 100cursor for use in pagination. starting_after is an object ID
that defines your place in the list. For instance, if you make
a list request and receive 100 objects, end the result contains
paging_token=pt1, your subsequent call can include
starting_after=pt1 in order to fetch the next page of the list.
lookup locations where search term match name, phone_number, email, organization_number and business_name
filter locations by status
filter locations by country
filter locations by phone_number
filter locations by organization_number
filter locations by email
filter locations by type
Response
SalesLocation collection
9An UUID that uniquely identifies the resource
The date-time when the resource was created
The ID of the user/client created the resource
"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"
The date-time when the resource was last updated
The ID of the user/client created the resource
"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"
The id you have defined for the sales location. (must not have trailing or leading spaces). An auto-generated location_id will be created if no location_id is provided
255"S01923"
The location's trade name which is shown to its customers (receipt/signs)
"TKP Store"
The location's timezone (IANA Timezone)
"Europe/Oslo"
The location's status
"Active"
The three-character ISO-4217 currency. https://en.wikipedia.org/wiki/ISO_4217
"NOK"
A phone number in E.164 number formatting.
"+4799999999"
"SuperChain"
"saleslocation@example.com"
A four-digit Merchant Category Code (MCC) for the store ISO 18245:2003
"5814"
Company Global Location Number
Company identification number
"123456789MVA"
The location's legal name
"TKP technology AS"
The location is part of a franchise.
"Subway"
The location type (Physical, Mobile)
The location's website