Get catalog locations (recommended)

Requires read_products access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/company_location_catalog/:catalog_id/locations.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 .

[]

Retrieve the list of company locations under the company location catalog.

Path Parameters

catalog_id string required
[]
The ID of the company location catalog.
Maximum length: 19
[]
Example: 6598087148213149672

Query Parameters

limit integer
[]
The maximum number of queried company locations.
Default value: 10
Value range: 1-50
[]
Example: 10
page_info string
[]
The unique identifier for pagination queries, used to locate a specific page. This parameter value is obtained from the link value in the response header of this API after you have queried the pagination information. For example, if the link value you obtained is <https://\{handle\}.myshopline.com/admin/openapi/\{version\}/products/products.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next", then the value of page_info is eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9.
Refer to the Paging Mechanism for details about pagination.

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

link
[]
The URL link that provides the pagination data. For example, you can obtain page_info from this parameter value for use in the next pagination request.
This parameter is returned when the requested page has a previous or next page available.
For more information on how to use pagination, refer to Paging Mechanism.
traceId
[]
traceId

Response Body

company_location_ids array
[]
List of requested company location IDs.
Maximum size: 50
Maximum length per string：19
[]
Example: 6598085940706559169
company_locations_count integer
[]
Total number of company locations in the catalog.
[]
Example: 2

API Explorer

Debugger

Base URL

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

ParamOptions

catalog_id — path required

Authorization — header required

limit — query

page_info — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/company_location_catalog/catalog_id/locations.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