Promo API

General

What are the certification steps?

Promo API Certification is brief. Once Self-certification is completed and validated, partner is considered certified on Promo API

  • Self-Certification: A script testing in survey format for partner to complete after finishing the development.

  • Self-Certification Link >>> Please click here.

What are the promotion types supported via API?

  • Customized

  • EarlyBird

  • ExpressTonight

  • LastMinute

  • LongStay

  • SeventyTwoHours

  • SpecialOffer

What are the mandatory promotion types that must be developed?

Customized Promotion Type is mandatory. The rest is optional.

Can promotion be created specifically for certain room types or rate plans

Yes, by specifying room type ID or rate plan ID in the upsert request. If IDs are not specified, then promotion is applicable for all room types or rate plans.

What is 'channel' in the upsert request?

Channel is sale channel such as Agoda Private Sale, Mobile, etc.

Channel can only be included in promotion upsert request if that certain channel is activated.

Channel ID 1 (Retail) is a default channel.

Other channels have to be activated first by requesting Agoda support team or through Content Push API if supported by channel manager.

Otherwise, if inactive channel IDs are included in the request, Agoda will return error 'channel ID can be either 0 or 1'

What happen if cancellation policy is not included in promotion upsert request?

The logic is to use the strictest cancellation policy applicable to the booking whether it's rate plan level or hotel level.

When updating a promotion and optional fields are not passed, will they get deleted?

All fields that not passed with request will assign with default value. Suggest to include all fields with request.

Are the date and time fields based on hotel time zone?

Yes.

How do we specify the discounts with different NightType?

For SpecificNight, suggest to provide 7 values, starting with the discounted value for the first night till the seventh night. (if provide less than 7 values then the rest will fill with default value: 0.0 / provide more than 7 values is not allowed)

<AmountPerNight NightType="SpecificNight">

<Value>0.0</Value>

<Value>110.0</Value>

<Value>110.0</Value>

<Value>120.0</Value>

<Value>0.0</Value>

<Value>130.0</Value>

<Value>130.0</Value>

</AmountPerNight>


For SpecificDOW, suggest to provide 7 values, starting with the discounted percentage for Sunday till Saturday. (if provide less than 7 values then the rest will fill with default value: 0.0 / provide more than 7 values is not allowed)

<PercentPerNight NightType="SpecificDOW">

<Value>25.0</Value>

<Value>20.0</Value>

<Value>0.0</Value>

<Value>25.0</Value>

<Value>10.0</Value>

<Value>0.0</Value>

<Value>0.0</Value>

</PercentPerNight>


For EveryNight, suggest to provide only 1 value. (will ignore the rest if provide more than 1)

<AmountPerNight NightType="EveryNight">

<Value>110.0</Value>

</AmountPerNight>


For FirstNight, suggest to provide only 1 value. (will ignore the rest if provide more than 1)

<PercentPerNight NightType="FirstNight">

<Value>110.0</Value>

</PercentPerNight>


For LastNight, suggest to provide only 1 value. (will ignore the rest if provide more than 1)

<AmountPerNight NightType="LastNight">

<Value>110.0</Value>

</AmountPerNight>