Create PriceRule

Requires write_discounts access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/sales/price_rules.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 price rule

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

price_ruleobject
[]
Discount rules
allocation_limit integer
[]
When you buy X and get Y, you can accumulatively allocate the limit of discounts in the shopping cart if you meet the conditions. For example: if you buy 1 X and get 1 Y discount, set allocation_limit=2, when there are 3 X products in the shopping cart, When there are 3 Y items, only 2 Y items can be obtained
[]
Example: 2
allocation_method string
[]
The distribution method of the price rule, the acceptable values are ● each The discount is applied to each participating product. For example, for a $15 off price rule, each eligible item will be $15 off at checkout, for a total of $15 multiplied by the number of items. ● The discount amount calculated across will be applied to the entire eligible listing. For example, for a $15 off price rule, the discount will be spread across each participating item, for a total of $15 off. When the target_type value is shipping_line, allocation_method must be each. The default is across
[]
Example: across
ends_at string
[]
Price Rule end time
[]
Example: 2023-08-10T11:00:00+08:00
entitled_collection_ids array
[]
Specify an array of category ids ● If target_selection is entitled, one of the three options entitled_product_ids, entitled_collection_ids, and entitled_variant_ids must have a value ● The three fields entitled_product_ids, entitled_collection_ids, and entitled_variant_ids are mutually exclusive, and only one field can have a value
[]
Example: 12259764246208273857373144
entitled_country_ids array
[]
Array of country/region ID, temporarily useless
[]
Example: "HK","TW","SG"
entitled_product_ids array
[]
Specify Product id number group ●If target_selection is entitled , then entitled_product_ids、entitled_collection_ids ,Entitled_variant_ids three choices one must have value ●Entitled_product_ids、entitled_collection_ids , entitled_variant_ids three-field mutually exclusive , only one field is worth it . when buying x-y , it means a y Product id list
[]
Example: 16059766321245219059003144
entitled_variant_idsobject[]
[]
Designated style array ● If target_selection is entitled, one of entitled_product_ids, entitled_collection_ids, and entitled_variant_ids must have a value ● The three fields entitled_product_ids, entitled_collection_ids, and entitled_variant_ids are mutually exclusive, and only one field can have a value ● When you buy X and get Y, it means Y product Style list
product_id string
[]
Product ID
[]
Example: 16059766321245219059003144
variant_id string
[]
variant id
[]
Example: 18059766321249077818743144
joint_discount boolean
[]
Whether to superimpose automatic discounts? The default value is false.
joint_discount_order boolean
[]
Superimposed discounts - automatic discounts - order discounts
[]
Example: true
joint_discount_product boolean
[]
Superimposed discounts-automatic discounts-commodity discounts
[]
Example: true
joint_discount_shipping boolean
[]
Overlay Offer - Automatic Offer - Shipping Discount
[]
Example: true
overlay_discount_code boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to stack discounts
[]
Example: true
overlay_discount_code_order boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to be used in superimposed discounts. order discount
[]
Example: true
overlay_discount_code_product boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to be used in superimposed discounts. Product discount
[]
Example: true
overlay_discount_code_shipping boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to be used in superimposed discounts. shipping discount
[]
Example: true
prerequisite_collection_ids array
[]
When buying X to get Y, the category Id list of X product cannot be used at the same time with prerequisite_product_ids and prerequisite_variant_ids
[]
Example: 12259764246208273857373144
prerequisite_customer_ids array
[]
The premise : customers must belong to one of the search ( customer grouping ) requisite_saved_search_ids , which is saved by specify or one of the customers specify requisite_customer_ids .
[]
Example: 4216552768
prerequisite_product_ids array
[]
When buying X to get Y, when buying X to get Y, the list of X product IDs will not be used at the same time as prerequisite_collection_ids and prerequisite_variant_ids
[]
Example: 16059766321245219059003144
prerequisite_quantity_rangeobject
[]
Promotion triggers the minimum quantity of items ● prerequisite_quantity_range and prerequisite_subtotal_range are mutually exclusive ● If both are empty, it is the trigger condition for no price or quantity
greater_than_or_equal_to integer
[]
● nullable ● must be >0 ● only integers are acceptable (integer)
[]
Example: 5
prerequisite_saved_search_ids array
[]
The premise : customers must belong to one of the search ( customer grouping ) requisite_saved_search_ids , which is saved by specify or one of the customers specify requisite_customer_ids .
[]
Example: MLC5302535370462201296
prerequisite_shipping_price_rangeobject
[]
Shipping must be less than or equal to this value. * Not required, default is empty. * 1) The content can only be filled in under target_type=shipping_line * 2) The value and accuracy are consistent with the corresponding accuracy of the store currency
less_than_or_equal_to string
[]
Shipping must be less than or equal to this value. * Not required, default is empty. * 1) The content can only be filled in under target_type=shipping_line 2) The value and accuracy are consistent with the corresponding accuracy of the store currency
[]
Example: 50
prerequisite_subtotal_rangeobject
[]
Promotion triggers the minimum order amount ● prerequisite_quantity_range and prerequisite_subtotal_range are mutually exclusive ● If both are empty, it is the trigger condition for no price or quantity
greater_than_or_equal_to string
[]
● nullable ● rounded to two decimal places
[]
Example: 100
prerequisite_to_entitlement_purchaseobject
[]
When buying X to get Y, the amount threshold that X product needs to meet
prerequisite_amount string
[]
The amount threshold required by product X cannot be used with prerequisite_quantity at the same time
[]
Example: 100
prerequisite_to_entitlement_quantity_ratioobject
[]
When buying X to get Y, the quantity threshold required for X product and the quantity of Y product obtained
entitled_quantity integer
[]
The number of Y products obtained when the threshold is met once
[]
Example: 1
prerequisite_quantity integer
[]
The quantity of X goods required to meet the 1 threshold, cannot be used together with prerequisite_quantity
[]
Example: 1
prerequisite_variant_idsobject[]
[]
When buying X to get Y, the style id list of X product will not be used together with prerequisite_product_ids and prerequisite_collection_ids
product_id string
[]
Product ID
[]
Example: 16059766321245219059003144
variant_id string
[]
Variant id
[]
Example: 18059766321249077818743144
sales_channels array
[]
If the sales channel is not transmitted by default, it means that all channels are available; If a specified sales channel is uploaded, it is available only in that channel
[]
Example: shopper
starts_at string required
[]
Rule start time
[]
Example: 2023-07-10T11:00:00+08:00
target_selection string
[]
The scope of application of preferential rules, the acceptable values are ● all, defined as all products; ● entitled, defined as specified range (specified product/specified category). When this field obtains the value of entitled, one of entitled_product_ids and entitled_collection_ids must be selected. Value; when target_type=shipping_line, all must be filled. The default value is all
[]
Example: all
target_type string
[]
The target type to which the price rule applies. Valid values: line_item: The price rule to apply to the shopping line item item. shipping_line: The price rule applies to the shopping order shipping line.
[]
Example: line_itme
title string required
[]
The name of the discount rules
[]
Example: This is title of price rule
usage_limit integer
[]
Limit the total number of uses of all discount codes bound to this discount rule ● If not filled, the default value is null or empty, which means unlimited use times ● Only empty and natural numbers are acceptable; ● If the upper limit value is exceeded, it will be automatically processed as upper limit value
[]
Example: 2
usage_per_customer integer
[]
Limit the number of times each customer can use each code under the price rule ● If not filled, the default value is null or empty, which means unlimited usage ● Only empty and natural numbers are acceptable; ● Values exceeding the upper limit are automatically processed as up limit value
[]
Example: 10
value string required
[]
Discount amount or percentage , it must be filled with negative numbers ● if the value_type value is percentage , indicating the Discount percentage , rounding up the reserved whole number , such as : Discount 10 % , filling 10 ; ●If the value_type value is fixed_amount , it means the Discount amount , the unit is yuan , rounded up to retain the two decimal points , such as : Discount 10.23 yuan , fill in the required field of -10.23.
[]
Example: 20
value_type string required
[]
Offer type, acceptable values are ● percentage percentage, percentage must be filled in when target_type=shipping_line, and percentage must be filled in for buy x get y type activities; ● fixed_amount fixed amount; required field
[]
Example: percentage

Response

[]

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

Response Headers

traceId
[]
traceId

Response Body

price_ruleobject
[]
Discount rules
allocation_limit integer
[]
When you buy X and get Y, you can accumulatively allocate the limit of discounts in the shopping cart if you meet the conditions. For example: if you buy 1 X and get 1 Y discount, set allocation_limit=2, when there are 3 X products in the shopping cart, When there are 3 Y items, only 2 Y items can be obtained
[]
Example: 2
allocation_method string
[]
The distribution method of the price rule, the acceptable values are ● each The discount is applied to each participating product. For example, for a $15 off price rule, each eligible item will be $15 off at checkout, for a total of $15 multiplied by the number of items. ● The discount amount calculated across will be applied to the entire eligible listing. For example, for a $15 off price rule, the discount will be spread across each participating item, for a total of $15 off. When the target_type value is shipping_line, allocation_method must be each. The default is across
[]
Example: across
create_at string
[]
Creation time
[]
Example: 2023-07-10T11:00:00+08:00
ends_at string
[]
Price Rule end time
[]
Example: 2023-08-10T11:00:00+08:00
entitled_collection_ids array
[]
Specify an array of category ids ● If target_selection is entitled, one of the three options entitled_product_ids, entitled_collection_ids, and entitled_variant_ids must have a value ● The three fields entitled_product_ids, entitled_collection_ids, and entitled_variant_ids are mutually exclusive, and only one field can have a value
[]
Example: 12259764246208273857373144
entitled_country_ids array
[]
Array of country/region ID, temporarily useless
[]
Example: "HK","TW","SG"
entitled_product_ids array
[]
Specify product id array ● If target_selection is entitled, one of entitled_product_ids, entitled_collection_ids, and entitled_variant_ids must have a value ● The three fields entitled_product_ids, entitled_collection_ids, and entitled_variant_ids are mutually exclusive, and only one field can have a value. When you buy X and get Y, it means Y Product ID list
[]
Example: 16059766321245219059003144
entitled_variant_idsobject[]
[]
Designated style array ● If target_selection is entitled, one of entitled_product_ids, entitled_collection_ids, and entitled_variant_ids must have a value ● The three fields entitled_product_ids, entitled_collection_ids, and entitled_variant_ids are mutually exclusive, and only one field can have a value ● When you buy X and get Y, it means Y product Style list
product_id string
[]
Product ID
[]
Example: 16059766321245219059003144
variant_id string
[]
style id
[]
Example: 18059766321249077818743144
id string
[]
Discount rules id
[]
Example: 6018695669979551970
joint_discount boolean
[]
Whether to superimpose automatic discounts? The default value is false.
joint_discount_order boolean
[]
Superimposed discounts - automatic discounts - order discounts
[]
Example: true
joint_discount_product boolean
[]
Superimposed discounts-automatic discounts-commodity discounts
[]
Example: true
joint_discount_shipping boolean
[]
Overlay Offer - Automatic Offer - Shipping Discount
[]
Example: true
overlay_discount_code boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to stack discounts
[]
Example: true
overlay_discount_code_order boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to be used in superimposed discounts. order discount
[]
Example: true
overlay_discount_code_product boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to be used in superimposed discounts. Product discount
[]
Example: true
overlay_discount_code_shipping boolean
[]
Superimposed discounts-discount code discounts, allowing multiple discount code activities to be used in superimposed discounts. shipping discount
[]
Example: true
prerequisite_collection_ids array
[]
When buying X to get Y, when buying X to get Y, the list of X product IDs will not be used at the same time as prerequisite_collection_ids and prerequisite_variant_ids
[]
Example: 12259764246208273857373144
prerequisite_customer_ids array
[]
The premise : customers must belong to one of the search ( customer grouping ) requisite_saved_search_ids , which is saved by specify or one of the customers specify requisite_customer_ids .
[]
Example: 4216552768
prerequisite_product_ids array
[]
When buying X to get Y, the category Id list of X product cannot be used at the same time with prerequisite_product_ids and prerequisite_variant_ids
[]
Example: 16059766321245219059003144
prerequisite_quantity_rangeobject
[]
Promotion triggers the minimum quantity of items ● prerequisite_quantity_range and prerequisite_subtotal_range are mutually exclusive ● If both are empty, it is the trigger condition for no price or quantity
greater_than_or_equal_to integer
[]
● nullable ● must be >0 ● only integers are acceptable (integer)
[]
Example: 5
prerequisite_saved_search_ids array
[]
The premise : customers must belong to one of the search ( customer grouping ) requisite_saved_search_ids , which is saved by specify or one of the customers specify requisite_customer_ids .
[]
Example: MLC5302535370462201296
prerequisite_shipping_price_rangeobject
[]
Shipping must be less than or equal to this value. * Not required, default is empty. * 1) The content can only be filled in under target_type=shipping_line * 2) The value and accuracy are consistent with the corresponding accuracy of the store currency
less_than_or_equal_to string
[]
Shipping must be less than or equal to this value. * Not required, default is empty. * 1) The content can only be filled in under target_type=shipping_line 2) The value and accuracy are consistent with the corresponding accuracy of the store currency
[]
Example: 50
prerequisite_subtotal_rangeobject
[]
Promotion triggers the minimum order amount ● prerequisite_quantity_range and prerequisite_subtotal_range are mutually exclusive ● If both are empty, it is the trigger condition for no price or quantity
greater_than_or_equal_to string
[]
● nullable ● rounded to two decimal places
[]
Example: 100
prerequisite_to_entitlement_purchaseobject
[]
When buying X to get Y, the amount threshold that X product needs to meet
prerequisite_amount string
[]
The amount threshold required by product X cannot be used with prerequisite_quantity at the same time
[]
Example: 100
prerequisite_to_entitlement_quantity_ratioobject
[]
When buying X to get Y, the quantity threshold required for X product and the quantity of Y product obtained
entitled_quantity integer
[]
The number of Y products obtained when the threshold is met once
[]
Example: 1
prerequisite_quantity integer
[]
The quantity of X goods required to meet the 1 threshold, cannot be used together with prerequisite_quantity
[]
Example: 1
prerequisite_variant_idsobject[]
[]
When buying X to get Y, the style id list of X product will not be used together with prerequisite_product_ids and prerequisite_collection_ids
product_id string
[]
Product ID
[]
Example: 16059766321245219059003144
variant_id string
[]
style id
[]
Example: 18059766321249077818743144
sales_channels array
[]
If the sales channel is not transmitted by default, it means that all channels are available; If a specified sales channel is uploaded, it is available only in that channel
[]
Example: web
starts_at string
[]
Rule start time
[]
Example: 2023-07-10T11:00:00+08:00
target_selection string
[]
Discount rule application range , acceptable value has ● all , defined as all Product ●Entitled , defined as the specify range ( specify Product / specify classification ) when this field is obtained for entitled , the two choices of entitled_product_ids and entitled_collection_ids must be worthwhile ;● explicit , defined as a single Product , when target_type=shipping_line , you must fill in explicit. default value as all
[]
Example: all
target_type string
[]
The target type to which the price rule applies. Valid values: line_item: The price rule to apply to the shopping line item item. shipping_line: The price rule applies to the shopping order shipping line.
[]
Example: line_itme
title string
[]
Discount rule id name
[]
Example: This is title of price rule
update_at string
[]
Update time
[]
Example: 2023-07-10T11:00:00+08:00
usage_limit integer
[]
Limit the total number of uses of all discount codes bound to this discount rule ● If not filled, the default value is null or empty, which means unlimited use times ● Only empty and natural numbers are acceptable; ● If the upper limit value is exceeded, it will be automatically processed as upper limit value
[]
Example: 2
usage_per_customer integer
[]
Limit the number of times a single customer can use each coupon code bound to the discount rule ● If not filled, the default value is null or empty, which means unlimited use times ● Only empty and natural numbers are acceptable; ● If the upper limit value is exceeded, it will be automatically processed as the upper limit value
[]
Example: 10
value string
[]
Discount amount / percentage ● if the value_type value is percentage ; rounded , reserved whole number ● if the value_type value is fixed_amount ; rounded , reserved for two decimal points
[]
Example: 20
value_type string
[]
Type of discount, Acceptable values are ● percentage ● fixed_amount
[]
Example: percentage

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "price_rule": {
    "allocation_limit": 2,
    "allocation_method": "across",
    "ends_at": "2023-08-10T11:00:00+08:00",
    "entitled_collection_ids": [
      "12259764246208273857373144"
    ],
    "entitled_country_ids": [
      "\"HK\",\"TW\",\"SG\""
    ],
    "entitled_product_ids": [
      "16059766321245219059003144"
    ],
    "entitled_variant_ids": [
      {
        "product_id": "16059766321245219059003144",
        "variant_id": "18059766321249077818743144"
      }
    ],
    "joint_discount": false,
    "joint_discount_order": true,
    "joint_discount_product": true,
    "joint_discount_shipping": true,
    "overlay_discount_code": true,
    "overlay_discount_code_order": true,
    "overlay_discount_code_product": true,
    "overlay_discount_code_shipping": true,
    "prerequisite_collection_ids": [
      "12259764246208273857373144"
    ],
    "prerequisite_customer_ids": [
      "4216552768"
    ],
    "prerequisite_product_ids": [
      "16059766321245219059003144"
    ],
    "prerequisite_quantity_range": {
      "greater_than_or_equal_to": 5
    },
    "prerequisite_saved_search_ids": [
      "MLC5302535370462201296"
    ],
    "prerequisite_shipping_price_range": {
      "less_than_or_equal_to": "50"
    },
    "prerequisite_subtotal_range": {
      "greater_than_or_equal_to": "100"
    },
    "prerequisite_to_entitlement_purchase": {
      "prerequisite_amount": "100"
    },
    "prerequisite_to_entitlement_quantity_ratio": {
      "entitled_quantity": 1,
      "prerequisite_quantity": 1
    },
    "prerequisite_variant_ids": [
      {
        "product_id": "16059766321245219059003144",
        "variant_id": "18059766321249077818743144"
      }
    ],
    "sales_channels": [
      "shopper"
    ],
    "starts_at": "2023-07-10T11:00:00+08:00",
    "target_selection": "all",
    "target_type": "line_itme",
    "title": "This is title of price rule",
    "usage_limit": 2,
    "usage_per_customer": 10,
    "value": "20",
    "value_type": "percentage"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/sales/price_rules.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