Departure Services

API Reference

View the Departure Services API reference →

Resources

• /trips
• /bookings/\{bookingId\}/trips

Methods

• GET
• POST
• PATCH

Summary of changes

Pagination has changed -> See request query parameter changes for details

Booked trips can be retrieved with or without a bookingId path parameter e.g. GET /bookings/{bookingId}/trips/{tripId} OR GET /bookings/trips/{tripId}. To retrieve a list of booked trips, a bookingId is mandatory.

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 trip booking resource, and their corresponding parameters in the Partner API.

Description	Public API	Partner API	Type	Notes
Departure Code — add a trip departure & room option	departureCode	departureCode	string	Sets roomOptionId for the departure. Cannot be updated.
Agent — set the agent on the booking	promotionCode	promotionCode	string	No change
Booking Notes — notes for support teams to action	href	id / status / singleSupplement	object	See customer status example below
Store Agent — set the store agent on the booking	externalReference	externalReference	string	No change, cannot be updated

Description	Public API	Partner API	Type	Notes
Departure Code Add* a specific trip departure & room option** to a booking*	departureCode	departureCode	string	Set the departureCode as the roomOptionId of the desired room within a departure. Cannot be updated.
Agent Set the agent on the booking	promotionCode	promotionCode	string	No change
Booking Notes Add any important notes to the booking that may need to be actioned by our support teams	href e.g. "href": "/bookings/{bookingId}/customers/{customerId}?status=tentative&singleSupplement=true"	id/status/singleSupplement	"customers": [ { "id": "string", "status": "tentative", "singleSupplement": true } ]
Store Agent Set the store agent on the booking	externalReference	externalReference	string	No change, cannot be updated

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 range	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
Booked trip* identifier*** *Unique identifier for this **trip on **a *booking	id	id	string
Trip booking resource link** *Direct API endpoint reference to this **trip *booking	href	href	string
Trip details Details of the trip* including its name, code, style and themes*	product.href tripCode tripName tripStyle tripThemes numberOfDays	product.href tripCode tripName tripStyle tripThemes numberOfDays*	string / integer* "tripThemes": [{"name": "Short Breaks"}]
Departure details *Details of the departure including its *code and status	departure.href departureCode departureStatus	departure.href departureCode departureStatus	string
Start date of the trip	startDate	startDate	string
End date of the trip	endDate	endDate
Start location details of the trip Full details of the starting location/address and finishing location/address	startLocation startLocationPhone startCity startCountry address	startLocation startLocationPhone startCity startCountry address	string
End location details of the trip** Full details of the starting location/address and finishing location/address	endLocation endLocationPhone endCity endCountry	endLocation endLocationPhone endCity endCountry	string
Currency of the trip on the booking Currency of the trip should match the* overall booking currency***	currency	currency	string
Prices *Full details of the total trip, single supplement prices and price after commission (e.g. net price) ***	totalSingleSupplementPrice totalPrice netPrice singleSupplementNetPrice	totalSingleSupplementPrice totalPrice netPrice singleSupplementNetPrice	decimals
Booking requirements for the trip Indicates whether passport details are* required before customer departs***	passportRequiredTypeId passportRequiredType	passportRequiredTypeId* passportRequiredType	string / integer*
Kitty and exclusions Prices for any kitty and exclusions that need to be paid by the customer on the trip**	kitty exclusions	kitty exclusions	{ "exclusions": [ { "elementTitle": "string", "prices": [ { "amount": 100, "currencyCode": "aud", "currencyId": 12345, "currencySymbol": "$" } ] } ], "kitty": { "prices": [ { "base": 350, "currency": "USD", "discounts": [ { "description": "string", "id": "string", "name": "string", "percentage": 10 } ], "minDeposit": 100, "total": 315 } ] } }
Booked accommodations List of accommodations that are on this booking**	accommodations	accommodations	"accommodations": [{"href": "/bookings/12345/accommodations/12345"}]
Booked transfers List of transfers that are on this booking	transfers	transfers	"transfers": [{"href": "/bookings/12345/transfers/12345"}]
Booked customers List of customers that are on this booking and their status (e.g. confirmed, cancelled)	customers customerStatuses singleSupplementCustomers customerStatusIds	customers customerStatuses singleSupplementCustomers customerStatusIds	{ "customerStatusIds": [ { "customers": [ { "href": "/bookings/:bookingId/customers/:customerId", "optionExpiresAt": "string" } ], "status": "confirmed" } ], "customerStatuses": { "cancelled": 0, "confirmed": 1, "quote": 1 }, "customers": { "href": "/bookings/12345/customers" }, "singleSupplementCustomers": [ { "href": "/bookings/12345/customers" } ] }

Current request (deprecated)

In the legacy Public API booked trips/departures were embedded inline on the booking; there was no dedicated resource.

Updated request

Booked departures are now a distinct sub-resource with their own pricing, discounts, and cancellation-fee attribution.

GET https://api.partners.intrepidtravel.cloud/bookings/{bookingId}/departure-services

{
"id": "svc_1234",
"href": "/departure-services/svc_1234",
"type": "DEPARTURE",
"status": "Confirmed",
"booking": { "id": "booking_1234", "href": "/bookings/booking_1234" },
"customers": ["cust_001", "cust_002"],
"pricingSummary": {
"currency": "USD",
"amountBase": 1000,
"amountDiscounted": 100,
"amountTotal": 900,
"amountPaid": 900,
"amountOwing": 0
},
"cancellationPolicyRule": {
"id": "rule_1234",
"href": "/cancellation-policies/5678/rules/rule_1234"
}
}

Removed fields

Removed Fields	Public API	Notes	Relevant Field (if applicable)
Removed	flights
Removed	insurance
Removed	sequence
Removed	externalReference
Removed	productId
Removed	sharesTripNotesId