Specify variant for pricing rules
GET https://{handle}.myshopline.com/admin/openapi/v20250601/company_location_catalog/:catalog_id/:variant_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
.Specify company location catalog variant to query pricing rules.
Path Parameters
- catalog_id string requiredThe ID of company location catalog.Example:
6598087148213149672
- variant_id string requiredThe ID of the variant in the catalog.Example:
18064649853096752677070520
Request Headers
- Content-Type requiredThe value of this field is fixed to
application/json; charset=utf-8
- Authorization string requiredThe 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
- 200
- 401
- 429
For more information about status codes, see Http status code.
Response Headers
traceId
traceId
Response Body
- percent integerThe 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 integerThe type of percentage adjustment, with a value of
1
for decreasing the price and a value of2
for increasing the price.Example:1
- price stringFixed priceExample:
100
- price_adjustment_method integerThe type of price adjustment, with a value of
1
for percentage and a value of2
for fixed price (default).Example:1
quantity_price_breaksobject[]
Gradient pricing list.minimum_qty integerGradient-based minimum purchase quantity.Example:2
percent integerThe adjustment value based onpercent_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 integerThe type of percentage adjustment, with a value of1
for decreasing the price and a value of2
for increasing the price.Example:1
price stringFixed price, valid only whenprice_adjustment_method=2
.Example:100
quantity_rulesobject
Rules for purchase quantityincrement integerPurchase quantity increment where each increase must be a multiple of the increment.Example:2
maximum integerMaximum purchase quantity.Example:8
minimum integerMinimum purchase quantity.Example:2
- variant_id stringThe ID of the variant in the catalog.Example:
18064649853096752677070520
API Explorer
Debugger
Was this article helpful to you?
Error loading component.