Create price rule

POST 
/openapi/2025-06/price_rules

Creates a new price rule for discounts or promotions on the store.

Request

application/json

Body

Bodyrequired

price_rule object
Price rule
titlestringrequired
Title of this price rule
valuefloatrequired
Value for this discount
value_typestringrequired
Discount type. Options: fixed_amount for a fixed discount, or percentage for a percentage discount
usage_limitint32
The usage limit. -1 means no limit
allocation_limitint32
Redeem count limit for checkout: 0~999, 0 means only one redeem allowed, 999 means no limit
once_per_customerint32
Maximum usage per customer. -1 or 0 means no limit
prerequisiteint32
Indicates if this discount has prerequisites. 1 means yes, 0 means no
target_selectionstringrequired
Target products allowed for this discount. Options: all for all products, entitled for specific products
target_typestring
Target type of this discount
starts_atstringrequired
Start time of the discount. Format: YYYY-MM-DDTHH:mm:ssZ
ends_atstringrequired
End time of the discount. Format: YYYY-MM-DDTHH:mm:ssZ
entitled_product_idsstring[]
Specifies the product IDs allowed for the price rule. Required only when target_selection is entitled
entitled_variant_idsstring[]
Specifies the product variant IDs allowed for the price rule
entitled_collection_idsstring[]
Specify the collections allowed of the discount
prerequisite_subtotal_range object[]
Prerequisite for the total amount of the money
Array [
greater_than_or_equal_tostring
To specify the value which the price has to greater than or equal to
valuestring
The value
value_percentagestring
Percentage value
value_event_typestring
Value event type
value_conditionstring
Value condition
target_typestring
Target type
target_datastring[]
Target data
]
prerequisite_quantity_range object[]
Prerequisite for the total count of the products
Array [
greater_than_or_equal_tostring
To specify the value which the price has to greater than or equal to
valuestring
The value
value_percentagestring
Percentage value
value_event_typestring
Value event type
value_conditionstring
Value condition
target_typestring
Target type
target_datastring[]
Target data
]

Example

{
  "price_rule": {
    "title": "string",
    "value": 0,
    "value_type": "string",
    "usage_limit": 0,
    "allocation_limit": 0,
    "once_per_customer": 0,
    "prerequisite": 0,
    "target_selection": "string",
    "target_type": "string",
    "starts_at": "string",
    "ends_at": "string",
    "entitled_product_ids": [
      "string"
    ],
    "entitled_variant_ids": [
      "string"
    ],
    "entitled_collection_ids": [
      "string"
    ],
    "prerequisite_subtotal_range": [
      {
        "greater_than_or_equal_to": "string",
        "value": "string",
        "value_percentage": "string",
        "value_event_type": "string",
        "value_condition": "string",
        "target_type": "string",
        "target_data": [
          "string"
        ]
      }
    ],
    "prerequisite_quantity_range": [
      {
        "greater_than_or_equal_to": "string",
        "value": "string",
        "value_percentage": "string",
        "value_event_type": "string",
        "value_condition": "string",
        "target_type": "string",
        "target_data": [
          "string"
        ]
      }
    ]
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object
price_rule object
Price rule
idstring
Price rule ID
titlestring
Title
valuefloat
The value
value_typestring
Value type
usage_limitint32
Usage limit. -1 means unlimited
times_usedint32
Number of times used
allocation_methodstring
Allocation method
allocation_limitint32
Allocation limit
allocation_limit_amountfloat
Allocation limit amount
once_per_customerint32
Whether usable once per customer
prerequisiteint32
Prerequisite condition
customer_selectionstring
Customer selection criteria
target_selectionstring
Target selection
target_typestring
Target type
target_price_typestring
Target price type
created_atstring
Creation timestamp, in ISO-8601 format
updated_atstring
Last update timestamp, in ISO-8601 format
starts_atstring
Start timestamp
ends_atstring
End timestamp
prerequisite_customer_idsstring[]
List of prerequisite customer IDs
prerequisite_customer_segment_idsstring[]
Customer segment prerequisite IDs
entitled_product_idsstring[]
Entitled product IDs
entitled_variant_idsstring[]
Entitled variant IDs
entitled_filter_idsstring[]
Entitled filter IDs
entitled_filter_liststring[]
List of entitled filters
variant_product_idsstring[]
Product IDs of variants
entitled_collection_idsstring[]
Entitled collection IDs
entitled_area_list object[]
List of entitled areas
Array [
country_codestring
Country code (e.g., CN)
province_codesstring[]
List of province codes
]
prerequisite_subtotal_range object[]
Subtotal prerequisite range
Array [
greater_than_or_equal_tostring
Greater than or equal to value
valuestring
The value
value_percentagestring
Percentage value
value_event_typestring
Value event type
value_conditionstring
Value condition
target_typestring
Target type
target_datastring[]
Target data
]
prerequisite_quantity_range object[]
Quantity prerequisite range
Array [
greater_than_or_equal_tostring
Greater than or equal to value
valuestring
The value
value_percentagestring
Percentage value
value_event_typestring
Value event type
value_conditionstring
Value condition
target_typestring
Target type
target_datastring[]
Target data
]

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "price_rule": {
      "id": "string",
      "title": "string",
      "value": 0,
      "value_type": "string",
      "usage_limit": 0,
      "times_used": 0,
      "allocation_method": "string",
      "allocation_limit": 0,
      "allocation_limit_amount": 0,
      "once_per_customer": 0,
      "prerequisite": 0,
      "customer_selection": "string",
      "target_selection": "string",
      "target_type": "string",
      "target_price_type": "string",
      "created_at": "string",
      "updated_at": "string",
      "starts_at": "string",
      "ends_at": "string",
      "prerequisite_customer_ids": [
        "string"
      ],
      "prerequisite_customer_segment_ids": [
        "string"
      ],
      "entitled_product_ids": [
        "string"
      ],
      "entitled_variant_ids": [
        "string"
      ],
      "entitled_filter_ids": [
        "string"
      ],
      "entitled_filter_list": [
        "string"
      ],
      "variant_product_ids": [
        "string"
      ],
      "entitled_collection_ids": [
        "string"
      ],
      "entitled_area_list": [
        {
          "country_code": "string",
          "province_codes": [
            "string"
          ]
        }
      ],
      "prerequisite_subtotal_range": [
        {
          "greater_than_or_equal_to": "string",
          "value": "string",
          "value_percentage": "string",
          "value_event_type": "string",
          "value_condition": "string",
          "target_type": "string",
          "target_data": [
            "string"
          ]
        }
      ],
      "prerequisite_quantity_range": [
        {
          "greater_than_or_equal_to": "string",
          "value": "string",
          "value_percentage": "string",
          "value_event_type": "string",
          "value_condition": "string",
          "target_type": "string",
          "target_data": [
            "string"
          ]
        }
      ]
    }
  }
}