On this page:
Overview
You can supply TRIPS information under the basket root element including details of the following services:
- Airlines
- Car rental
- Cruises
- Hotels
- Tours
The information will be sent in the daily settlement file.
XML Tags
Node/Element |
Description |
Mandatory |
Format and Valid Characters |
Max Length |
Allowed Values |
---|---|---|---|---|---|
basket |
The root element for all other basket elements. |
No |
Node |
|
|
hotel |
Used to provide hotel information for settlement. There can be only one hotel element. |
No |
|
|
|
checkIn |
Hotel check in date. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
checkOut |
Hotel check out date. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
numberInparty |
Number of people in the hotel booking. |
Yes |
Digits |
3 |
|
folioRefNumber |
Hotel folio reference number. |
No |
Digits, plus, and spaces |
10 |
|
confirmedReservation |
Set this flag to Y when a guest has confirmed their reservation.
|
No |
Capital letters |
|
|
dailyRoomRate |
Hotel daily room rate. |
Yes |
Letters, digits, periods, and spaces |
15 |
|
guestName |
Name of guest |
Yes |
Letters, digits, periods, and spaces |
20 |
|
cruise |
Used to provide cruise information for settlement. There can be only one cruise element. |
No |
|
|
|
checkIn |
Cruise start date. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
checkOut |
Cruise end date. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
carRental |
Used to provide car rental information for settlement. There can be only one car rental element. |
No |
|
|
|
checkIn |
Car rental check in date. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
checkOut |
Car rental check out date. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
tourOperator |
Used to provide tour operator information for settlement. There can be only one tour operator element. |
No |
|
|
|
checkIn |
Tour check in date for tour operator. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
checkOut |
Tour check out date for tour operator. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
airline |
Used to provide airline information for settlement. There can be only one airline element |
No |
|
|
|
ticketNumber |
Airline ticket number |
Yes |
Letters and digits |
11 |
|
airlineCode |
IATA airline code |
Yes |
Digits |
3 |
|
agentCode |
IATA agent code |
Yes |
Digits |
8 |
|
agentName |
Agency name |
Yes |
Letters and digits |
26 chars |
|
flightNumber |
Flight number |
No |
Letters and digits |
6 chars |
|
restrictedTicket |
Can be
|
Yes |
BOOLEAN |
|
|
passengerName |
Name of passenger |
Yes |
Letters, digits, and spaces |
29 |
|
orginatingAirport |
IATA airport code |
Yes |
Letters |
3 |
|
segment |
Contains other elements detailing the segment. At least one segment element must be supplied under the airline element, and up to 4 segments. |
Yes |
|
|
|
carrierCode |
IATA carrier code |
Yes |
Letters |
3 |
|
class |
Class of service |
Yes |
Letters and digits |
3 |
|
stopover |
Indicates when a stopover is included. Can be
|
Yes |
BOOLEAN |
|
|
legDepartureDate |
Departure date of the segment. |
Yes |
Digits and hyphens |
10 |
Date as YYYY-MM-DD |
destination |
IATA airport code of destination |
Yes |
Letters |
3 |
|
fareBasis |
Fare basis code |
No |
Letters and digits |
6 |
|
customerCode |
Airline customer code |
No |
Letters and digits |
20 |
|
invoiceNumber |
Airline Invoice Number |
No |
Letters and digits |
15 |
|
dinerCustomerRef |
Diners customer reference. Can include up to 5 elements |
No |
Letters and digits |
15 |
|
Examples
An example of Basket XML for tour operators:
<basket> <agentId>johnsmith</agentId> <item> <description>Tour</description> <productSku>TIMESKU</productSku> <productCode>1234567</productCode> <quantity>1</quantity> <unitNetAmount>90.00</unitNetAmount> <unitTaxAmount>5.00</unitTaxAmount> <unitGrossAmount>95.00</unitGrossAmount> <totalGrossAmount>95.00</totalGrossAmount> <recipientFName>firstname</recipientFName> <recipientLName>lastname</recipientLName> <recipientMName>M</recipientMName> <recipientSal>MR</recipientSal> <recipientEmail>firstname.lastname @test.com</recipientEmail> <recipientPhone>1234567890</recipientPhone> <recipientAdd1>add1</recipientAdd1> <recipientAdd2>add2</recipientAdd2> <recipientCity>city</recipientCity> <recipientState>CA</recipientState> <recipientCountry>GB</recipientCountry> <recipientPostCode>ha412t</recipientPostCode> <itemShipNo>1123</itemShipNo> <itemGiftMsg>Birthday tour</itemGiftMsg> </item> <deliveryNetAmount>5.00</deliveryNetAmount> <deliveryTaxAmount>0.00</deliveryTaxAmount> <deliveryGrossAmount>5.00</deliveryGrossAmount> <discounts> <discount> <fixed>5</fixed> <description>Save 5 pounds</description> </discount> <discount> <fixed>1</fixed> <description>Spend 5 pounds and save 1 pound</description> </discount> </discounts> <shipId>SHIP00002</shipId> <shippingMethod>N</shippingMethod> <shippingFaxNo>1234567890</shippingFaxNo> <tourOperator> <checkIn>2012-10-12</checkIn> <checkOut>2012-10-29</checkOut> </tourOperator> </basket>
An example of Basket XML for Car Rental:
<basket> <agentId>johnsmith</agentId> <item> <description>Rent-a-car</description> <productSku>TIMESKU</productSku> <productCode>1234567</productCode> <quantity>1</quantity> <unitNetAmount>90.00</unitNetAmount> <unitTaxAmount>5.00</unitTaxAmount> <unitGrossAmount>95.00</unitGrossAmount> <totalGrossAmount>95.00</totalGrossAmount> <recipientFName>firstname</recipientFName> <recipientLName>lastname</recipientLName> <recipientMName>M</recipientMName> <recipientSal>MR</recipientSal> <recipientEmail>firstname.lastname @test.com</recipientEmail> <recipientPhone>1234567890</recipientPhone> <recipientAdd1>add1</recipientAdd1> <recipientAdd2>add2</recipientAdd2> <recipientCity>city</recipientCity> <recipientState>CA</recipientState> <recipientCountry>GB</recipientCountry> <recipientPostCode>ha412t</recipientPostCode> <itemShipNo>1123</itemShipNo> <itemGiftMsg>Have a car</itemGiftMsg> </item> <deliveryNetAmount>5.00</deliveryNetAmount> <deliveryTaxAmount>0.00</deliveryTaxAmount> <deliveryGrossAmount>5.00</deliveryGrossAmount> <discounts> <discount> <fixed>5</fixed> <description>Save 5 pounds</description> </discount> <discount> <fixed>1</fixed> <description>Spend 5 pounds and save 1 pound</description> </discount> </discounts> <shipId>SHIP00002</shipId> <shippingMethod>N</shippingMethod> <shippingFaxNo>1234567890</shippingFaxNo> <carRental> <checkIn>2012-10-12</checkIn> <checkOut>2012-10-29</checkOut> </carRental> </basket>
An example of Basket XML for Hotel Reservation:
<basket> <agentId>johnsmith</agentId> <item> <description>Hotel stay</description> <productSku>TIMESKU</productSku> <productCode>1234567</productCode> <quantity>1</quantity> <unitNetAmount>90.00</unitNetAmount> <unitTaxAmount>5.00</unitTaxAmount> <unitGrossAmount>95.00</unitGrossAmount> <totalGrossAmount>95.00</totalGrossAmount> <recipientFName>firstname</recipientFName> <recipientLName>lastname</recipientLName> <recipientMName>M</recipientMName> <recipientSal>MR</recipientSal> <recipientEmail>firstname.lastname @test.com</recipientEmail> <recipientPhone>1234567890</recipientPhone> <recipientAdd1>add1</recipientAdd1> <recipientAdd2>add2</recipientAdd2> <recipientCity>city</recipientCity> <recipientState>CA</recipientState> <recipientCountry>GB</recipientCountry> <recipientPostCode>ha412t</recipientPostCode> <itemShipNo>1123</itemShipNo> <itemGiftMsg>Happy Birthday</itemGiftMsg> </item> <deliveryNetAmount>5.00</deliveryNetAmount> <deliveryTaxAmount>0.00</deliveryTaxAmount> <deliveryGrossAmount>5.00</deliveryGrossAmount> <discounts> <discount> <fixed>5</fixed> <description>Save 5 pounds</description> </discount> <discount> <fixed>1</fixed> <description>Spend 5 pounds and save 1 pound</description> </discount> </discounts> <shipId>SHIP00002</shipId> <shippingMethod>N</shippingMethod> <shippingFaxNo>1234567890</shippingFaxNo> <hotel> <checkIn>2012-10-12</checkIn> <checkOut>2012-10-13</checkOut> <numberInParty>1</numberInParty> <guestName>Mr Smith</guestName> <folioRefNumber>A1000</folioRefNumber> <confirmedReservation>Y</confirmedReservation> <dailyRoomRate>150.00</dailyRoomRate> </hotel> </basket>
An example of Basket XML for a Cruise:
<basket> <agentId>johnsmith</agentId> <item> <description>Cruise</description> <productSku>TIMESKU</productSku> <productCode>1234567</productCode> <quantity>1</quantity> <unitNetAmount>90.00</unitNetAmount> <unitTaxAmount>5.00</unitTaxAmount> <unitGrossAmount>95.00</unitGrossAmount> <totalGrossAmount>95.00</totalGrossAmount> <recipientFName>firstname</recipientFName> <recipientLName>lastname</recipientLName> <recipientMName>M</recipientMName> <recipientSal>MR</recipientSal> <recipientEmail>firstname.lastname @test.com</recipientEmail> <recipientPhone>1234567890</recipientPhone> <recipientAdd1>add1</recipientAdd1> <recipientAdd2>add2</recipientAdd2> <recipientCity>city</recipientCity> <recipientState>CA</recipientState> <recipientCountry>GB</recipientCountry> <recipientPostCode>ha412t</recipientPostCode> <itemShipNo>1123</itemShipNo> <itemGiftMsg>Happy Birthday</itemGiftMsg> </item> <deliveryNetAmount>5.00</deliveryNetAmount> <deliveryTaxAmount>0.00</deliveryTaxAmount> <deliveryGrossAmount>5.00</deliveryGrossAmount> <shipId>SHIP00002</shipId> <shippingMethod>N</shippingMethod> <shippingFaxNo>1234567890</shippingFaxNo> <cruise> <checkIn>2012-10-12</checkIn> <checkOut>2012-10-29</checkOut> </cruise> </basket>
An example of Basket XML for an Airline:
<basket> <agentId>johnsmith</agentId> <item> <description>Air Ticket</description> <productSku>TIMESKU</productSku> <productCode>1234567</productCode> <quantity>1</quantity> <unitNetAmount>90.00</unitNetAmount> <unitTaxAmount>5.00</unitTaxAmount> <unitGrossAmount>95.00</unitGrossAmount> <totalGrossAmount>95.00</totalGrossAmount> <recipientFName>firstname</recipientFName> <recipientLName>lastname</recipientLName> <recipientMName>M</recipientMName> <recipientSal>MR</recipientSal> <recipientEmail>firstname.lastname @test.com</recipientEmail> <recipientPhone>1234567890</recipientPhone> <recipientAdd1>add1</recipientAdd1> <recipientAdd2>add2</recipientAdd2> <recipientCity>city</recipientCity> <recipientState>CA</recipientState> <recipientCountry>GB</recipientCountry> <recipientPostCode>ha412t</recipientPostCode> <itemShipNo>1123</itemShipNo> <itemGiftMsg>Happy Birthday</itemGiftMsg> </item> <deliveryNetAmount>5.00</deliveryNetAmount> <deliveryTaxAmount>0.00</deliveryTaxAmount> <deliveryGrossAmount>5.00</deliveryGrossAmount> <shipId>SHIP00002</shipId> <shippingMethod>N</shippingMethod> <shippingFaxNo>1234567890</shippingFaxNo> <airline> <ticketNumber>12345678901</ticketNumber> <airlineCode>123</airlineCode> <agentCode>12345678</agentCode> <agentName>26characterslong</agentName> <restrictedTicket>0</restrictedTicket> <passengerName>29characterslong</passengerName> <originatingAirport>BLR</originatingAirport> <segment> <carrierCode>ABC</carrierCode> <class>A01</class> <stopOver>1</stopOver> <legDepartureDate>2012-03-20</legDepartureDate> <destination>LHR</destination> <fareBasis>FARE12</fareBasis> </segment> <customerCode>20characterslong</customerCode> <flightNumber>BA0118</flightNumber> <invoiceNumber>123123123123123</invoiceNumber> </airline> </basket>
An example of Basket XML for a restaurant:
<basket> <agentId>johnsmith</agentId> <item> <description>Restaurant</description> <productSku>TIMESKU</productSku> <productCode>1234567</productCode> <quantity>1</quantity> <unitNetAmount>90.00</unitNetAmount> <unitTaxAmount>5.00</unitTaxAmount> <unitGrossAmount>95.00</unitGrossAmount> <totalGrossAmount>95.00</totalGrossAmount> <recipientFName>firstname</recipientFName> <recipientLName>lastname</recipientLName> <recipientMName>M</recipientMName> <recipientSal>MR</recipientSal> <recipientEmail>firstname.lastname @test.com</recipientEmail> <recipientPhone>1234567890</recipientPhone> <recipientAdd1>add1</recipientAdd1> <recipientAdd2>add2</recipientAdd2> <recipientCity>city</recipientCity> <recipientState>CA</recipientState> <recipientCountry>GB</recipientCountry> <recipientPostCode>ha412t</recipientPostCode> <itemShipNo>1123</itemShipNo> <itemGiftMsg>Happy Birthday</itemGiftMsg> </item> <deliveryNetAmount>5.00</deliveryNetAmount> <deliveryTaxAmount>0.00</deliveryTaxAmount> <deliveryGrossAmount>5.00</deliveryGrossAmount> <shipId>SHIP00002</shipId> <shippingMethod>N</shippingMethod> <shippingFaxNo>1234567890</shippingFaxNo> <dinerCustomerRef>123123123</dinerCustomerRef> </basket>
❮ Back to BasketXML Next: CustomerXML ❯