Retrieve Promotion Types API

Retrieves all available promotion types and their applicable discount ranges and target channels for a property.

---

Endpoint

POST

https://connect.su-api.com/SUAPI/jservice/bdc/promotion/retrieveTypes 

Attributes

hotel_id string (Required)

Specifies the required node hotelid contains the IT provider's hotel id for which the provider wishes to retrieve promotion types.

---

channel_hotel_id string (Required)

Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).

---

Sample Request

{
  "hotel_id": "AWSTEST",
  "channel_hotel_id": "13130616"
}

---

Response

Success Response

{
  "Status": "Success",
  "Message": "Promotion types retrieved successfully",
  "Ruid": "3496f788-86b7-4b85-a2a8-e5429a0ab3fc",
  "Data": {
    "mobile_rate": {
      "discount": [
        {
          "min": 10,
          "max": 80,
          "target_channel": null
        }
      ]
    },
    "basic": {
      "discount": [
        {
          "min": 1,
          "max": 99,
          "target_channel": "PUBLIC"
        },
        {
          "min": 10,
          "max": 99,
          "target_channel": "SECRET"
        }
      ],
      "target_channels": [
        {
          "id": "public",
          "name": "PUBLIC"
        },
        {
          "id": "secret",
          "name": "SECRET"
        }
      ]
    },
    "campaign_getaway": {
      "discount": [
        {
          "min": 15,
          "max": 99,
          "target_channel": null
        }
      ],
      "stay_date": {
        "start": "",
        "end": ""
      },
      "book_date": {
        "start": "2026-03-12",
        "end": "2026-09-30"
      }
    },
    "early_booker": {
      "discount": [
        {
          "min": 1,
          "max": 99,
          "target_channel": "PUBLIC"
        },
        {
          "min": 10,
          "max": 99,
          "target_channel": "SECRET"
        }
      ],
      "target_channels": [
        {
          "id": "public",
          "name": "PUBLIC"
        },
        {
          "id": "secret",
          "name": "SECRET"
        }
      ]
    },
    "geo_rate": {
      "discount": [
        {
          "min": 5,
          "max": 30,
          "target_channel": null
        }
      ],
      "target_channels": [
        {
          "id": "algeria_pos",
          "name": "ALGERIA"
        },
        {
          "id": "argentina_pos",
          "name": "ARGENTINA"
        },
        {
          "id": "australia_pos",
          "name": "AUSTRALIA"
        },
        {
          "id": "belarus_pos",
          "name": "BELARUS"
        },
        {
          "id": "bolivia_pos",
          "name": "BOLIVIA"
        },
        {
          "id": "brazil_pos",
          "name": "BRAZIL"
        },
        {
          "id": "canada_pos",
          "name": "CANADA"
        },
        {
          "id": "chile_pos",
          "name": "CHILE"
        },
        {
          "id": "china_pos",
          "name": "CHINA"
        },
        {
          "id": "colombia_pos",
          "name": "COLOMBIA"
        },
        {
          "id": "domestic_pos",
          "name": "DOMESTIC"
        },
        {
          "id": "dominican_republic_pos",
          "name": "DOMINICAN REPUBLIC"
        },
        {
          "id": "eu_pos",
          "name": "EUROPEAN ECONOMIC AREA"
        },
        {
          "id": "hong_kong_pos",
          "name": "HONG KONG"
        },
        {
          "id": "india_pos",
          "name": "INDIA"
        },
        {
          "id": "indonesia_pos",
          "name": "INDONESIA"
        },
        {
          "id": "international_pos",
          "name": "INTERNATIONAL"
        },
        {
          "id": "iran_pos",
          "name": "IRAN"
        },
        {
          "id": "israel_pos",
          "name": "ISRAEL"
        },
        {
          "id": "japan_pos",
          "name": "JAPAN"
        },
        {
          "id": "kazakhstan_pos",
          "name": "KAZAKHSTAN"
        },
        {
          "id": "kuwait_pos",
          "name": "KUWAIT"
        },
        {
          "id": "malaysia_pos",
          "name": "MALAYSIA"
        },
        {
          "id": "mexico_pos",
          "name": "MEXICO"
        },
        {
          "id": "new_zealand_pos",
          "name": "NEW ZEALAND"
        },
        {
          "id": "oman_pos",
          "name": "OMAN"
        },
        {
          "id": "pakistan_pos",
          "name": "PAKISTAN"
        },
        {
          "id": "paraguay_pos",
          "name": "PARAGUAY"
        },
        {
          "id": "peru_pos",
          "name": "PERU"
        },
        {
          "id": "philippines_pos",
          "name": "PHILIPPINES"
        },
        {
          "id": "qatar_pos",
          "name": "QATAR"
        },
        {
          "id": "russia_pos",
          "name": "RUSSIA"
        },
        {
          "id": "saudi_arabia_pos",
          "name": "SAUDI ARABIA"
        },
        {
          "id": "singapore_pos",
          "name": "SINGAPORE"
        },
        {
          "id": "south_africa_pos",
          "name": "SOUTH AFRICA"
        },
        {
          "id": "south_korea_pos",
          "name": "SOUTH KOREA"
        },
        {
          "id": "switzerland_pos",
          "name": "SWITZERLAND"
        },
        {
          "id": "taiwan_pos",
          "name": "TAIWAN"
        },
        {
          "id": "thailand_pos",
          "name": "THAILAND"
        },
        {
          "id": "trinidad_&_tobago_pos",
          "name": "TRINIDAD AND TOBAGO"
        },
        {
          "id": "turkey_pos",
          "name": "TURKEY"
        },
        {
          "id": "ukraine_pos",
          "name": "UKRAINE"
        },
        {
          "id": "united_arab_emirates_pos",
          "name": "UNITED ARAB EMIRATES"
        },
        {
          "id": "united_kingdom_pos",
          "name": "UNITED KINGDOM"
        },
        {
          "id": "united_states_pos",
          "name": "UNITED STATES"
        },
        {
          "id": "vietnam_pos",
          "name": "VIETNAM"
        }
      ]
    },
    "campaign_early_year": {
      "discount": [
        {
          "min": 15,
          "max": 99,
          "target_channel": null
        }
      ],
      "stay_date": {
        "start": "",
        "end": ""
      },
      "book_date": {
        "start": "2025-12-06",
        "end": "2026-04-01"
      }
    },
    "last_minute": {
      "discount": [
        {
          "min": 1,
          "max": 99,
          "target_channel": "PUBLIC"
        },
        {
          "min": 10,
          "max": 99,
          "target_channel": "SECRET"
        }
      ],
      "target_channels": [
        {
          "id": "public",
          "name": "PUBLIC"
        },
        {
          "id": "secret",
          "name": "SECRET"
        }
      ]
    }
  }
}

---

Success Response - Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.

---

Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.

---

Ruid string

Specifies the unique request ID.

---

Data object

An object containing data related to the successful promotion creation. This typically includes identifiers for the created promotions.

---

mobile_rate object

Defines promotions applicable to mobile users.

---

discount array[object]

List of discounts for mobile rates.

---

min integer

Minimum discount value allowed.

---

max integer

Maximum discount value allowed.

---

target_channel string

The applicable channel, if any.

---

basic object

Standard promotion type available across general distribution channels.

---

discount array[object]

List of discounts for basic promotions.

---

min integer

Minimum discount value allowed.

---

max integer

Maximum discount value allowed.

---

target_channel string

Channel this discount applies to (PUBLIC / SECRET).

---

target_channels array[object]

All possible target channels for the promotion type.

---

id string

Identifier of the target channel.

---

name string

Display name of the target channel.

---

campaign_getaway object

Represents limited-time promotional campaigns (e.g., seasonal or themed offers).

---

discount array[object]

Discount ranges for the campaign.

---

stay_date object

Valid stay date range.

---

start date (YYYY-MM-DD)

Start date of stay eligibility.

---

end date (YYYY-MM-DD)

End date of stay eligibility.

---

book_date object

Valid booking date range.

---

start date (YYYY-MM-DD)

Start date when promotion can be booked.

---

end date (YYYY-MM-DD)

End date when promotion can be booked.

---

early_booker object

Promotions intended for guests booking in advance.

---

discount array[object]

Discount ranges for early booking.

---

target_channels array[object]

Available channels.

---

geo_rate object

Location-based promotions targeted at users from specific countries or regions.

---

discount array[object]

Discount for geo location.

---

target_channels array[object]

Country-specific channels.

---

id string

Country POS identifier.

---

name string

Country name.

---

campaign_early_year object

Campaign-specific promotion typically applicable at the beginning of the year.

---

discount array[object]

Discount for early year campaign.

---

stay_date object

Valid stay date range.

---

book_date object

Valid booking date range.

---

last_minute object

Promotions designed for last-minute bookings.

---

discount array[object]

Discount ranges by channel.

---

min integer

Minimum discount percentage.

---

max integer

Maximum discount percentage.

---

target_channel string

Channel (PUBLIC or SECRET).

---

target_channels array[object]

Country-specific channels.

---

id string

Country POS identifier.

---

name string

Country name.

---

Errors Response - Body Elements

Sample Error Response

{
   "Status": "Fail",
   "Errors": [
      {
         "Code": "573",
         "ShortText": "channel-mapping not found for this property!"
      }
   ],
   "Message": "",
   "Ruid": ""
}

---

Errors Response - Body Elements

---

Status string

Indicates the result of the API call.

"Fail" – The request was not processed successfully due to validation errors or other issues.

---

Errors array[object]

A list of error objects providing detailed information about one or more issues encountered during request processing. This field may be empty if the error is conveyed through the Message field.

---

Code string

A unique error code representing the specific type of validation or processing error.

---

ShortText string

A brief, human-readable description of the error. Typically explains what went wrong and may include accepted values or constraints.

---

Message string

A descriptive error message summarizing the failure.

---

Ruid string

A unique request identifier generated for tracking and debugging purposes. This value should be provided when contacting support for issue investigation.