--- title: "Get catalog locations" description: > Retrieve a list of company locations from a specified company location catalog. This endpoint is scheduled for deprecation on November 1, 2024. Please migrate to the [new interface](https://developer.shopline.com/docs/admin-rest-api/product/catalog/get-catalog-locations-recommended.md). doc_type: openapi doc_category: openapi doc_version: v20270301 source_url: html: 'https://developer.shopline.com/docs/admin-rest-api/product/catalog/get-catalog-locations' md: 'https://developer.shopline.com/docs/admin-rest-api/product/catalog/get-catalog-locations.md' --- # Get catalog locations Retrieve a list of company locations from a specified company location catalog. This endpoint is scheduled for deprecation on November 1, 2024. Please migrate to the [new interface](https://developer.shopline.com/docs/admin-rest-api/product/catalog/get-catalog-locations-recommended.md). - **Base URL:** `https://{handle}.myshopline.com/admin/openapi` - **Required Scopes:** `read_products` - **API Version:** v20270301 - **API Type:** Admin - **API Protocol:** RESTful ## Endpoint ```http GET /company_location_catalog/locations.json ``` ## Base URL * `https://{handle}.myshopline.com/admin/openapi` * `{handle}`: `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` . ## Required Permissions * `read_products` ## Request ### Query Parameters * `catalog_ids` string (optional) Company location catalog IDs: up to 10 can be provided, separated by commas.Locations should be sorted in descending order by binding time.Invalid company location catalog IDs will not be blocked. ### Request Headers * `Content-Type` string (required) The field must be set to the fixed value `application/json; charset=utf-8`. * `Authorization` string (required) The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ## Response ### Status Codes * `200` For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en). * `401` * `429` ### Response Headers * `traceId` A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise. ### Response Body #### 200 * `catalog_locations` array List of returned company locations under the company location catalog. * `catalog_id` string The ID of company location catalog. * `company_location_ids` array The location ID of company location catalog. * `company_locations_count` integer Total number of company location in the catalog #### 401 * `errors` string Error message. #### 429 * `errors` string Error message. ## OpenAPI Definition ```json { "description": "Retrieve a list of company locations from a specified company location catalog. This endpoint is scheduled for deprecation on November 1, 2024. Please migrate to the [new interface](https://developer.shopline.com/docs/admin-rest-api/product/catalog/get-catalog-locations-recommended.md). ", "externalDocs": { "description": "Permission point used by the interface is `read_products` , For more information about the use of permission points, see", "url": "ec20/3cv5d7wpfgr6a8z5/xabczf5442284vkq?lang=en", "errorTableDescription": "" }, "operationId": "g8vKUPBx", "parameters": [ { "name": "catalog_ids", "in": "query", "description": "Company location catalog IDs: up to 10 can be provided, separated by commas.Locations should be sorted in descending order by binding time.Invalid company location catalog IDs will not be blocked.", "style": "form", "explode": true, "schema": { "name": "catalog_ids", "description": "Company location catalog IDs: up to 10 can be provided, separated by commas.Locations should be sorted in descending order by binding time.Invalid company location catalog IDs will not be blocked.", "type": "string", "example": "6598087148213149672" }, "example": "6598087148213149672" }, { "name": "Content-Type", "in": "header", "description": "The field must be set to the fixed value `application/json; charset=utf-8`.", "required": true, "style": "string", "schema": { "name": "Content-Type", "type": "string", "example": "application/json; charset=utf-8" } }, { "name": "Authorization", "in": "header", "description": " The access token for the API resource. Refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then pass the obtained token in the Bearer format. ", "required": true, "style": "string", "schema": { "name": "Authorization", "description": " The access token for the API. Please refer to [App authorization](https://developer.shopline.com/docs/apps/api-instructions-for-use/app-authorization.md?lang=en) to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.", "type": "string", "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" }, "example": "Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA" } ], "responses": { "200": { "description": "For the complete list of codes and messages, see [Http status code](https://developer.shopline.com/docs/apps/api-instructions-for-use/http-status-code.md?lang=en).", "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "catalog_locations": { "name": "catalog_locations", "description": "List of returned company locations under the company location catalog.", "type": "array", "items": { "name": "catalog_locations", "description": "List of returned company locations under the company location catalog.", "type": "object", "properties": { "catalog_id": { "name": "catalog_id", "description": "The ID of company location catalog.", "type": "string", "example": "6598087148213149672" }, "company_location_ids": { "name": "company_location_ids", "description": "The location ID of company location catalog.", "type": "array", "items": { "name": "company_location_ids", "description": "The location ID of company location catalog.", "type": "string", "example": "6598085940706559169" }, "example": [ "6598085940706559169" ] }, "company_locations_count": { "name": "company_locations_count", "description": "Total number of company location in the catalog", "type": "integer", "example": 1 } }, "example": { "catalog_id": "6598087148213149672", "company_location_ids": [ "6598085940706559169" ], "company_locations_count": 1 } }, "example": [ { "company_locations_count": 1, "catalog_id": "6598087148213149672", "company_location_ids": [ "6598085940706559169" ] } ] } }, "example": { "catalog_locations": [ { "company_location_ids": [ "6598085940706559169" ], "company_locations_count": 1, "catalog_id": "6598087148213149672" } ] } } } } }, "401": { "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } }, "429": { "headers": { "traceId": { "description": "A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Error message. ", "type": "string" } }, "required": [ "errors" ] } } } } }, "security": [ { "oauth2": [] } ], "method": "get", "path": "/company_location_catalog/locations.json", "servers": [ { "url": "https://{handle}.myshopline.com/admin/openapi", "variables": { "handle": { "default": "openapiceshidianpu", "description": "`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` ." } } } ], "info": { "title": "Get catalog locations", "version": "v20270301" }, "authIndexes": [ "read_products" ] } ```