Query location list

Requires read_location access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/locations/list.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

[]

Get all locations for a store

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

locationsobject[]
[]
Location information list
active boolean
[]
Whether the location is enabled
[]
Example: true
address1 string
[]
Detailed address 1
[]
Example: 126 York Street
address2 string
[]
Detailed address 2, optional
[]
Example: Unit 42
city string
[]
City name
[]
Example: Ottawa
country string
[]
Country Name
[]
Example: Canada
country_code string
[]
National code
[]
Example: CA
created_at string
[]
Location created time ( format see IOS8601 )
[]
Example: 2021-08-16T08:27:57+00:00
id string
[]
Location unique number
[]
Example: 5668167071852661850
is_default string
[]
Default location
legacy boolean
[]
Whether a fulfillment service location
name string
[]
Location name
[]
Example: Ottawa Store
phone string
[]
Telephone number
[]
Example: 18883290139
phone_code string
[]
Phone number international district
[]
Example: 0010
province string
[]
Province name
[]
Example: Ontario
province_code string
[]
Province code
[]
Example: 2400011
updated_at string
[]
Location update time ( format see IOS8601 )
[]
Example: 2021-08-16T08:27:57+00:00
zip string
[]
Postal code
[]
Example: A1B 2C3

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/locations/list.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal