🔒
The Discount Rebate List API retrieves a list of discount rebates available for a shop. This enables users to manage and view rebate details for promotions and campaigns.
This API is especially useful for:
- Viewing available discount rebates in the store.
- Managing rebate campaigns for customers.
- Fetching rebate details with optional URL links for each campaign.
📘
| Parameter | Type | Required | Description | Example |
|---|
cursor | string | No | Cursor for pagination, use the cursor from the response to retrieve the next page | cursor_123456 |
page_size | int32 | No | A limit on the number of objects to be returned. Ranges from 1 to 250. Default is 10 | 20 |
need_detail_url | boolean | No | If true, returns detail URLs in the response | true |
📘
| Parameter | Type | Example | Description |
|---|
code | string | 200 | Error code (200 indicates success) |
message | string | Success | Error message |
data | object | {...} | Contains the price rules data |
data.rebates | array of objects | [ {...}, {...} ] | List of rebate promotion objects |
data.cursor | string | cursor_123456 | Cursor for pagination |
data.has_more | boolean | true | Indicates if there are more results available |
| Parameter | Type | Example | Description |
|---|
id | string | rb_123456 | Unique identifier of the rebate promotion |
title | string | Summer Rebate Program | Name of the rebate promotion |
discount_type | string | percentage | Type of discount (percentage, fixed_amount) |
value | float | 10.0 | Discount value amount |
value_type | string | percentage | Type of discount value (percentage, fixed_amount) |
starts_at | string | 2023-06-01T00:00:00Z | Start date and time (ISO 8601 format) |
ends_at | string | 2023-06-30T23:59:59Z | End date and time (ISO 8601 format) |
status | string | active | Current status of the promotion |
usage_limit | int32 | 100 | Maximum number of times the promotion can be used |
times_used | int32 | 45 | Number of times the promotion has been used |
once_per_customer | int32 | 1 | Whether limited to once per customer (1=yes, 0=no) |
allocation_method | string | each | How discounts are allocated (each, across) |
allocation_limit | int32 | 1 | Limit of discount allocation |
allocation_limit_amount | float | 5.0 | Maximum amount for allocation limit |
customer_selection | string | all | Customer selection method (all, prism, explicit) |
target_selection | string | all | Target selection method (all, prism, explicit) |
target_type | string | line_item | Type of target (line_item, shipping_line) |
target_price_type | string | original | Price type target (original, current) |
product_num | int32 | 42 | Number of products included |
progress | string | 50% | Current participation progress |
sort | string | priority | Sorting priority |
prerequisite | int32 | 0 | Prerequisite condition flag |
prerequisite_customer_ids | array of strings | ["cust_123", "cust_456"] | List of prerequisite customer IDs |
prerequisite_customer_segment_ids | array of strings | ["seg_123", "seg_456"] | List of prerequisite customer segment IDs |
prerequisite_customer_range | string | new | Customer range for prerequisite |
prerequisite_quantity_range | array of objects | [ {...} ] | Prerequisite quantity range conditions |
prerequisite_subtotal_range | array of objects | [ {...} ] | Prerequisite subtotal range conditions |
prerequisite_threshold_quantity_range | string | 5 | Threshold quantity range |
prerequisite_threshold_subtotal_range | string | 100.0 | Threshold subtotal range |
entitled_product_ids | array of strings | ["prod_123", "prod_456"] | List of entitled product IDs |
entitled_variant_ids | array of strings | ["var_123", "var_456"] | List of entitled variant IDs |
entitled_collection_ids | array of strings | ["coll_123", "coll_456"] | List of entitled collection IDs |
entitled_filter_ids | array of strings | ["flt_123", "flt_456"] | List of entitled filter IDs |
entitled_filter_list | array of strings | ["filter1", "filter2"] | List of entitled filter list items |
entitled_area_list | array of strings | ["area1", "area2"] | List of entitled area list items |
variant_product_ids | array of strings | ["prod_123", "prod_456"] | List of variant product IDs |
global_show_text | string | Summer Special | Global display text |
popups_id | string | popup_123 | Associated popup ID |
popups_setting | string | {"color":"red"} | Popup settings in JSON format |
discount_channel_list | array of objects | [ {...} ] | List of discount channels |
entitled_extra_list | array of objects | [ {...} ] | List of entitled extra items |
| Parameter | Type | Example | Description |
|---|
greater_than_or_equal_to | string | 5 | Minimum quantity |
value | string | 5 | Quantity value |
value_percentage | string | 10.0 | Quantity percentage value |
value_event_type | string | purchase | Event type for quantity |
value_condition | string | greater_than | Condition for quantity comparison |
target_type | string | line_item | Target type for quantity |
target_data | array of strings | ["prod_123"] | Target data for quantity |
| Parameter | Type | Example | Description |
|---|
greater_than_or_equal_to | string | 100.0 | Minimum subtotal amount |
value | string | 100.0 | Subtotal value |
value_percentage | string | 10.0 | Subtotal percentage value |
value_event_type | string | purchase | Event type for value |
value_condition | string | greater_than | Condition for value comparison |
target_type | string | line_item | Target type for value |
target_data | array of strings | | |
| Field | Type | Example | Description |
|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |
