Skip to main content

Types that use AvailableCoupon

CoreItemItem

Calls that use AvailableCoupon

GET
/item/{item_id}
GET
/item/get_item_by_legacy_id
GET
/item/
GET
/item/get_items_by_item_group

Fields

Field
Type
Description
constraint
CouponConstraint
The limitations or restrictions of the coupon.
discountAmount
Amount
The discount amount after the coupon is applied.
discountType
CouponDiscountType
The type of discount that the coupon applies.
message
string
A description of the coupon.

Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included, if returned in the API response.
redemptionCode
string
The coupon code.
termsWebUrl
string
The URL to the coupon terms of use.

Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included, if returned in the API response.