List price rules

GET 
/openapi/2025-06/price_rules

Retrieves a list of price rules that can be applied to customer orders.

Request

Query Parameters

cursor string

Cursor for pagination, use the cursor from the response to retrieve the next page

page_size int32

A limit on the number of objects to be returned. Ranges from 1 to 250. Default is 50

starts_at_min string

Filter price rules that started after this date (Unix timestamp)

starts_at_max string

Filter price rules that started before this date (Unix timestamp)

ends_at_min string

Filter price rules that ended after this date (Unix timestamp)

ends_at_max string

Filter price rules that ended before this date (Unix timestamp)

times_used int32

Filter price rules by the number of times they have been used

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

price_rules object[]

List of price rules

Array [

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

]

]

cursorstring

Cursor for pagination

has_moreboolean

Whether there are more records

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "price_rules": [
      {
        "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"
            ]
          }
        ]
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}