j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
CouponItem
Document representing a coupon item.
code
string
Required
The coupon code.
Maximum characters:
256
5ties
couponItemId
string
The coupon item ID. It is read only.
statusCode
string
enum
The status of the coupon item. It is read only.
Enum values:
- coupon_code_already_in_basket
- coupon_code_already_redeemed
- coupon_code_unknown
- coupon_disabled
- redemption_limit_exceeded
- customer_redemption_limit_exceeded
- timeframe_redemption_limit_exceeded
- no_active_promotion
- coupon_already_in_basket
- no_applicable_promotion
- applied
- adhoc
no_applicable_promotion
valid
boolean
A flag indicating whether the coupon item is valid. A coupon line item is valid if the status code is "applied" or "no_applicable_promotion". It is read only.
true
unknown type
This type supports additional properties passed along with the defined properties of this API.
To indicate that the properties were defined and expected to be handled as additional properties, they are expected to be prefixed with a c_.
The type will reject any property that does not fit this pattern, only allowing additional properties beginning with the known prefix.