get https://{subdomain}.myshoplaza.com/openapi/2022-01/discount_codes/lookup
Requires
price_rulesaccess scope. More access scope
The Search Discount Code API allows you to find a specific discount code by providing its code.
This API is especially useful for:
- Retrieving detailed information about a specific discount code.
- Verifying if a discount code exists in the system.
- Fetching metadata and usage statistics for a specific discount code.
Request Parameters
Public Request Parameters
Query Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
code | string | Yes | "SUMMERSALE100FF" | The unique discount code to be searched for. |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
discount_code | object | See below. | The details of the discount code. |
discount_code.id | string | "f819c126-a581-4d66-a909-08282dd35916" | Unique identifier for the discount code. |
discount_code.price_rule_id | string | "588fea0b-f15d-4c1d-9390-23661f0194fa" | Identifier of the associated price rule. |
discount_code.code | string | "VIJK8GB0" | The discount code value. |
discount_code.created_at | string | "2022-06-17 07:48:29" | Creation timestamp of the discount code. |
discount_code.updated_at | string | "2022-06-17 07:48:29" | Last updated timestamp of the discount code. |
discount_code.use_with_other | string | "1" | Indicates if the discount can be combined with others. |
discount_code.usage_count | string | "0" | Number of times the discount code has been used. |
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 |