| (Basic information) |
| booking_id | Booking ID |
| channel_id | Channel ID |
| account_id | Account ID |
| channel_name | Company brand name, e.g. "Example Tours" |
| made_date_time | Date and time the booking was made, in the local time of the channel account. Format is YYYY-MM-DD HH:MM:SS (24 hr) |
| start_date | Date the booking starts, generally based on the local time of the item being booked. Format is YYYY-MM-DD |
| end_date | Date the booking ends, generally based on the local time of the item being booked. Format is YYYY-MM-DD |
| booking_name | Name for the booking (not the customer). Often this is the same as the main item being booked however it can be changed (for example on Tailor made / personalised bookings) |
| (Customer information) |
| lead_customer_id | ID number for the lead customer |
| lead_customer_name | Lead customer full name. Built from other name components |
| lead_customer_travelling | 1 if the lead customer is travelling on the booking, 0 if they aren't |
| customer_count | Number of customers on the booking. E.g. 2 |
| customers |
There will be a customers node containing...
| XML Node | Notes |
|---|
| customer |
... a customer node for each customer, contaiing:
| XML Node | Notes |
|---|
| customer_id | Internal ID |
| customer_name | E.g. "Mr Joe Bloggs" |
| If Permission Level 3 or above ? |
| gender | "m" if male, "f" if female, blank if unknown |
| dob | Date of birth YYYY-MM-DD |
| agecat | Age category - 1 digit code (i-Infant, c-Child, a-Adult, s-Senior). Based on age at end of booking |
| insurance_number | Travel insurance number |
| insurance_supplier_name | Travel insurance supplier |
| insurance_note | Travel insurance note |
| If API called by Tour Operator ? |
| insurance_supplier_id | Internal supplier ID number for the travel insurance |
|
|
| (Revenue and deposit information) |
| sale_currency | 3 digit sale currency, e.g. "USD" |
| sales_revenue | Amount of revenue (in the sale_currency but excluding any currenct information) |
| sales_revenue_display | Display version of the revenue, includes currency symbol where applicable (e.g. US$100.00) |
| deposit | Deposit amount for the booking, regardless of whether it has been paid e.g. 100 |
| deposit_display | Display version of the deposit, includes currency symbol where applicable e.g. US$100.00 |
| (Booking status information) |
| status | Status of the booking
0 - Quote
1 - Provisional
2 - Confirmed
3 - Confirmed & archived
NB: If cancel_reason reason is set then the booking may be cancelled, for example it's possible to have a "Provisional" booking that is cancelled. |
| status_text | Textual representation of the booking status.
E.g. "Confirmed (A)" |
| cancel_reason | If a booking is cancelled this field will indicate the reason, if a booking is not cancelled this will be 0.
0 - Not cancelled
1 - Cancelled by customer request, see notes
2 - Cancelled by customer request, booked another tour
3 - Cancelled by staff, see notes
4 - Cancelled by staff, boook another tour
5 - Cancelled by staff, payment not received
6 - Cancelled by staff, tour not reached min. numbers
7 - Cancelled by staff, booking made in error
8 - Cancelled by staff, capacity exceeded
9 - Cancelled by staff, operational reasons
10 - Cancelled by staff, booking reopened for editing
11 - Cancelled by staff, bad weather
20 - Cancelled by system, expired quotation
21 - Cancelled by system, expired provisional booking
22 - Cancelled by customer (via website)
23 - Cancelled by agent (via website) |
| cancel_text | Textual representation of the cancellation status.
E.g. "Not cancelled" |
| (Agent information) |
| commission | Amount of commission |
| commission_tax | Amount of commission tax |
| commission_currency | 3 digit commission currency, e.g. "USD" |
| commission_display | Display version of the commission, includes currency symbol where applicable (e.g. US$20.00) |
| commission_tax_display | Display version of the commission tax, includes currency symbol where applicable (e.g. US$2.50) |
| tracking_miscid | A numeric value that can be set on the tracked links to divide up online tracking into sections (e.g. specific online marketing campaigns) |
| agent_ref | Could be a booking reference for the booking in the agent's own system |
| (Payment summary) |
| payment_status | Numeric representation of the booking payment status.
0 - No payment
1 - Deposit paid
2 - Deposit paid #2
3 - Full balance paid
4 - Refunded |
| payment_status_text | Textual representation of the payment status.
E.g. "Full balance paid" |
| balance_owed_by | Either C if the balance is owed by the customer (e.g. affiliate type booking), or A if the balance is owed by the Agent |
| balance | Amount remaining to be paid on the booking (in the sale_currency) |
| balance_display | Display version of the amount remaining to be paid on the booking, includes currency symbol where applicable (e.g. US$200.00) |
| balance_due | When the remaining balance is due. YYYY-MM-DD |
| If Permission Level 3 or above ? |
| customer_special_request | Text containing any special requests the customer has made |
| customers_agecat_breakdown | E.g. "2 Adults" |
| payments |
If any payments have been made there will be a payments node containing the following child nodes.
| XML Node | Notes |
|---|
| payment |
There will be a payment node for each
| XML Node | Notes |
|---|
| payment_date_time | Date and Time for payment in the channel accounts local time. YYYY-MM-DD HH:MM:SS (24 Hr) |
| payment_value | Value of the payment, e.g. 100.00 |
| payment_currency | Currency of the payment, e.g. EUR |
| payment_value_display | Display version including currency symbol/code |
| payment_type | Free text
e.g. "Credit card" |
| payment_reference | Payment reference |
| payment_note | Payment note |
| paid_by | C if customer, A if agent |
| paid_by_id | Either a customer or agent ID |
|
|
| If API called by Tour Operator (not Marketplace Partner) ? |
| important_note | The staff entered "pinned note" on the booking |
| workflow_note | The staff entered note form the "workflow" tab on the booking |
| custom_fields |
If any custom fields are configured then a custom_fields node will be returned containing the following:.
| XML Node | Notes |
|---|
| field |
If any custom fields are configured then a custom_fields node will be returned containing the following:.
| XML Node | Notes |
|---|
| name | Custom field name E.g. PickupPoint |
| value | Value for the custom field E.g. Hilton Hotel |
|
|
