Skip to content
Products
/
/
/
SL12 - List locations

SL12 - List locations

Request

Call Frequency
Recommended usage:
- Asynchronous: once per day
- Synchronous: each time you need to create a service
Maximum usage:
- Asynchronous: every hour
- Synchronous: each time you need to create a service
Pagination

This resource supports seek pagination (see documentation)

Query
location_idArray of strings

Service Location IDs to include in result. (default: include all)

location_typestring

Service Location type to include in result. (default: include all)

Enum:"AT_CUSTOMER_LOCATION""AT_SHOP_LOCATION"
shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/mms/locations?location_id=string&location_type=AT_CUSTOMER_LOCATION&shop_id=0'

Responses

OK

Bodyapplication/json
dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response
{
  "data": [
    { … },
    { … }
  ],
  "next_page_token": "bGltaXQ9MiZhZnRlcj04N2FjNGJkMi00OGQ2LTRhZmUtYTFiZi00YTgyYjY2M2FlZDQmc29ydD1sYWJlbCxBU0M=.CFpfMq4SqojszIok6kfjG9yjnHAjku5bbfX4AXqRC3s="
}