get https://{subdomain}.myshoplaza.com/openapi/2022-01/discount_rebates
Requires
price_rulesaccess scope. More access scope
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.
Request Parameters
Public Request Parameters
Quert Parameters
| Name | Type | Description | Example | Required/Optional |
|---|---|---|---|---|
limit | int32 | Limit count per page | 20 | Optional |
page | int32 | Page number | 1 | Optional |
need_detail_url | boolean | Whether to include detail URLs | true | Optional |
Response Explanation
Public Response Parameters
Success Response
| Name | Type | Example | Description |
|---|---|---|---|
page | int32 | 1 | Current page number |
limit | int32 | 20 | Number of items per page |
total | int32 | 1 | Total number of discount rebates |
data | array | - | Array of discount rebate details |
data[].id | string | 47d2a827-e914-49e0-a14c-3161edb1ae9e | Unique ID of the rebate |
data[].title | string | tzt-满减活动-吸引客户购买更多 | Title of the rebate |
data[].progress | string | ongoing | Current progress of the rebate |
data[].discount_type | string | fixed_amount | Type of discount applied |
data[].value | string | 0 | Value of the discount |
data[].value_type | string | fixed_amount | Value type of the discount |
data[].starts_at | string | 1682652084 | Start time of the rebate |
data[].ends_at | string | -1 | End time of the rebate |
data[].prerequisite_subtotal_range | array | - | Subtotal range requirements |
data[].prerequisite_subtotal_range[].greater_than_or_equal_to | string | 123 | Minimum subtotal for eligibility |
data[].prerequisite_subtotal_range[].value_condition | string | less_than_or_equal_to | Condition for the subtotal value |
data[].allocation_method | string | across | Allocation method of the rebate |
data[].customer_selection | string | all | Customer eligibility for the rebate |
data[].status | string | 1 | Status of the rebate |
data[].detail_url | string | tzt.myshoplaza.com/promotions/rebate/47d2a827-e914-49e0-a14c-3161edb1ae9e | URL for detailed rebate information (if requested) |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "invalid line_item id"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |