Skip to main content

Query Coupons

Hotel
Search
REST API
Hospitality
Try Now

What is it?

The Query Coupons API returns a list of active hotel and/or chain level coupons and related setup information.

Why use it?

Export/Import Coupon configuration information to a CRM or DWH.

How to use

Retrieve a list of Chain level Coupons

[GET] /v1/api/admin/product/coupons?chainId=14106&primaryChannelCode=WEB

Retrieve a list of Hotel level Coupons

[GET] /v1/api/admin/product/coupons?hotelId=13098&primaryChannelCode=WEB

Retrieve a list of Hotel and Chain level Coupons

[GET] /v1/api/admin/product/coupons?chainId=14106&hotelId=13098&primaryChannelCode=WEB

Retrieve coupons by one or more coupon codes

[GET] /v1/api/admin/product/coupons?chainId=14106&primaryChannelCode=WEB&couponCode=SAVE25,SAVE50

Sample Response

{
    "CouponOfferList": [
        {
            "PricingRule": {
                "Rule": "SimpleOffer",
                "AppliesTo": "Reservationtotal",
                "PriceAdjustment": -25.0,
                "MinSpend": 0.0,
                "PriceAdjustmentUnit": "Amount"
            },
            "ValidityRules": {
                "ArrivalStartDate": "2020-01-06T00:00:00",
                "ArrivalEndDate": "2020-04-30T00:00:00",
                "BookingStartDate": "2020-01-06T00:00:00",
                "BookingEndDate": "2020-05-30T00:00:00"
            },
            "Chain": {
                "Id": 14106
            },
            "ChannelList": [
                {
                    "Code": "WEB"
                }
            ],
            "ExclusionList": [
                {
                    "CouponOfferCode": "Save50"
                }
            ],
            "CouponAccessList": [
                {
                    "Code": "SAVE25",
                    "Consumed": false
                }
            ],
            "Code": "SAVE25",
            "Name": "Save 25%",
            "Description": "Enjoy your Summer and Save 25% off your stay with us!",
            "Active": true,
            "MultiUseCoupon": true,
            "GroupRateApplicable": true,
            "RoomUpsellAllowed": true,
            "ReusableAfterCancellation": true,
            "CombinedCouponsRestricted": false,
            "SellLimit": 20
        }
    ],
    "Paging": {
        "Size": 1,
        "Start": 0,
        "Total": 1
    },
    "ContentList": {
        "HotelList": [],
        "ChainList": [
            {
                "Code": "SABTC",
                "ID": 19923,
                "Name": "Sabre Hospitality Test Chain"
            }
        ],
        "RateList": [],
        "RoomList": [],
        "RateCategoryList": [],
        "RoomCategoryList": [],
        "ChannelList": [
            {
                "Code": "WEB",
                "Name": "Booking Engine"
            }
        ]
    }
}