get https://{subdomain}.myshoplaza.com/openapi/2022-01/price_rules/
Requires
price_rulesaccess scope. More access scope
The Price Rule Detail API retrieves detailed information about a specific price rule based on its ID.
This API is especially useful for:
- Fetching detailed information about a price rule for analysis or modification.
- Verifying the attributes of a specific discount rule applied to products.
- Retrieving prerequisite or entitlement conditions for a price rule.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
price_rule_id | string | Yes | Price rule ID. | 91f9a466-7c8c-46e7-9774-64874a641534 |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
price_rule |
object |
See fields below. | Object containing details about the created price rule. |
price_rule[] |
string |
"2d7e416a-444f-4491-ae04-c50f47154140" |
Unique identifier of the price rule. |
price_rule[] |
string |
"Buy 2 Get 1 Free" |
Title of this price rule. |
price_rule[] |
double |
10.5 |
Value of the discount. |
price_rule[] |
string |
"fixed_amount" |
Type of the discount value. Options: percentage, fixed_amount. |
price_rule[] |
string |
"100" |
Maximum number of times the discount can be used. -1 means no limit. |
price_rule[] |
string |
"5" |
Number of times the discount has been used. |
price_rule[] |
string |
"each" |
Allocation method for the discount. |
price_rule[] |
string |
"1" |
Redeem count limit per checkout. 0 means no limit. |
price_rule[] |
string |
"0" |
Indicates if the discount can be used only once per customer. "1" means yes. |
price_rule[] |
string |
"1" |
Indicates if the discount has prerequisites. "1" means yes. |
price_rule[] |
string |
"specific" |
Specifies the customer selection for the discount. |
price_rule[] |
string |
"entitled" |
Specifies the target product selection for the discount. |
price_rule[] |
string |
"line_item" |
Specifies the type of target for the discount. |
price_rule[] |
string |
"2024-12-19 10:00:00" |
Timestamp of when the price rule was created. |
price_rule[] |
string |
"2024-12-20 12:00:00" |
Timestamp of when the price rule was last updated. |
price_rule[] |
string |
"1700000000" |
Start time of the discount (Unix timestamp). |
price_rule[] |
string |
"1700500000" |
End time of the discount (Unix timestamp). |
price_rule[] |
array[string] |
["product-1", "product-2", "product-3"] |
List of product IDs entitled for the discount. |
price_rule[] |
array[string] |
["variant-1", "variant-2"] |
List of product variant IDs entitled for the discount. |
price_rule[] |
array[object] |
See fields below. | Prerequisite for total product quantity in the cart. |
price_rule[] |
string |
"3" |
Minimum quantity of products required to apply the discount. |
price_rule[] |
string |
"15" |
Value used for discount application. |
price_rule[] |
string |
"line_item" |
Specifies the type of target for the discount. |
price_rule[] |
array[string] |
["target-1", "target-2"] |
List of target data IDs for the discount rule. |
price_rule[] |
array[object] |
See fields below. | Prerequisite for total cart amount. |
price_rule[] |
string |
"100" |
Minimum subtotal amount required to apply the discount. |
price_rule[] |
string |
"20" |
Discount value applied when subtotal condition is met. |
price_rule[] |
string |
"line_item" |
Specifies the type of target for the discount. |
price_rule[] |
array[string] |
["subtotal-target-1"] |
List of target data IDs for the subtotal discount rule. |
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 | |
| 404 | Not Found | The id provided is not existed. | "Not found" |