Breadcrumb
- Hotel Availability
- Request
- Use Cases
- Coupon Code
Coupon Code
Coupon Codes
The message supports Single or Multiple-Use coupons.
Note: The coupon code only indicates that the coupon applies to the product. The product price is not adjusted to reflect the discount.
Parameter | Description | Type |
---|---|---|
couponCode | Code associated with a coupon or offer | [String] |
Samples Request
Request using 2 coupons (CPN1 and CPN2).
/v1/api/hotel/availability?hotelId=13098&chainId=12723&adults=2&startDate=2022-12-17&endDate=2022-12-20&numRooms=1&primaryChannel=WEB&secondaryChannel=WEB&adults=2&couponCode=CPN1,CPN2
Response (partial)
Response attributes related to coupon functionality.
Parameter | Description | Type |
---|---|---|
contentLists/CouponOfferList | Contains information about coupon codes that are valid for the products in the response | [Array] |
contentLists/CouponOfferList/@Code | Code associated with a coupon | String |
contentLists/CouponOfferList/@Name | Name associated with a coupon | String |
ProductAvailability/CouponOfferCode/@Value | Contains information about coupon codes that are valid for the products in the response | String |
ProductAvailability/Prices/Product/ApplicableCouponOfferList | Contains information about coupon codes that are valid for the associated product. | [Array] |
ProductAvailability/Prices/Product/ApplicableCouponOfferList/@Code | Coupon Code associated with the associated product. | String |
ProductAvailability/Prices/Product/CouponApplies | If true, indicates that a coupon applys to the associated product. | Boolean |
{
"contentLists": {
"CouponOfferList": [{
"Code": "CPN1",
"Name": "Save 10% off Total Price"
}, {
"Code": "CPN2",
"Name": "Bonus Additional 5% Savings"
}]
},
"productAvailability": {
"CouponOfferCode": {
"Value": "CPN1"
},
"Prices": [{
"Product": {
"Prices": {},
"Rate": {
"Code": "PROMO"
},
"Room": {
"Code": "SUPK"
}
},
"ApplicableCouponOfferList": [{
"Code": "CPN2"
}, {
"Code": "CPN1"
}],
"Available": true,
"AvailableInventory": 20,
"CouponApplies": true,
"IsMaximumPricedItem": false,
"IsMinimumPricedItem": true,
"SortSequenceNumber": 2
}]
}
}