Search Discount Code

GET 
/openapi/2022-01/discount_codes/lookup

Looks up a discount code by its code value.

Request

Query Parameters

code string

Discount code, for example: SUMMERSALE10OFF

Responses

200

200

application/json

Schema

Schema

discount_code object
idstring
Example: f819c126-a581-4d66-a909-08282dd35916
price_rule_idstring
Example: 588fea0b-f15d-4c1d-9390-23661f0194fa
codestring
Example: VIJK8GB0
created_atstring
Example: 2022-06-17 07:48:29
updated_atstring
Example: 2022-06-17 07:48:29
use_with_otherstring
Example: 1
usage_countstring
Example: 0

Example

{
  "discount_code": {
    "id": "f819c126-a581-4d66-a909-08282dd35916",
    "price_rule_id": "588fea0b-f15d-4c1d-9390-23661f0194fa",
    "code": "VIJK8GB0",
    "created_at": "2022-06-17 07:48:29",
    "updated_at": "2022-06-17 07:48:29",
    "use_with_other": "1",
    "usage_count": "0"
  }
}

Result

{
    "discount_code": {
        "id": "f819c126-a581-4d66-a909-08282dd35916",
        "price_rule_id": "588fea0b-f15d-4c1d-9390-23661f0194fa",
        "code": "VIJK8GB0",
        "created_at": "2022-06-17 07:48:29",
        "updated_at": "2022-06-17 07:48:29",
        "use_with_other": "1",
        "usage_count": "0"
    }
}