Skip to main content

Endpoints

MethodPathDescription
GET/v1/products/:id/itineraryRetrieve itinerary days (optionally with segments and activity options).
GET/v1/products/:id/itinerary/days/:dayId/accommodationGet the accommodation assignment for a specific day.
PATCH/v1/products/:id/itinerary/days/:dayId/accommodationAssign or update the accommodation option for a day.
DELETE/v1/products/:id/itinerary/days/:dayId/accommodationRemove the accommodation assignment for a day.
Read operations require the products:read scope. Assigning or deleting accommodation requires products:write.

Key concepts

  • The itinerary is versioned. Fetching /itinerary returns the current version ID along with day data. If a product has no itinerary yet, the API initializes a default draft version automatically.
  • Use the locale query parameter to override day titles/descriptions with localized translations when available.
  • Supply include=segments to embed daily segments, and include=options to further embed activity option groups within each segment.
  • Accommodation assignments reference entries from product_accommodation_options; assigning the same day again upserts the record.
  • Removing an assignment returns { ok: true } without error when no assignment existed.