New Endpoint: Sold Itinerary Snapshot

Dear Developers,

In this deployment, we add external API support for the Sold Itinerary feature released in January. This addition allows you to use our API to retrieve this snapshot data -- the gross price and itinerary details from the point at which a given quote was booked (see: Sales Workflow Sequence).

For additional information on the Sold Itinerary feature within the FL3XX Web App, please see our Knowledge Base article.

Endpoint(s) Added

• GET /api/external/quote/{reference}/bookedSnapshot

Usage Guidelines

1. Determine a relevant bookingid or externalReference (e.g. via GET /api/external/quote/bookings) to use as the URL path parameter, reference.
2. GET the snapshot information for your reference.

The QuoteSnapshotDto Model

The values returned by this endpoint are a record from the point at which the quote moved through the Book stage of the Sales Workflow Sequence.

This endpoint returns a JSON object represented by the **QuoteSnapshotDto** model. This object has two keys: a PriceEntry object (grossPrice) and an array of LegDto_2 objects (legs). The following provides some additional detail regarding these objects.

1. grossPrice The value of Total Gross when the quote was booked
   1. This object uses the PriceEntry model, which you may already be familiar with from GET /api/external/quote/price. This is a copy of the Sold gross price for this quote as recorded when the quote was booked.
2. legs The itinerary details as they were when the quote was booked.
   1. This key references an array of LegDto_2 objects -- a model used in many places within our API (in particular, the /quote and /leg groups of endpoints). This makes legs easily comparable to the current values of the legs array returned by, for example, GET /api/external/quote/**reference**.

Specification

The full definition for this endpoint, the models used, and example values for payloads can be found under its entry GET /api/external/quote/{reference}/bookedSnapshot (within the group /api/external/quote) on our OpenAPI Specification page (SWAGGER UI). If you encounter any challenges or have questions, contact us at [email protected].

Best regards,
FL3XX API Team