Skip to main content

Query Promotions

Commerce
Promotions
REST API
Booking Solutions

What is it?

Use this API to retrieve a list of promotions configured at a chain or hotel level.

Why use it?

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

How to use

Retrieve a list of Chain level Promotions

[GET] /v1/api/admin/product/promotions?chainId=14106&primaryChannel=WEB

Retrieve a list of Hotel level Promotions

[GET] /v1/api/admin/product/promotions?hotelId=13098&primaryChannel=WEB

Retrieve a list of Hotel and Chain level Promotions

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

Retrieve promotions by one or more promotions codes

[GET] /v1/api/admin/product/promotions?chainId=14106&primaryChannel=WEB&promotionCode=Thanksgiving,loyaltySpecials

Sample Response

{
    "paging": {
        "Size": 1,
        "Start": 0,
        "Total": 1
    },
    "PromotionList": [
        {
            "BranchAccessList": [],
            "LocationList": [],
            "RateList": [],
            "ImageList": [
                {
                    "Path": "\\chain\\14106\\Images\\Promotion\\Promo.jpg",
                    "SortOrder": 0,
                    "MediaType": "CRS",
                    "MediaCategory": "Promotion"
                }
            ],
            "PricingRuleList": [
                {
                    "BookingWindow": {
                        "Type": "FixedDateRange",
                        "StartDate": "2019-07-16T00:00:00",
                        "EndDate": "2019-07-16T00:00:00",
                        "StartTime": 0,
                        "EndTime": 2359
                    },
                    "ArrivalWindow": {
                        "StartDate": "2019-07-16T00:00:00",
                        "EndDate": "2019-07-16T00:00:00",
                        "MaxLOS": 8.0,
                        "MinLOS": 5.0
                    },
                    "Name": "",
                    "EffectiveStart": 1,
                    "EffectiveNights": 2,
                    "DiscountAppliesEach": 1,
                    "PriceAdjustment": 0.0,
                    "PriceAdjustmentUnit": "Amount"
                }
            ],
            "Chain": {
                "Id": 14106
            },
            "Code": "Buy3Get4",
            "Name": "Book 3 Nights Get 4th Night Free",
            "Description": "",
            "StrikeThroughPricing": false,
            "SortOrder": 1,
            "Active": true
        }
    ],
    "ContentList": {
        "Specified": "true",
        "HotelList": [],
        "ChainList": [
            {
                "Id": 19923,
                "Code": "SABTC",
                "Name": "Sabre Hospitality Test Chain"
            }
        ],
        "LocationList": [],
        "RateList": [],
        "BrandList": []
    }
}