Update a company location catalog

Requires write_products access scope.

For more info, refer to:

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

Update a company location catalog.

Path Parameters

catalog_id string required

The ID of the company location catalog.
Maximum length: 19

Example: 6598087148213149672

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 to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

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 are automatically included in the catalog.
- true: automatically included
- false: not automatically included
Default value: false
Example: true
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: 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

Specify the title of the catalog.
Maximum length：250
Example: A catalog title
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

Status Codes

For the complete list of codes and messages, see Http status code.

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.

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

catalog_id — path required

Authorization — header required

Body

Body required

{
  "auto_add_product": true,
  "currency_code": "USD",
  "status": 1,
  "title": "A catalog title",
  "adjustment_type": 1,
  "adjustment_value": 50
}

Language

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