Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
locations

aid_locations_get

Get all sales locations, the starting_after have to be set to location_id scopes:

  • admin:locations
  • read:locations
get/accounts/{aid}/locations

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Query parameters

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.

starting_afterstring

cursor 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.

searchstring

lookup locations where search term match name, phone_number, email, organization_number and business_name

statusstring[]

filter locations by status

countrystring[]

filter locations by country

phone_numberstring[]

filter locations by phone_number

organization_numberstring[]

filter locations by organization_number

emailstring[]

filter locations by email

typestring[]

filter locations by type

Response

SalesLocation collection

account_idstring ^[PT]{1}\d{8}$
idstring required
organization_numberstring
namestring

name of the store, aka trade name of the store

business_namestring

Official name of the person or entity that owns the store.

Example response

[
  {
    "id": "SL02",
    "organization_number": "123456789MVA",
    "name": "SC Oslo",
    "business_name": "SC Oslo AS"
  }
]