Separate pricing for catalog variants

Requires write_products access scope.

For more info, refer to:

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

Batch removal of variant prices across multiple company location catalogs. Batch modification of tiered prices for variants across multiple company location catalogs, overwriting and updating them.

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

catalog_id string required

The ID of company location catalog.
Example: 6598087148213149672
prices_to_delete_by_variant_ids array

Identify the list of variants for which price rules and quantity rules need to be deleted. If both the deletion list and the addition list are provided simultaneously, the price of the variant will be cleared. A maximum of 500 variants can be processed.Invalid IDs will be filtered out.
Example: ["18064429954848899821950520"]
product_id string required

The ID of the product in the catalog.
Example: 16064429954842188935480520
variant_pricesobject[]

Variant pricing list, limited to a maximum of 500 variants.
quantity_rulesobject required

Rules for purchase quantity
increment integer required

Purchase quantity increment where each increase must be a multiple of the increment.
Example: 2
maximum integer

Maximum purchase quantity.
Example: 8
minimum integer required

Minimum purchase quantity.
Example: 2
variant_id string required

The ID of the variant in the catalog.
Example: 18064429954848899821990520
percent integer

The adjustment value based on percent_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
percent_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
price string

Fixed price
Example: 100
price_adjustment_method integer required

The type of price adjustment, with a value of 1 for percentage and a value of 2 for fixed price.
Example: 1
quantity_price_breaksobject[]

Gradient pricing list.
percent integer

The adjustment value based on percent_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
percent_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
price string

Fixed price, valid only when price_adjustment_method=2.
Example: 100
minimum_qty integer

Gradient-based minimum purchase quantity.
Example: 2

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

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "variant_prices": [
    {
      "price": "100",
      "price_adjustment_method": 1,
      "quantity_price_breaks": [
        {
          "minimum_qty": 2,
          "percent": 50,
          "percent_type": 1,
          "price": "100"
        }
      ],
      "quantity_rules": {
        "maximum": 8,
        "minimum": 2,
        "increment": 2
      },
      "variant_id": "18064429954848899821990520",
      "percent": 50,
      "percent_type": 1
    }
  ],
  "catalog_id": "6598087148213149672",
  "prices_to_delete_by_variant_ids": [
    "18064429954848899821950520"
  ],
  "product_id": "16064429954842188935480520"
}

Language

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