Product Addon Upgrade Guide
Modified on: 2024-04-22 16:24
TABLE OF CONTENTS
Introduction
GO Distributor can utilize the product addon functions to obtain details and real-time availability from hotel suppliers. These product add-ons can be packaged with rooms during the booking flow.
Version Requirement
| Version of GO | Version Requirement | Comments |
|---|---|---|
GO v3 Distributor | Implement GO v4.8 or above | / |
GO v4 Distributor | Upgrade to v4.8 or above | Following are APIs that need to be upgraded or implemented 1. Hotel Product API 2. Product Addon APIs (New) 3. Room Live Check API 4. Prebook API 5. Book API 6. Modify API(Optional) 7. Query Res Detail API(Optional) 8. ARI Push API(Push Model) |
Workflow & Interaction Diagram
- GO Distributors get product addon codes along with products via the Hotel API.
- GO Distributors get product addon details (including rates and restrictions) via the Product Addon API.
- GO Distributors get real-time availability from hotel suppliers via the Product Addon Availability API.
- GO Distributors final check product addon availability along with room via the Prebook API.
- GO Distributors make a reservation to book product addon along with room via the Book API.
- GO Distribturos modify product addon along with room via the Modify API.
- GO Distributors cancel product addon along with room via the Cancel API.
- GO Distributors get product addon details for a specific reservation via the Query Res API.
How does it work on GO v4.8?
APIs need to upgrade to v4.8 to support the Product Addon
- Hotel Product API
- Room Live Check API
- Prebook API
- Book API
- Modify API(Optional)
- Query Res Detail API(Optional)
Tips:The changed part has been marked as "Addon start here" and "Addon end"
1. Hotel Product API - Product add-on codes will be returned from the hotel product API
Response example:
{
"hotelId": "GATHI",
"hotelName": "This is a test hotel",
"supplierId": "HILTON",
"status": "Actived",
"chainCode": "Marriott",
"brandCode": "Waldorf",
"longitude": "41.40338",
"latitude": "2.17403",
"city": "string",
"country": "string",
"state": "string",
"address": [
"AddressLine1",
"AddressLine2",
"AddressLine3",
"AddressLine4",
"AddressLine5"
],
"phone": {
"countryAccessCode": "string",
"areaCityCode": "string",
"phoneNumber": "string"
},
"settings": {
"key1": "value1",
"key2": "value2"
},
"ariType": "Daily",
"timezone": "America/Los_Angeles",
"rateType": "AmountBeforeTax",
"maxChildAge": 17,
"childRateType": "ByAge",
"products": [
{
"roomId": "10000101",
"rateId": "123456",
"stayType": "OverNightRoom",
"status": "Actived",
"roomName": "Double Room",
"roomDescription": "Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.",
"rateName": "Bar Rate",
"rateDescription": "Begin your day with a hearty meal.",
"occupancy": {
"maxAdult": 3,
"maxChild": 2,
"maxOccupancy": 3
},
"paymentType": "PayNow",
"guarantee": {
"guaranteeType": "CCG"
},
"cancelPolicies": [
{
"dateRange": {
"startDate": "2018-01-01",
"endDate": "2018-01-04"
},
"cancelPolicy": {
"code": "AD100P_100P",
"description": "Non Refundable",
"cancelPenalties": [
{
"noShow": true,
"cancellable": true,
"cancelDeadline": {
"offsetTimeDropType": "BeforeArrival",
"offsetTimeUnit": "D",
"offsetTimeValue": 0,
"deadline": "string"
},
"penaltyCharge": {
"chargeBase": "FullStay",
"nights": 0,
"amount": 0,
"percent": 0
}
}
]
}
}
],
"fees": [
{
"dateRange": {
"startDate": "2018-01-01",
"endDate": "2018-01-04"
},
"fee": {
"name": "Service Charge",
"type": "Exclusive",
"amount": 10,
"amountType": "Percent",
"chargeType": "PerRoomPerNight",
"paymentType": "PayNow",
"effectivePerson": 0
}
}
],
//addon start here
"bookingChannels": [
"channel",
"channel"
],
"sourceMarkets": [
"region",
"region"
],
"productAddons": [
{
"type": "DisneyTicket",
"required": true,
"candidateCodes": [
"code",
"code"
]
}
]
//addon end
}
]
}2. Room Live Check API - Add a node named bookingChannel into the request
Request example:
{
"header": {
"supplierId": "HILTON",
"distributorId": "GTA",
"version": "v4",
"token": "18393849028490234"
},
"hotelId": "GATHI",
"stayRange": {
"checkin": "2018-01-01",
"checkout": "2018-01-04"
},
"roomCriteria": {
"roomCount": 2,
"adultCount": 1,
"childCount": 2,
"childAges": [
4,
8
]
},
"productCandidate": {
"roomId": "K1D",
"rateId": "ODAD01"
},
"iata": "string",
"loyaltyAccount": {
"programCode": "BW",
"accountId": "1234567890123457"
},
"corpAccount": {
"corpProgramCode": "CR",
"corpId": "A-1232"
},
"isAfterPromotion": false,
"promoteCode": "string",
//addon start here
"bookingChannel": "string",
//addon end here
"extensions": {
"key1": "value1",
"key2": "value2"
}
}3. Prebook API - The product addon will be along with room booking.
Notes: ① The rate of product addon is not included in the total rate of rooms. ② For Disney's room + ticket reservation, the number of tickets must be the same as the number of occupants, otherwise the order will not be successful. Besides, as for multiply tickets reservation, the admission date of each ticket should be the same. ③ For Disney’s reservation, it is recommended that the number of guest information be consistent with the number of occupants, and the age of the guests should be accurate, so that Disney can better serve guests.
Request example:
{
"header": {
"supplierId": "HILTON",
"distributorId": "GTA",
"version": "v4",
"token": "18393849028490234"
},
"reservationIds": {
"distributorResId": "C2084DFL0",
"derbyResId": "D15F893D34DF",
"supplierResId": "89389494"
},
"iata": "string",
"hotelId": "GATHI",
"stayRange": {
"checkin": "2018-01-01",
"checkout": "2018-01-04"
},
"contactPerson": {
"firstName": "James",
"lastName": "Bond",
"email": "007@james.com",
"phone": "string",
"address": "string"
},
"roomCriteria": {
"roomCount": 2,
"adultCount": 1,
"childCount": 2,
"childAges": [
4,
8
]
},
"total": {
"amountBeforeTax": 640,
"amountAfterTax": 700
},
"payment": {
"cardCode": "VI",
"cardNumber": "4111111111111111",
"cardHolderName": "Sherlock Holmes",
"expireDate": "0124",
"securityCode": "123"
},
"loyaltyAccount": {
"programCode": "BW",
"accountId": "1234567890123457"
},
"corpAccount": {
"corpProgramCode": "CR",
"corpId": "A-1232"
},
"promoteCode": "string",
"guests": [
{
"firstName": "James",
"lastName": "Bond",
"email": "007@james.com",
"phone": "string",
"address": "string",
"age": 0,
"gender": "Male",
"birthday": "2018-01-01",
"type": "Adult",
"index": 1
}
],
"comments": [
"no smoking",
"high floor"
],
"roomRates": [
{
"roomId": "K1D",
"rateId": "ODAD01",
"currency": "USD",
"amountBeforeTax": [
100,
100,
120
],
"amountAfterTax": [
110,
110,
130
],
"mealPlan": "RO",
"paymentType": "PayNow",
"guarantee": {
"guaranteeType": "CCG"
},
"fees": [
{
"dateRange": {
"startDate": "2018-01-01",
"endDate": "2018-01-04"
},
"fee": {
"name": "Service Charge",
"type": "Exclusive",
"amount": 10,
"amountType": "Percent",
"chargeType": "PerRoomPerNight",
"paymentType": "PayNow",
"effectivePerson": 0
}
}
],
"cancelPolicy": {
"code": "AD100P_100P",
"description": "Non Refundable",
"cancelPenalties": [
{
"noShow": true,
"cancellable": true,
"cancelDeadline": {
"offsetTimeDropType": "BeforeArrival",
"offsetTimeUnit": "D",
"offsetTimeValue": 0,
"deadline": "string"
},
"penaltyCharge": {
"chargeBase": "FullStay",
"nights": 0,
"amount": 0,
"percent": 0
}
}
]
}
}
],
//addon start here
"bookingChannel": "string",
"productAddons": [
{
"type": "DisneyTicket",
"code": "code",
"date": "2018-01-01",
"quantity": 1,
"officeId": "string",
"rate": {
"ageQualifyingType": {
"type": "Adult",
"minAge": 18,
"maxAge": 99
},
"currency": "USD",
"amountBeforeTax": 123.23,
"amountAfterTax": 134.34
}
}
],
//addon end
"extensions": {
"key1": "value1",
"key2": "value2"
}
}4. Book API - The product addon will be along with room booking.
Notes: ① The rate of product addon is not included in the total rate of rooms. ② For Disney's room + ticket reservation, the number of tickets must be the same as the number of occupants, otherwise the order will not be successful. Besides, as for multiply tickets reservation, the admission date of each ticket should be the same. ③ For Disney’s reservation, it is recommended that the number of guests should be consistent with the number of occupants, and the age of the guests should be accurate, so that Disney can better serve guests.
Request example:
{
"header": {
"supplierId": "HILTON",
"distributorId": "GTA",
"version": "v4",
"token": "18393849028490234"
},
"reservationIds": {
"distributorResId": "C2084DFL0",
"derbyResId": "D15F893D34DF",
"supplierResId": "89389494"
},
"iata": "string",
"hotelId": "GATHI",
"stayRange": {
"checkin": "2018-01-01",
"checkout": "2018-01-04"
},
"contactPerson": {
"firstName": "James",
"lastName": "Bond",
"email": "007@james.com",
"phone": "string",
"address": "string"
},
"roomCriteria": {
"roomCount": 2,
"adultCount": 1,
"childCount": 2,
"childAges": [
4,
8
]
},
"total": {
"amountBeforeTax": 640,
"amountAfterTax": 700
},
"payment": {
"cardCode": "VI",
"cardNumber": "4111111111111111",
"cardHolderName": "Sherlock Holmes",
"expireDate": "0124",
"securityCode": "123"
},
"loyaltyAccount": {
"programCode": "BW",
"accountId": "1234567890123457"
},
"corpAccount": {
"corpProgramCode": "CR",
"corpId": "A-1232"
},
"promoteCode": "string",
"guests": [
{
"firstName": "James",
"lastName": "Bond",
"email": "007@james.com",
"phone": "string",
"address": "string",
"age": 0,
"gender": "Male",
"birthday": "2018-01-01",
"type": "Adult",
"index": 1
}
],
"comments": [
"no smoking",
"high floor"
],
"roomRates": [
{
"roomId": "K1D",
"rateId": "ODAD01",
"currency": "USD",
"amountBeforeTax": [
100,
100,
120
],
"amountAfterTax": [
110,
110,
130
],
"mealPlan": "RO",
"paymentType": "PayNow",
"guarantee": {
"guaranteeType": "CCG"
},
"fees": [
{
"dateRange": {
"startDate": "2018-01-01",
"endDate": "2018-01-04"
},
"fee": {
"name": "Service Charge",
"type": "Exclusive",
"amount": 10,
"amountType": "Percent",
"chargeType": "PerRoomPerNight",
"paymentType": "PayNow",
"effectivePerson": 0
}
}
],
"cancelPolicy": {
"code": "AD100P_100P",
"description": "Non Refundable",
"cancelPenalties": [
{
"noShow": true,
"cancellable": true,
"cancelDeadline": {
"offsetTimeDropType": "BeforeArrival",
"offsetTimeUnit": "D",
"offsetTimeValue": 0,
"deadline": "string"
},
"penaltyCharge": {
"chargeBase": "FullStay",
"nights": 0,
"amount": 0,
"percent": 0
}
}
]
}
}
],
//addon start here
"bookingChannel": "string",
"productAddons": [
{
"type": "DisneyTicket",
"code": "code",
"date": "2018-01-01",
"quantity": 1,
"officeId": "string",
"rate": {
"ageQualifyingType": {
"type": "Adult",
"minAge": 18,
"maxAge": 99
},
"currency": "USD",
"amountBeforeTax": 123.23,
"amountAfterTax": 134.34
}
}
],
//addon end
"threeDomainSecurity": {
"cavv": "string",
"eci": "string",
"xid": "string",
"threeDomainSecurityVersion": "string",
"transactionId": "string",
"merchantName": "string",
"extensions": {
"key1": "value1",
"key2": "value2"
}
},
"bookingToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"extensions": {
"key1": "value1",
"key2": "value2"
}
}5. Modify API - The product addon will be along with the room reservation.
Notes: As for modifying Disney reservation, please do not change the first guest information of each room, otherwise the reservation will not be modified successfully.
Request example:
{
"header": {
"supplierId": "HILTON",
"distributorId": "GTA",
"version": "v4",
"token": "18393849028490234"
},
"reservationIds": {
"distributorResId": "C2084DFL0",
"derbyResId": "D15F893D34DF",
"supplierResId": "89389494"
},
"iata": "string",
"hotelId": "GATHI",
"stayRange": {
"checkin": "2018-01-01",
"checkout": "2018-01-04"
},
"contactPerson": {
"firstName": "James",
"lastName": "Bond",
"email": "007@james.com",
"phone": "string",
"address": "string"
},
"roomCriteria": {
"roomCount": 2,
"adultCount": 1,
"childCount": 2,
"childAges": [
4,
8
]
},
"total": {
"amountBeforeTax": 640,
"amountAfterTax": 700
},
"payment": {
"cardCode": "VI",
"cardNumber": "4111111111111111",
"cardHolderName": "Sherlock Holmes",
"expireDate": "0124",
"securityCode": "123"
},
"loyaltyAccount": {
"programCode": "BW",
"accountId": "1234567890123457"
},
"corpAccount": {
"corpProgramCode": "CR",
"corpId": "A-1232"
},
"promoteCode": "string",
"guests": [
{
"firstName": "James",
"lastName": "Bond",
"email": "007@james.com",
"phone": "string",
"address": "string",
"age": 0,
"gender": "Male",
"birthday": "2018-01-01",
"type": "Adult",
"index": 1
}
],
"comments": [
"no smoking",
"high floor"
],
"roomRates": [
{
"roomId": "K1D",
"rateId": "ODAD01",
"currency": "USD",
"amountBeforeTax": [
100,
100,
120
],
"amountAfterTax": [
110,
110,
130
],
"mealPlan": "RO",
"paymentType": "PayNow",
"guarantee": {
"guaranteeType": "CCG"
},
"fees": [
{
"dateRange": {
"startDate": "2018-01-01",
"endDate": "2018-01-04"
},
"fee": {
"name": "Service Charge",
"type": "Exclusive",
"amount": 10,
"amountType": "Percent",
"chargeType": "PerRoomPerNight",
"paymentType": "PayNow",
"effectivePerson": 0
}
}
],
"cancelPolicy": {
"code": "AD100P_100P",
"description": "Non Refundable",
"cancelPenalties": [
{
"noShow": true,
"cancellable": true,
"cancelDeadline": {
"offsetTimeDropType": "BeforeArrival",
"offsetTimeUnit": "D",
"offsetTimeValue": 0,
"deadline": "string"
},
"penaltyCharge": {
"chargeBase": "FullStay",
"nights": 0,
"amount": 0,
"percent": 0
}
}
]
}
}
],
//addon start here
"bookingChannel": "string",
"productAddons": [
{
"type": "DisneyTicket",
"code": "code",
"date": "2018-01-01",
"quantity": 1,
"officeId": "string",
"rate": {
"ageQualifyingType": {
"type": "Adult",
"minAge": 18,
"maxAge": 99
},
"currency": "USD",
"amountBeforeTax": 123.23,
"amountAfterTax": 134.34
}
}
],
//addon end
"extensions": {
"key1": "value1",
"key2": "value2"
}
}6. Query Res Detail API - Product addon detail will be returned via query res detail API.
Response example:
{
"header": {
"supplierId": "HILTON",
"distributorId": "GTA",
"version": "v4",
"token": "18393849028490234"
},
"reservations": [
{
"reservationIds": {
"distributorResId": "C2084DFL0",
"derbyResId": "D15F893D34DF",
"supplierResId": "89389494"
},
"iata": "string",
"hotelId": "GATHI",
"stayRange": {
"checkin": "2018-01-01",
"checkout": "2018-01-04"
},
"roomCriteria": {
"roomCount": 2,
"adultCount": 1,
"childCount": 2,
"childAges": [
4,
8
]
},
"total": {
"amountBeforeTax": 640,
"amountAfterTax": 700
},
"loyaltyAccount": {
"programCode": "BW",
"accountId": "1234567890123457"
},
"corpAccount": {
"corpProgramCode": "CR",
"corpId": "A-1232"
},
"promoteCode": "string",
"comments": [
"no smoking",
"high floor"
],
"roomRates": [
{
"roomId": "K1D",
"rateId": "ODAD01",
"currency": "USD",
"amountBeforeTax": [
100,
100,
120
],
"amountAfterTax": [
110,
110,
130
],
"mealPlan": "RO",
"paymentType": "PayNow",
"guarantee": {
"guaranteeType": "CCG"
},
"fees": [
{
"dateRange": {
"startDate": "2018-01-01",
"endDate": "2018-01-04"
},
"fee": {
"name": "Service Charge",
"type": "Exclusive",
"amount": 10,
"amountType": "Percent",
"chargeType": "PerRoomPerNight",
"paymentType": "PayNow",
"effectivePerson": 0
}
}
],
"cancelPolicy": {
"code": "AD100P_100P",
"description": "Non Refundable",
"cancelPenalties": [
{
"noShow": true,
"cancellable": true,
"cancelDeadline": {
"offsetTimeDropType": "BeforeArrival",
"offsetTimeUnit": "D",
"offsetTimeValue": 0,
"deadline": "string"
},
"penaltyCharge": {
"chargeBase": "FullStay",
"nights": 0,
"amount": 0,
"percent": 0
}
}
]
}
}
],
//addon start here
"bookingChannel": "string",
"productAddons": [
{
"type": "Disney Ticket",
"code": "code",
"date": "2018-01-01",
"quantity": 1,
"officeId": "string",
"rate": {
"ageQualifyingType": {
"type": "Adult",
"minAge": 18,
"maxAge": 99
},
"currency": "USD",
"amountBeforeTax": 123.23,
"amountAfterTax": 134.34
}
}
],
//addon end
"status": "Confirmed",
"cancellationId": "C89389494",
"result": "Successful",
"failCause": {
"errorCode": "string",
"supplierErrorCode": "string",
"errorMessage": "string"
}
}
]
}7. Product Addon APIs - There are brand-new APIs added, Please refer to Develop Guide
8. ARI Push API - GO Distributor Pull Model can skip this point.
Notes: ① For Disney connection, please ensure the below 2 features are implemented. 1. FPLOS Restriction 2. Extra Child Rate
Request example:
{
"header": {
"supplierId": "HILTON",
"distributorId": "GTA",
"version": "v4",
"token": "18393849028490234"
},
"messageType": "Delta",
"hotelId": "GATHI",
"dateRange": {
"startDate": "2018-01-01",
"endDate": "2018-01-04"
},
"currency": "USD",
"dailyAris": [
{
"roomId": "K1",
"rateId": "BARB",
"mealPlans": [
"BB",
"BB",
"BB",
"BB"
],
"inventories": [
9,
0,
9,
9
],
"rates": {
// extra child rates
"extraChildRates": [
{
"amountAfterTax": [
50.00,
50.00,
50.00,
50.00
],
"amountBeforeTax": [
40.00,
40.00,
40.00,
40.00
],
"maxAge": "2",
"minAge": "0"
},
{
"amountAfterTax": [
60.00,
60.00,
60.00,
60.00
],
"amountBeforeTax": [
50.00,
50.00,
50.00,
50.00
],
"maxAge": "8",
"minAge": "3"
},
{
"amountAfterTax": [
70.00,
70.00,
70.00,
70.00
],
"amountBeforeTax": [
60.00,
60.00,
60.00,
60.00
],
"maxAge": "17",
"minAge": "9"
}
],
"type": "OccupancyRate",
"rates": [
{
"adultCount": 1,
"amountBeforeTax": [
502.19,
502.19,
502.19,
502.19
],
"amountAfterTax": [
623.23,
623.23,
623.23,
623.23
]
},
{
"adultCount": 2,
"amountBeforeTax": [
520.19,
520.19,
520.19,
520.19
],
"amountAfterTax": [
641.23,
641.23,
641.23,
641.23
]
}
]
},
"availStatuses": {
"close": [
false,
false,
false,
false
],
"minStayArrival": [
0,
2,
0,
0
],
"maxStayArrival": [
0,
2,
0,
0
],
"minStayThrough": [
0,
2,
0,
0
],
"maxStayThrough": [
0,
2,
0,
0
],
"minAdvanceDay": [
0,
2,
0,
0
],
"maxAdvanceDay": [
365,
365,
365,
365
],
"cta": [
false,
false,
false,
true
],
"ctd": [
false,
false,
false,
true
],
// fplos restriction
"fplos": [
"1111111",
"1001111",
"1000001",
"0000000"
]
},
"rateChangeIndicators": [
true,
false,
true,
false
]
}
]
}Notes
GO generally distributes the meal plan provided by Disney. In cases where no meal plan is provided, GO will provide RO(Room Only) by default to channels. Following are the current meal plans available by Disney.
| Meal Plan Code | Meal Plan Description |
| QS | Disney Quick Service Dining Plan |
| DP | Disney Dining Plan |
| DPP | Disney Dining Plan Plus |
| XD | Disney Deluxe Dining Plan |
| QSM | Disney Quick Service Meal |
Please refer to Disney’s dining plans or Appendix: Meal Plan for more information.
Did you find it helpful? Yes No
Send feedbackSorry we couldn't be helpful. Help us improve this article with your feedback.