Bookings
Bookings
Resources
/bookings
Methods
-
GET -
POST -
PATCH
Summary of changes
Pagination has changed -> See request query parameter changes for details
Several field names have been updated. See response changes for a list of fields and their counterparts in the GET /bookings endpoint of the Partner API
Several fields have been removed from the GET /bookings response. See removed fields section for full details.
Request body changes
Lists all request body parameters that can be set on a POST or PATCH to the booking resource, and their corresponding parameters in the Partner API.
| Description | Public API | Partner API | Type | Notes |
|---|---|---|---|---|
| Currency** Set the currency of the booking | currency | currency | string | No change, cannot be updated |
| Agent Set the agent on the booking | agentReferenceNumber | agentReferenceNumber | string | No change |
| Booking Notes Add any important notes to the booking that may need to be actioned* by our support teams* | bookingNote | bookingNote | string | No change, cannot be updated |
| Store Agent Set the store agent on the booking | storeAgentCode storeAgentEmail | storeAgentCode storeAgentEmail | string | No change, cannot be updated |
| Consultant Name Set* *the consultant on the booking | travelConsultantFirstName travelConsultantSurname | travelConsultantFirstName travelConsultantSurname | string | No change, cannot be updated |
| Payment due date Set the payment due date on the booking | fullPaymentDueDate | n/a | string | No longer supported |
Request query parameter changes
Lists all fields present in the Public API that have a corresponding field in the Partner API.
| Description | Public API | Partner API | Type | Notes |
|---|---|---|---|---|
| Consultant Name Retrieve bookings with a specific consultant | consultantFirstName consultantLastName | consultantFirstName consultantLastName | string | No change |
| Customer Name Retrieve bookings for a specific customer | customerFirstName customerLastName | customerFirstName customerLastName | string | No change |
| Date of booking Retrieve bookings in a specific date rang**e | dateOfBookingStar dateOfBookingEnd | dateOfBookingStart dateOfBookingEnd | string | No change |
| Date of first travel *Retrieve bookings *in a specific travel date range | dateOfFirstTravelStart dateOfFirstTravelEnd | dateOfFirstTravelStart dateOfFirstTravelEnd | string | No change |
| Outstanding balance due date Retrieve bookings with outstanding balance | outstandingBalanceDueStart outstandingBalanceDueEnd | outstandingBalanceDueStart outstandingBalanceDueEnd | string | No change |
| Pagination | limit start | size page | integer | Page query param effectively replaces starting record (start) used in public API |
Response Changes
| Description | Public API | Partner API | Type |
|---|---|---|---|
| Booking identifier Unique identifier for this booking | id | id | string |
| Booking resource link Direct API endpoint reference to this booking | href | href | string |
| Booking completion status Indicates whether the booking is complete, incomplete, or cancelled | status | status | string |
| Customer's email address Used for communication and booking confirmation | emailAddress | emailAddress | string |
| Currency code Indicates the currency used for all monetary amounts in the booking | currency | currency | string |
| Deposit amount required The initial payment amount that must be paid to secure the booking | depositAmount | depositAmount | integer |
| Deposit payment deadline The date by which the deposit must be paid | depositDueDate | depositDueDate | string |
| Commission amount The commission earned on this booking | commission | commission | integer |
| Total original price The initial total amount before any discounts or adjustments | totalOriginalAmount | totalOriginalAmount | integer |
| Total gross amount The total amount before fees and after discounts | totalGrossAmount | totalGrossAmount | integer |
| Total net amount The final total amount after all discounts and fees | totalNetAmount | totalNetAmount | integer |
| Remaining balance due The amount still owed on the booking | outstandingBalance | outstandingBalance | integer |
| Gross balance remaining The outstanding balance before additional adjustments | grossOutstandingBalance | grossOutstandingBalance | integer |
| Net balance remaining The outstanding balance after all adjustments | netOutstandingBalance | netOutstandingBalance | integer |
| Amount already paid The total payments received to date | amountPaid | amountPaid | integer |
| Total discount applied The sum of all discounts applied to the booking | totalDiscountAmount | totalDiscountAmount | integer |
| Total fees charged The sum of all fees added to the booking | totalFeeAmount | totalFeeAmount | integer |
| Final payment deadline The date by which the outstanding balance must be paid | outstandingBalanceDueDate | outstandingBalanceDueDate | string |
| First travel date The date when travel begins for this booking | dateOfFirstTravel | dateOfFirstTravel | string |
| Customer details link Reference to retrieve customer information for this booking | customers | customers | "customers": { "href": "/bookings/12345/customers" } |
| Trip details link Reference to retrieve trip information for this booking | trips | trips | "trips": { "href": "/bookings/12345/trips" } |
| Accommodation details link Reference to retrieve accommodation information for this booking | accommodations | accommodations | "accommodations": { "href": "/bookings/12345/accommodations" } |
| Transfer details link Reference to retrieve transfer/transportation information for this booking | transfers | transfers | "transfers": { "href": "/bookings/12345/transfers" } |
| Activity details link Reference to retrieve activity information for this booking | sightseeing | activities | "activities": { "href": "/bookings/12345/activities" } |
| Additional services link Reference to retrieve additional services information for this booking | additionalServices | additionalServices | "additionalServices": { "href": "/bookings/12345/additional-services" } |
| Lead passenger name The name of the primary traveler on the booking | leadPaxName | leadPaxName | string |
| Travel consultant full name The name of the consultant who created/manages the booking | travelConsultantName | travelConsultantName | string |
| Last travel date The date when travel ends for this booking | lastTravelDate | lastTravelDate | string |
| Number of passengers The total count of travelers on this booking | paxCount | paxCount | integer |
| Last modification date The date and time when the booking was last updated | lastUpdatedDate | lastUpdatedDate | datetime |
| Consultant first name The first name of the travel consultant | travelConsultantFirstName | travelConsultantFirstName | string |
| Consultant surname The last name of the travel consultant | travelConsultantSurname | travelConsultantSurname | string |
| Buying agent name The name of the agency that purchased/booked the travel | buyingAgentName | buyingAgentName | string |
| Store agent name The name of the specific store/location that made the booking | storeAgentName | storeAgentName | string |
| Agent reference number Internal reference number used by the agent for tracking | agentReferenceNumber | agentReferenceNumber | string |
| Group payment indicator Indicates whether this booking uses group payment arrangements | groupPaymentFlag | groupPaymentFlag | boolean |
| Creation date The date and time when the booking was originally created | createdDate | createdDate | datetime |
Current request (deprecated)
The legacy Public API returned bookings with flat customer, phone, and pricing structures — see the response changes table for field mappings.
GET https://api.intrepidtravel.com/v2/bookings/{bookingId}
{
"bookingId": "B123456",
"status": "Confirmed",
"travelConsultantFirstName": "Phil",
"travelConsultantSurname": "Maye",
"customer": {
"firstName": "John",
"surname": "Smith",
"homePhone": "0115487956",
"mobilePhone": "0435485548"
},
"currency": "AUD",
"amountTotal": 2495,
"amountPaid": 500,
"amountOwing": 1995,
"fullPaymentDueDate": "2027-03-01",
"agentReferenceNumber": "23424855"
}
Updated request
The Partner API returns a normalised booking with linked customers, agent, payment model, and multiple phone/emergency-contact arrays.
GET https://api.partners.intrepidtravel.cloud/bookings/{bookingId}
{
"id": "6792405",
"href": "/bookings/6792405",
"status": "incomplete",
"emailAddress": "Starship.technician\@intrepidtravel.com",
"currency": "gbp",
"depositAmount": 0,
"depositDueDate": "2026-06-05",
"commission": 0,
"totalGrossAmount": 0,
"totalNetAmount": 0,
"outstandingBalance": 0,
"grossOutstandingBalance": 0,
"netOutstandingBalance": 0,
"amountPaid": 0,
"outstandingBalanceDueDate": "2026-06-05",
"dateOfFirstTravel": "2026-07-31",
"customers": {
"href": "/bookings/6792405/customers"
},
"trips": {
"href": "/bookings/6792405/trips"
},
"leadPaxName": "Orion Anderson",
"travelConsultantName": "PEAK TEST agent - Multi Currency API Booking",
"paxCount": 1,
"lastUpdatedDate": "2025-12-23T03:50:11",
"travelConsultantFirstName": "PEAK TEST agent - Multi Currency",
"travelConsultantSurname": "API Booking",
"createdDate": "2025-12-17T03:15:07"
}
Removed fields
| Removed Fields | Public API | Notes | Relevant Field (if applicable) |
|---|---|---|---|
| Removed | invoices | See invoices | |
| Removed | payments | ||
| Removed | flights | ||
| Removed | Insurance | ||
| Removed | starshipItineraryNotesAvailable | ||
| Removed | starshipItineraryNotes65t | ||
| Removed | elementsItineraryNotesAvailable | ||
| Removed | elementsItineraryNotes | ||
| Removed | partnerId | ||
| Removed | partnerName | ||
| Removed | sequence | ||
| Removed | externalReference |