YCSAPI 5

Pre-Certification

General

What are the certification steps?

Certification consists of 2 steps including self-certification and pilot phase

 What are the mandatory calls that must be developed?

What is difference between a generic endpoint and a unique endpoint for each call? 

Unique endpoint: This endpoint is unique for a specific request so ‘type’ is not required in request body.

Generic endpoint: This endpoint is a universal endpoint which can be used for any Agoda API request; however, ‘type’ is mandatory in request body.

What are the day limits for each call?

SetAri: 730 days from today

GetAri: 31 days

GetBookingList: Date range = 90 days, looking back 740 days

GetBookingListV2: Date/Time range = 60 mins, looking back 740 days

What is the size limit of each request?

1 MB

Does Agoda restrict request limit per day?

No

Post-Certification

ARI Management

Does Agoda support child daily rate?

Yes, we do. However, Child daily pricing is not yet supported in YCS Calendar so child pricing can only be retrieved and viewed via API call (GetAri)

What is the difference between Min LOS and Min Night for Stay-Through?

For example: if the property set a restriction on Friday, Jan 1st.

Why does CTA/CTD not available in YCS? 

Does Agoda support price with decimal value

Why does child rate plan is still opened, when master rate plan is closed?

Why does the rate plan is still opened, when channel manager successfully pushed 'close out = true'?

Can property manage channel discount themselves?

Yes, they can manage channel in YCS > Rates & Availability > Rates Channel

Only certain channels can be self-managed by the property. If certain channels are not available in the page, please contact Accommodation Services Team via YCS Help Widget for further assistance to manage the channels.

Booking Management

Does Agoda have push booking notification?

Agoda doesn’t have push booking, only BookingHint (Booking Notification), and pull booking calls such as GetBookingList (v1 or v2) and GetBookingDetails.

For BookingHint, Agoda pushes booking notification to channel manager partner when there are new, amend, cancel bookings. Then channel manager partner retrieves complete booking details from Agoda by using GetBookingDetails request.

To set up BookingHint, please provide us an URL endpoint and an email address to receive booking notification email in case BookingHint failed to be pushed.

What is the difference of GetBookingListV1 and GetBookingListV2?

GetBookingListV1: To retrieve the bookings for one specific property or up to 5 properties at once.

GetBookingListV2: To retrieve the bookings without specifying a hotel. This will return all bookings that updated in specified period (Max. 60 mins) of all hotels belongs on channel manager.

How to identify Agoda collect and property collect reservation?

Agoda Collect: <paymentmodel>1</paymentmodel>

Property Collect: <paymentmodel>2</paymentmodel>

Why are we seeing different pricing structures returned in GetBookingDetails?

Agoda has different configurations to return different pricing structures in GetBookingDetails, which are based on property location and payment model. Including:

Default (Agoda Collect): net_inclusive and ref_sell

Property Collect: Sell_inclusive

Taiwan: Net_inclusive

US and its territories*: Net_exclusive, Net_inclusive, Tax and fee

*US and its territories include: USA, Puerto Rico, US Virgin Islands, Marshall Islands, American Samoa, Guam, Palau, Northern Mariana Islands, Federated States of Micronesia

Is there a Commission attribute in GetBookingDetails?

No, we don’t have commission attribute. The pricing structure is as stated in the answer above.

How do I create test bookings in Sandbox?

Test bookings can only be created in production environment on a test hotel assigned to you.

Making a test booking in Production, do I have to use real credit card?

Yes, however, please follow below steps to avoid charges made on your credit card.

Can a booking have multiple room types?

We do not allow booking with different room types, but only same room type with multiple room count.

Does Agoda have an endpoint to pull all future bookings?

We do not have such endpoint. However, you can use GetBookingList request which can look back booking creation date 90 days per request.

Why GetBookingDetails does not provide UPC card number?

For every property which has payment method set other than UPC, GetBookingDetails won't provided card number since there's no UPC generated for each booking. Property must log in to YCS and settle payment by themselves.


For example, property settles 10 bookings and a single UPC number will be generated to have the total amount of all 10 bookings.


If your property has payment method = "UPC" (not "UPC on ePass") but still cannot get card number from GetBookingDetails or would like to check on property payment method, please submit a request to agoda.chain.support@agoda.com with hotel ID and booking ID so that our support team can assist.

Why channel manager receives booking with status = 'AmendBooking' without recieving 'ConfirmBooking' status first?

It's because the booking is created, then later amended within a couple minutes of its creation (2-3 minutes) while the system is still processing the booking. Once the booking is completely processed to be available via API, the booking has already been amended.

Why customer email address and phone number is not provided in GetBookingDetails?

Customer email address (obfuscated format) and phone number would only be provided if the feature 'request customer info' is activated for the property in YCS. In case the feature is not activated, please advise the property to contact agoda.chain.support@agoda.com for further assistance.

Why booking price are lower than the price pushed by channel manager?

In many cases, the price is updated correctly, however, there are additional discount applied such as YCS promotion, channel discount, and etc.


If a booking has additional discount applied, GetBookingDetails response would have promotion_id / promotion_name (promotion discount) and/or channel_id with value other than = '1' (channel discount)

How do you acknowledge booking via API?

Booking acknowledgement is not yet supported via API, therefore, you would see acknowledge="0" when retrieving GetBookingList and GetBookingDetails.


In some cases where acknowledge="1", the acknowledgement is done via YCS or booking notification email sent to the property.

Product Management

How to identify child/linked rate plan in GetProduct?

Below is an example of GetProduct response to identify child rate plan and master rate plan.

If master_rate = 0, it's a master rate plan.

If master _rate = other rate plan ID, this means it's a child rate plan linked to that master ID.

Why does some channel_id not reflect in GetProduct response?

Only active and standalone channel_id will be returned in GetProduct response. Inactive and stackable channel_id (combination of 2 channels) will be omitted from GetProduct response.

After the certification, how can I connect a channel manager to a property on Agoda?

There are 2 options to connect a property to channel manager.