Retrieve a list of company location catalogs

Requires read_product_listings access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250301/company_location_catalogs.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 a list of company location catalogs in the store.

Query Parameters

limit integer
[]
Limit the number of queries. The default value is 10 and the value cannot exceed 50.
[]
Example: 10
page_info string
[]
The caller does not need to use and care about this field, which is automatically encapsulated by SHOPLINE.
[]
Example: eyJzaW5jZUlkIjoiMTYwNTc4NTY3NjcxMTc3MDcyNTEwNjAyODIiLCJkaXJlY3Rpb24iOiJuZXh0In0=
title string
[]
Specify the title keywords for retrieving the catalog, using prefix fuzzy matching.
[]
Example: A catalog title

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
[]
Pagination links set in the response header, formatted as: \n<https://admin.myshopline.com?pageInfo=xxx&limit=10>; rel=\"next\", <https://admin.myshopline.com?pageInfo=xxx&limit=10>; rel=\"previous\".
traceId
[]
traceId

Response Body

catalogsobject[]
[]
List of returned company location catalogs.
adjustment_type integer
[]
The type of percentage adjustment, with a value of 1 for decreasing the price and a value of 2 for increasing the price.
[]
Example: 1
adjustment_value integer
[]
The adjustment value based on adjustment_type, formatted as a percentage.

When decreasing the price, the value is limited to 0-100.

When increasing the price, the value is limited to 0-10,000.

[]
Example: 50
auto_add_product boolean
[]
Whether newly added products should automatically be included in the catalog. Defaults to false if not specified.
[]
Example: true
catalog_id string
[]
The ID of company location catalog.
[]
Example: 6598087148213149672
created_at string
[]
The creation date and time of the company location catalog.
[]
Example: 2024-08-14T00:17:55+08:00
currency_code string
[]
Currency code
[]
Example: USD
status integer
[]
The status of the specified catalog, with a value of 1 representing active status and a value of 2 representing draft status.
[]
Example: 1
title string
[]
The title of company location catalog.
[]
Example: A catalog title

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

limit — query

page_info — query

title — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250301/company_location_catalogs.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

Error loading component.