Create a company location catalog

Requires write_products access scope.

For more info , refer to:

[]

access permission

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

[]

Create a company location catalog to configure the products and variant prices available at the company location.

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

Request Body

adjustment_type integer required
[]
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 required
[]
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.
- true: Automatically include
- false: Do not automatically include
Default value: false
[]
Example: true
company_location_ids array
[]
List of company location IDs. Invalid IDs will be filtered out.
Maximum size: 100
[]
Example: 6598085940706559169
currency_code string
[]
Product currency. When the value of this parameter is empty, store currency is used. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
[]
Example: CNY
status integer required
[]
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 required
[]
Specify the title of the catalog.
Maximum length：250
[]
Example: A catalog title

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

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

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "adjustment_type": 1,
  "adjustment_value": 50,
  "auto_add_product": true,
  "company_location_ids": [
    "6598085940706559169"
  ],
  "currency_code": "CNY",
  "status": 1,
  "title": "A catalog title"
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/company_location_catalog/create.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json' \
     --data '
{
  "adjustment_type": 1,
  "adjustment_value": 50,
  "auto_add_product": true,
  "company_location_ids": [
    "6598085940706559169"
  ],
  "currency_code": "CNY",
  "status": 1,
  "title": "A catalog title"
}
'

Was this article helpful to you?

SHOPLINE

Legal

Error loading component.