Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /v1/products/:productIdOrSlug/departures | List departures for a product with pagination |
| POST | /v1/departures | Create a departure instance for a product |
| GET | /v1/products/:productIdOrSlug/departures/:departureId | Retrieve a single departure |
| PATCH | /v1/departures/:id | Update departure timing, capacity, or metadata |
| DELETE | /v1/departures/:id | Remove a departure from a product |
| GET | /v1/products/:productIdOrSlug/departures/:departureId/itinerary | Load the pinned itinerary days (segments/options optional). Top-level form also available. |
| POST | /v1/departures/:id/price | Calculate net/gross pricing and tax breakdown |
Scopes:
inventory:read for read-only endpoints (GET), inventory:write for modifications (POST, PATCH, DELETE). Pricing calculations require the same workspace-scoped API access.Key concepts
- Departures represent scheduled inventory for a catalog product (
productId), including capacity, meeting point, and transport metadata. - All read and write operations must include the source
productId(query or body) so the API can enforce workspace ownership. - Availability is synchronised automatically when you create, update, or delete departures.
- Use the itinerary endpoint to fetch the versioned day/segment structure surfaced in booking flows; add
include=segments,optionsto enrich activities. - Use the price endpoint to estimate totals for a party (
pax,rooms,addons) before starting a booking.