> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create Hold Flight Order > Hold the selected order without paying (body type:hold) ## OpenAPI ````yaml openapi/zh/duffel-flights.json POST /apis/v1/duffel/flights/orders/hold-create openapi: 3.1.0 info: description: '' title: Duffel Flights version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: - /apis/v1/duffel/flights/offer-requests/create - /apis/v1/duffel/flights/offer-requests/list - /apis/v1/duffel/flights/offer-requests/{id} - /apis/v1/duffel/flights/offers/list - /apis/v1/duffel/flights/offers/{id} - /apis/v1/duffel/flights/order-cancellations/create - /apis/v1/duffel/flights/order-cancellations/{id} - /apis/v1/duffel/flights/order-cancellations/{id}/confirm - /apis/v1/duffel/flights/order-change-requests/create - /apis/v1/duffel/flights/order-change-requests/{id} - /apis/v1/duffel/flights/order-changes/create - /apis/v1/duffel/flights/orders/create - /apis/v1/duffel/flights/orders/hold-create - /apis/v1/duffel/flights/seat-maps x-aisa-document: facts_hash: f5da5a328e1cec5e66cbcd1109d12fa71687c2c4e8bd1da8db603ed7bccd6637 generator_version: '2' protocol_version: '1' schema_version: '1' composer_version: '13' response_pending: - operation_id: post_duffel_offer_requests_create path: /apis/v1/duffel/flights/offer-requests/create method: POST statuses: - '200' reason: public success response has no authoritative payload declaration - operation_id: get_duffel_offer_request path: /apis/v1/duffel/flights/offer-requests/{id} method: GET statuses: - '200' reason: public success response has no authoritative payload declaration document_hash: sha256:bede2cc04d9a6a5b3f07d39c9a84e32a4c2c99be12c3c7e14b9df2ff3c3a3d8a x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: duffel-flights x-aisa-catalogs: duffel-flights: title: Duffel Flights description: '' x-aisa-document: facts_hash: f5da5a328e1cec5e66cbcd1109d12fa71687c2c4e8bd1da8db603ed7bccd6637 generator_version: '2' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/duffel/flights/orders/hold-create: post: tags: - duffel summary: Create Hold Flight Order description: Hold the selected order without paying (body type:hold) operationId: post_duffel_orders_hold_create requestBody: required: true content: application/json: schema: type: object required: - data properties: data: properties: metadata: description: > Metadata contains a set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object, in a structured format. Duffel does not use this information. You should not store sensitive information in this field. The metadata is a collection of key-value pairs, both of which are strings. You can store a maximum of 50 key-value pairs, where each key has a maximum length of 40 characters and each value has a maximum length of 500 characters. Keys must only contain numbers, letters, dashes, or underscores. example: payment_intent_id: pit_00009htYpSCXrwaB9DnUm2 type: object passengers: description: >- The personal details of the passengers, expanding on the information initially provided when creating the offer request items: properties: born_on: description: The passenger's date of birth example: '1987-07-24' format: date type: string email: description: The passenger's email address example: amelia@duffel.com type: string family_name: description: >- The passenger's family name. Only `space`, `-`, `'`, and letters from the [`ASCII`](https://www.unicode.org/charts/PDF/U0000.pdf), [`Latin-1 Supplement`](https://www.unicode.org/charts/PDF/U0080.pdf) and [`Latin Extended-A`](https://www.unicode.org/charts/PDF/U0100.pdf) (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, and `ð`) Unicode charts are accepted. All other characters will result in a validation error. The minimum length is 1 or 2 characters, and the maximum, combined with `given_name`, is 40 characters. The requirements vary by airline. We recommend using a minimum length of 2. example: Earhart type: string gender: description: The passenger's gender enum: - m - f example: f type: string given_name: description: >- The passenger's given name. Only `space`, `-`, `'`, and letters from the [`ASCII`](https://www.unicode.org/charts/PDF/U0000.pdf), [`Latin-1 Supplement`](https://www.unicode.org/charts/PDF/U0080.pdf) and [`Latin Extended-A`](https://www.unicode.org/charts/PDF/U0100.pdf) (with the exceptions of `Æ`, `æ`, `IJ`, `ij`, `Œ`, `œ`, `Þ`, and `ð`) Unicode charts are accepted. All other characters will result in a validation error. The minimum length is 1 or 2 characters, and the maximum, combined with `family_name`, is 40 characters. The requirements vary by airline. We recommend using a minimum length of 2. example: Amelia type: string id: description: >- The `id` of the passenger, returned when the [offer request](/docs/api/offer-requests) was created example: pas_00009hj8USM7Ncg31cBCLL type: string identity_documents: description: >- The passenger's identity documents. You may only provide one identity document per type per passenger. The identity document's type supported by the airline can be found in the offer's `supported_passenger_identity_document_types`. If the offer's `passenger_identity_documents_required` is set to `true`, then a passport document must be provided. items: properties: expires_on: description: >- Must only be provided for `passport` type. The date on which the identity document expires example: '2025-04-25' format: date type: string issuing_country_code: description: >- Must only be provided for `passport`, `known_traveler_number`, and `passenger_redress_number` types. The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country that issued this identity document example: GB format: ISO 3166-1 alpha-2 type: string type: description: >- The type of the identity document. Currently, the only supported types are `passport`, `tax_id`, `known_traveler_number`, and `passenger_redress_number`. The identity document's type supported by the airline can be found in the offer's `supported_passenger_identity_document_types`. enum: - passport - tax_id - known_traveler_number - passenger_redress_number example: passport type: string unique_identifier: description: >- The unique identifier of the identity document. e.g. the passport number. example: 19KL56147 type: string required: - expires_on - issuing_country_code - type - unique_identifier title: Order Request Passenger Identity Document type: object type: - array - 'null' infant_passenger_id: description: >- Infant passengers, with an `age` of 0 or 1, must be associated with an adult passenger. This field should be used to make this association. It should contain the `id` of the infant passenger as returned in the [offer request](/docs/api/offer-requests). example: pas_00009hj8USM8Ncg32aTGHL type: string phone_number: description: >- The passenger's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) (international) format example: '+442080160509' type: string title: description: >- The passenger's title (the `dr` title is not supported by certain airlines, where a [`ValidationError`](/docs/api/overview/response-handling) will be returned instead if used) enum: - mr - ms - mrs - miss - dr example: mrs type: string user_id: description: > Creates an association between the passenger and a previously created user. This is intended to allow passengers the ability to manage their own orders. example: icu_00009htyDGjIfajdNBZRlw type: string required: - id - given_name - family_name - gender - title - born_on - email - phone_number title: Order Request Passenger type: object type: array payments: description: >- The payment details to use to pay for the order. This key should be omitted when the order’s `type` is `hold`. items: properties: amount: description: >- The amount of the payment. This should be the same as the `total_amount` of the offer specified in `selected_offers`, plus the `total_amount` of all the services specified in `services`. example: '30.20' type: string currency: description: >- The currency of the `amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This should be the same as the `total_currency` of the offer specified in `selected_offers`. example: GBP format: ISO 4217 type: string three_d_secure_session_id: description: >- The `id` of the 3DSecure Session ID. This is the authentication when paying by [card](/docs/api/v2/card). example: 3ds_0000AWr2XsTRIF1Vp34gh5 type: string type: description: >- The type of payment you want to apply to the order. If you are an IATA agent with your own agreements with airlines, in some cases, you can pay using ARC/BSP cash by specifying `arc_bsp_cash`. You can pay using your Duffel account's balance by specifying `balance`. Otherwise, you can pay by [card](docs/api/v2/card). In [test mode](/docs/api/overview/test-mode), your balance is unlimited. If you're not sure which of these options applies to you, get in touch with the Duffel support team at . enum: - arc_bsp_cash - balance - card example: balance type: string required: - type - amount - currency type: object type: array selected_offers: description: > The `id`s of the offers you want to book. You must specify an array containing exactly one selected offer. Note that you can only book one offer per offer request. items: example: off_00009htyDGjIfajdNBZRlw type: string type: array services: description: > The services you want to book along with the first selected offer. If the offer was priced with `intended_services`, you must either send those same services here or omit this key entirely. Any other set of services is rejected. items: properties: id: description: >- The `id` of the service from the offer's `available_services` that you want to book example: ase_00009hj8USM7Ncg31cB123 type: string quantity: description: >- The quantity of the service to book. This will always be `1` for seat services. example: 1 minimum: 1 type: integer required: - id - quantity title: Order Request Service type: object type: array type: description: > The type of order. You can only use `hold` with offers where `payment_requirements.requires_instant_payment` is `false`. When booking an offer with type `hold`, do not specify `payments` key. enum: - instant - hold example: instant type: string users: description: > The `id`s of users that would be allowed to manage the order. items: example: icu_00009htyDGjIfajdNBZRlw type: string type: array required: - selected_offers - passengers - payments type: object title: Body parameters responses: '201': content: application/json: schema: type: object properties: data: $ref: >- #/components/schemas/PublishedResponses_PreviousResponseDuffel_Order description: Held order awaiting payment default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats 2XX: content: application/json: schema: type: object required: - data properties: data: additionalProperties: false description: An order represents a booking with an airline properties: airline_initiated_changes: description: The airline-initiated changes for this Order items: additionalProperties: false properties: action_taken: description: > The action taken in response to this airline-initiated change. Accepted, cancelled and changed reflect your action in accepting the change, cancelling the order or changing the order respectively. enum: - accepted - cancelled - changed example: accepted type: - string - 'null' action_taken_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which an action was taken example: '2022-01-17T10:12:14.545Z' type: - string - 'null' added: description: >- List of updated [slices and segments](/docs/api/orders/schema#orders-schema-slices) following the change. These slices and segments may each have a new ID as a result of the changes. items: additionalProperties: false properties: conditions: additionalProperties: false description: > The conditions associated with this slice, describing the kinds of modifications you can make and any penalties that will apply to those modifications. This condition is applied only to this slice and to all the passengers associated with this order - for information at the order level (e.g. "what happens if I want to change all the slices?") refer to the `conditions` at the top level. If a particular kind of modification is allowed, you may not always be able to take action through the Duffel API. In some cases, you may need to contact the Duffel support team or the airline directly. properties: change_before_departure: description: > Whether this slice can be changed before the departure. If the slice can be changed for all of the passengers then the `allowed` property will be `true` and information will be provided about any penalties. If none of the passengers on the slice can be changed then the `allowed` property will be `false`. In all other cases this property will be `null` indicating we can't provide the information for this slice. The `penalty_amount` is specific to changing this slice and may not be the penalties that is applied if the entire order is changed. properties: allowed: description: >- Whether this kind of modification is allowed post-booking example: true type: boolean penalty_amount: description: > If the modification is `allowed` then this is the amount payable to apply the modification to all passengers. If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`. If this is `null` then the `penalty_currency` will also be `null`. example: '100.00' type: - string - 'null' penalty_currency: description: > The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This will be in a currency determined by the airline, which is not necessarily the same as the currency of the offer or order. If this is `null` then `penalty_amount` will also be `null`. example: GBP format: ISO 4217 type: - string - 'null' type: - object - 'null' required: - change_before_departure title: OrderSliceConditions type: object destination: additionalProperties: false description: The city or airport where this slice ends properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object destination_type: description: The type of the destination enum: - airport - city example: airport type: string duration: description: >- The duration of the slice, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' fare_brand_name: description: > The name of the fare brand associated with this slice. A fare brand specifies the travel conditions you get on your slice made available by the airline. e.g. a British Airways Economy Basic fare will only include a hand baggage allowance. It is worth noting that the fare brand names are defined by the airlines themselves and therefore they are subject to change without any prior notice. example: Basic type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: sli_00009htYpSCXrwaB9Dn123 type: string origin: additionalProperties: false description: >- The city or airport where this slice begins properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object origin_type: description: The type of the origin enum: - airport - city example: airport type: string segments: description: >- The segments - that is, specific flights - that the airline is offering to get the passengers from the `origin` to the `destination` items: additionalProperties: false properties: aircraft: allOf: - additionalProperties: false properties: iata_code: description: >- The three-character IATA code for the aircraft example: '380' type: string id: description: >- Duffel's unique identifier for the resource example: arc_00009UhD4ongolulWd91Ky type: string name: description: The name of the aircraft example: Airbus Industries A380 type: string required: - iata_code - id - name title: Aircraft type: object - description: >- The aircraft that the operating carrier will use to operate this segment arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to arrive, in the destination airport timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to depart, in the origin airport timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string destination: allOf: - properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: iata_code: description: >- The three-character IATA code for the city example: NYC type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: US format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_nyc_us type: string name: description: The name of the city example: New York type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: New York type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: NYC type: string iata_code: description: >- The three-character IATA code for the airport example: JFK type: - string - 'null' iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: US format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: KJFK type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_jfk_us type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 40.640556 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -73.778519 format: float type: number name: description: The name of the airport example: John F. Kennedy International Airport type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: America/New_York type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - city - iata_city_code title: Airport type: object - description: >- The airport at which the segment is scheduled to arrive destination_terminal: description: >- The terminal at the `destination` airport where the segment is scheduled to arrive example: '5' type: - string - 'null' distance: description: >- The distance of the segment in kilometres example: '424.2' type: - string - 'null' duration: description: >- The duration of the segment, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: seg_00009htYpSCXrwaB9Dn456 type: string marketing_carrier: additionalProperties: false description: >- The airline selling the tickets for this segment. This may differ from the `operating_carrier` in the case of a "codeshare", where one airline sells flights operated by another airline. properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object marketing_carrier_flight_number: description: >- The flight number assigned by the marketing carrier example: '1234' type: string operating_carrier: additionalProperties: false description: >- The airline actually operating this segment. This may differ from the `marketing_carrier` in the case of a "codeshare", where one airline sells flights operated by another airline. properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object operating_carrier_flight_number: description: >- The flight number assigned by the operating carrier. This may not be present, in which case you should display the `marketing_carrier`'s information and the `marketing_carrier_flight_number`, and simply state the name of the `operating_carrier`. example: '4321' type: - string - 'null' origin: description: >- The airport from which the flight is scheduled to depart properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object origin_terminal: description: >- The terminal at the `origin` airport from which the segment is scheduled to depart example: B type: - string - 'null' passengers: description: >- Additional segment-specific information about the passengers included in the offer (e.g. their baggage allowance and the cabin class they will be travelling in) items: additionalProperties: false properties: baggages: description: >- The baggage allowances for the passenger on this segment that were included in the original offer. Any extra baggage items which were booked as services will be listed in the `services` field instead of here. items: properties: quantity: description: >- The number of items of baggage of the specified `type` allowed on the segment. Where no allowance information is available for a particular `type`, no entry will be present. example: 1 type: integer type: description: The type of the baggage allowance enum: - checked - carry_on example: checked type: string title: Slice Segment Passenger Baggage type: object type: array cabin_class: description: >- The cabin class that the passenger will travel in on this segment enum: - first - business - premium_economy - economy example: economy type: - string - 'null' cabin_class_marketing_name: description: >- The name that the marketing carrier uses to market this cabin class example: Economy Basic type: - string - 'null' passenger_id: description: >- The identifier for the passenger. You may have specified this ID yourself when creating the offer request, or otherwise, Duffel will have generated its own random ID. example: passenger_0 type: string seat: description: > An object containing metadata about the service, like the designator of the seat. properties: designator: description: > The designator used to uniquely identify the seat, usually made up of a row number and a column letter example: 14B type: string disclosures: description: > Each disclosure is text, in English, provided by the airline that describes the terms and conditions of this seat. We recommend showing this in your user interface to make sure that customers understand any restrictions and limitations. example: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats items: description: > An individual term, condition or restriction for this seat type: string type: array name: description: > A name which describes the type of seat, which you can display in your user interface to help customers to understand its features example: Exit row seat type: - string - 'null' title: Service Metadata for a Seat type: - object - 'null' title: Order Slice Segment Passenger type: object type: array stops: description: >- Additional segment-specific information about the stops, if any, included in the segment items: additionalProperties: false properties: airport: allOf: - additionalProperties: false properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: {} iata_country_code: {} icao_code: {} id: {} latitude: {} longitude: {} name: {} time_zone: {} type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object - description: The airport at which the stop happens arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the stop is scheduled to arrive, in the airport's timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string x-validate: Duffel.Web.NaiveDateTimeValidator departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the stop is scheduled to depart, in the airport's timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string x-validate: Duffel.Web.NaiveDateTimeValidator duration: description: >- The duration of the stop, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: string id: description: >- Duffel's unique identifier for the resource example: sto_00009htYpSCXrwaB9Dn456 type: string required: - id - airport - arriving_at - departing_at - duration title: Order Slice Segment Stop type: object type: array required: - aircraft - arriving_at - departing_at - destination - destination_terminal - distance - duration - id - marketing_carrier - marketing_carrier_flight_number - operating_carrier - origin - origin_terminal - passengers title: Order Slice Segment type: object type: array required: - destination_type - destination - origin_type - origin - duration - id - segments - conditions title: Order Slice type: object type: array available_actions: description: > The available actions you can take on this Airline-Initiated Change through our API. `"update"` means that you can use the update endpoint for an Airline-Initiated Change. Possible values in array: `"accept"`, `"cancel"`, `"change"`, or `"update"` example: - accept - cancel - change items: enum: - accept - cancel - change - update type: string type: array created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which we detected the airline-initiated change example: '2020-04-11T15:48:11.642Z' format: date-time type: string id: description: Duffel's unique identifier for the resource example: aic_00001876aqC8c5umZmrRds type: string order_id: description: Duffel's unique identifier for the resource example: xxx_00009hthhsUZ8W4LxQgkjo type: string removed: description: >- List of [slices and segments](/docs/api/orders/schema#orders-schema-slices) as they were before the change. items: additionalProperties: false properties: conditions: additionalProperties: false description: > The conditions associated with this slice, describing the kinds of modifications you can make and any penalties that will apply to those modifications. This condition is applied only to this slice and to all the passengers associated with this order - for information at the order level (e.g. "what happens if I want to change all the slices?") refer to the `conditions` at the top level. If a particular kind of modification is allowed, you may not always be able to take action through the Duffel API. In some cases, you may need to contact the Duffel support team or the airline directly. properties: change_before_departure: description: > Whether this slice can be changed before the departure. If the slice can be changed for all of the passengers then the `allowed` property will be `true` and information will be provided about any penalties. If none of the passengers on the slice can be changed then the `allowed` property will be `false`. In all other cases this property will be `null` indicating we can't provide the information for this slice. The `penalty_amount` is specific to changing this slice and may not be the penalties that is applied if the entire order is changed. properties: allowed: description: >- Whether this kind of modification is allowed post-booking example: true type: boolean penalty_amount: description: > If the modification is `allowed` then this is the amount payable to apply the modification to all passengers. If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`. If this is `null` then the `penalty_currency` will also be `null`. example: '100.00' type: - string - 'null' penalty_currency: description: > The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This will be in a currency determined by the airline, which is not necessarily the same as the currency of the offer or order. If this is `null` then `penalty_amount` will also be `null`. example: GBP format: ISO 4217 type: - string - 'null' type: - object - 'null' required: - change_before_departure title: OrderSliceConditions type: object destination: additionalProperties: false description: The city or airport where this slice ends properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object destination_type: description: The type of the destination enum: - airport - city example: airport type: string duration: description: >- The duration of the slice, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' fare_brand_name: description: > The name of the fare brand associated with this slice. A fare brand specifies the travel conditions you get on your slice made available by the airline. e.g. a British Airways Economy Basic fare will only include a hand baggage allowance. It is worth noting that the fare brand names are defined by the airlines themselves and therefore they are subject to change without any prior notice. example: Basic type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: sli_00009htYpSCXrwaB9Dn123 type: string origin: additionalProperties: false description: >- The city or airport where this slice begins properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object origin_type: description: The type of the origin enum: - airport - city example: airport type: string segments: description: >- The segments - that is, specific flights - that the airline is offering to get the passengers from the `origin` to the `destination` items: additionalProperties: false properties: aircraft: allOf: - additionalProperties: false properties: iata_code: description: >- The three-character IATA code for the aircraft example: '380' type: string id: description: >- Duffel's unique identifier for the resource example: arc_00009UhD4ongolulWd91Ky type: string name: description: The name of the aircraft example: Airbus Industries A380 type: string required: - iata_code - id - name title: Aircraft type: object - description: >- The aircraft that the operating carrier will use to operate this segment arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to arrive, in the destination airport timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to depart, in the origin airport timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string destination: allOf: - properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: iata_code: description: >- The three-character IATA code for the city example: NYC type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: US format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_nyc_us type: string name: description: The name of the city example: New York type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: New York type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: NYC type: string iata_code: description: >- The three-character IATA code for the airport example: JFK type: - string - 'null' iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: US format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: KJFK type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_jfk_us type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 40.640556 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -73.778519 format: float type: number name: description: The name of the airport example: John F. Kennedy International Airport type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: America/New_York type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - city - iata_city_code title: Airport type: object - description: >- The airport at which the segment is scheduled to arrive destination_terminal: description: >- The terminal at the `destination` airport where the segment is scheduled to arrive example: '5' type: - string - 'null' distance: description: >- The distance of the segment in kilometres example: '424.2' type: - string - 'null' duration: description: >- The duration of the segment, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: seg_00009htYpSCXrwaB9Dn456 type: string marketing_carrier: additionalProperties: false description: >- The airline selling the tickets for this segment. This may differ from the `operating_carrier` in the case of a "codeshare", where one airline sells flights operated by another airline. properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object marketing_carrier_flight_number: description: >- The flight number assigned by the marketing carrier example: '1234' type: string operating_carrier: additionalProperties: false description: >- The airline actually operating this segment. This may differ from the `marketing_carrier` in the case of a "codeshare", where one airline sells flights operated by another airline. properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object operating_carrier_flight_number: description: >- The flight number assigned by the operating carrier. This may not be present, in which case you should display the `marketing_carrier`'s information and the `marketing_carrier_flight_number`, and simply state the name of the `operating_carrier`. example: '4321' type: - string - 'null' origin: description: >- The airport from which the flight is scheduled to depart properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object origin_terminal: description: >- The terminal at the `origin` airport from which the segment is scheduled to depart example: B type: - string - 'null' passengers: description: >- Additional segment-specific information about the passengers included in the offer (e.g. their baggage allowance and the cabin class they will be travelling in) items: additionalProperties: false properties: baggages: description: >- The baggage allowances for the passenger on this segment that were included in the original offer. Any extra baggage items which were booked as services will be listed in the `services` field instead of here. items: properties: quantity: description: >- The number of items of baggage of the specified `type` allowed on the segment. Where no allowance information is available for a particular `type`, no entry will be present. example: 1 type: integer type: description: The type of the baggage allowance enum: - checked - carry_on example: checked type: string title: Slice Segment Passenger Baggage type: object type: array cabin_class: description: >- The cabin class that the passenger will travel in on this segment enum: - first - business - premium_economy - economy example: economy type: - string - 'null' cabin_class_marketing_name: description: >- The name that the marketing carrier uses to market this cabin class example: Economy Basic type: - string - 'null' passenger_id: description: >- The identifier for the passenger. You may have specified this ID yourself when creating the offer request, or otherwise, Duffel will have generated its own random ID. example: passenger_0 type: string seat: description: > An object containing metadata about the service, like the designator of the seat. properties: designator: description: > The designator used to uniquely identify the seat, usually made up of a row number and a column letter example: 14B type: string disclosures: description: > Each disclosure is text, in English, provided by the airline that describes the terms and conditions of this seat. We recommend showing this in your user interface to make sure that customers understand any restrictions and limitations. example: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats items: description: > An individual term, condition or restriction for this seat type: string type: array name: description: > A name which describes the type of seat, which you can display in your user interface to help customers to understand its features example: Exit row seat type: - string - 'null' title: Service Metadata for a Seat type: - object - 'null' title: Order Slice Segment Passenger type: object type: array stops: description: >- Additional segment-specific information about the stops, if any, included in the segment items: additionalProperties: false properties: airport: allOf: - additionalProperties: false properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: {} iata_country_code: {} icao_code: {} id: {} latitude: {} longitude: {} name: {} time_zone: {} type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object - description: The airport at which the stop happens arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the stop is scheduled to arrive, in the airport's timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string x-validate: Duffel.Web.NaiveDateTimeValidator departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the stop is scheduled to depart, in the airport's timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string x-validate: Duffel.Web.NaiveDateTimeValidator duration: description: >- The duration of the stop, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: string id: description: >- Duffel's unique identifier for the resource example: sto_00009htYpSCXrwaB9Dn456 type: string required: - id - airport - arriving_at - departing_at - duration title: Order Slice Segment Stop type: object type: array required: - aircraft - arriving_at - departing_at - destination - destination_terminal - distance - duration - id - marketing_carrier - marketing_carrier_flight_number - operating_carrier - origin - origin_terminal - passengers title: Order Slice Segment type: object type: array required: - destination_type - destination - origin_type - origin - duration - id - segments - conditions title: Order Slice type: object type: array travel_agent_ticket: description: > The associated Travel Agent Ticket, if any, for this Airline-Initiated Change. This value will be present for Airline-Initiated changes that take some time to be processed. items: properties: external_ticket_id: description: > Duffel's unique reference for our ticket. Please include this in any correspondence with Duffel. example: '1234' type: string id: description: >- Duffel's unique identifier for the resource example: tic_00001876aqC8c5umZmrRds type: string title: Travel Agent Ticket type: object type: - object - 'null' x-preview: true updated_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the airline-initiated change was last updated example: '2020-01-17T10:12:14.545Z' format: date-time type: string required: - action_taken - available_actions - added - action_taken_at - created_at - id - order_id - removed - updated_at - travel_agent_ticket title: Airline-InitiatedChange type: object type: array available_actions: description: > The available actions you can take on this order through our API. It's a list of zero or more of the following values: - `"cancel"`: You can [cancel](https://duffel.com/docs/api/order-cancellations) the order. - `"change"`: You can [change](https://duffel.com/docs/api/order-changes) the order's slices. - `"update"`: You can [update](https://duffel.com/docs/api/orders/update-order-by-id) some of the order's fields. example: - cancel - update items: enum: - cancel - change - update type: string type: array base_amount: description: >- The base price of the order for all flights and services booked, excluding taxes example: '60.60' type: - string - 'null' base_currency: description: > The currency of the `base_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you’re using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered). example: GBP format: ISO 4217 type: - string - 'null' booking_reference: description: >- The airline's reference for the order, sometimes known as a "passenger name record" (PNR) or "record locator". Your customers can use this to check in and manage their booking on the airline's website. Usually, this is made up of six alphanumeric characters, but airlines can have their own formats (for example, easyJet's booking references are 7 alphanumeric characters long and LATAM's references are made up of 13 alphanumeric characters beginning with `LA`.) example: RZPNX8 type: string booking_references: description: >- All carrier booking references (PNRs) associated with this order. This includes the primary booking reference as well as any additional references from other carriers involved in the booking. items: additionalProperties: false description: >- A booking reference represents a passenger name record (PNR) or record locator issued by a carrier for an order properties: booking_reference: description: >- The airline reference for the order, sometimes known as a passenger name record (PNR) or record locator example: RZPNX8 type: string carrier: additionalProperties: false description: The airline that issued this booking reference properties: conditions_of_carriage_url: description: URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: |- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: - object - 'null' title: Booking Reference type: object type: array cancellation: additionalProperties: false description: >- The confirmed cancellation associated with this Order (if this Order has been cancelled) properties: airline_credits: description: > For unconfirmed cancellations, it lists airilne credits that would be generated if the cancellation is confirmed. For confirmed cancellations, it lists airline credits that were generated when this cancellation was confirmed. items: oneOf: - additionalProperties: false description: >- An airline credit quote represents the airline credit that would be issued by the airline if the order is cancelled. properties: amount: description: > The monetary value associated with this airline credit example: '90.80' type: string amount_currency: description: > The currency in which this airline credit is issued, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code example: GBP type: string code: description: > The code which identifies the airline credit to the airline and will be used to redeem the airline credit example: '1234567890123' type: - string - 'null' credit_amount: deprecated: true description: > The monetary value associated with this airline credit example: '90.80' type: string credit_code: deprecated: true description: > The code which identifies the airline credit to the airline and will be used to redeem the airline credit example: '1234567890123' type: - string - 'null' credit_currency: deprecated: true description: > The currency in which this airline credit is issued, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code example: GBP type: string credit_name: deprecated: true description: > The human-readable name used by the airline to categorize the type of credit being offered. This name should help when trying to understand the airline's conditions of use which apply to this credit. example: Duffel Travel Credit type: string id: description: > Duffel's unique identifier for the airline credit quote example: act_00009qzZWzjDipIkqpaUAj type: string issued_on: description: > The date the credit was issued. It is important to note that this date might not be the same as the date of cancellation. Often airlines associate credits with tickets, in which case the date of issue is considered to be the date the ticket was originally issued. Airline credits may have expiration dates which are based on the date of issue. Airlines don't always reliably disclose the expiration date in their APIs at the time of cancellation, so we are unable to return this information on airline credits. To get the latest info on expiration dates for airline credits we recommend checking directly with the airlines to determine the specific conditions of use for the credit. example: '2023-02-24' format: date type: string passenger_id: description: > Duffel's unique identifier for the passenger on the order that the credit is associated with example: pas_00009hj8USM7Ncg31cBCLL type: string type: description: > The type of airline credit that would be issued if the cancellation is confirmed. Use this to distinguish between credits that the airline will issue against the original e-ticket (`eticket`) and credits issued as a separate MCO/EMD document (`mco`, `emd`). enum: - eticket - mco - emd example: eticket type: string required: - id - amount - code - amount_currency - issued_on - passenger_id - type title: Airline Credit Quote type: object - additionalProperties: false description: >- An airline credit represents credit issued by an airline for a canceled or disrupted flight. properties: airline_iata_code: description: >- The two-character IATA code for the airline that issued this credit example: AA type: string amount: description: Value of this airline credit example: '30.20' type: string amount_currency: description: > The currency of the `amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. example: GBP format: ISO 4217 type: - string - 'null' code: description: >- Credit identifier provided by the airline example: '12345678' type: - string - 'null' created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the airline credit was created. example: '2020-04-11T15:48:11.642Z' format: date-time type: string credit_amount: deprecated: true description: > The monetary value associated with this airline credit example: '90.80' type: string credit_code: deprecated: true description: > The code which identifies the airline credit to the airline and will be used to redeem the airline credit example: '1234567890123' type: - string - 'null' credit_currency: deprecated: true description: > The currency in which this airline credit is issued, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code example: GBP type: string credit_name: deprecated: true description: > The common name given to this airline credit. example: Future Flight Credit type: string expires_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the airline credit expires and will no longer be eligible for payment. example: '2020-04-11T15:48:11.642Z' format: date-time type: - string - 'null' family_name: description: > The family name of the passenger associated with this airline credit. example: Doe type: string given_name: description: > The given name of the passenger associated with this airline credit. example: John type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: acd_00009UhD4ongolulWd91Ky type: string invalidated_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the airline credit was invalidated. Invalidated credits are not eligible for payment. example: '2020-04-11T15:48:11.642Z' format: date-time type: - string - 'null' issued_on: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the airline credit was issued by the airline. example: '2020-04-11' format: date type: string live_mode: description: >- Whether the payment was created in live mode. This field will be set to `true` if the payment was created in live mode, or `false` if it was created in test mode. example: false type: boolean order_id: description: > Duffel's unique identifier for the order that the credit is associated with example: ord_00009hj8USM7Ncg31cBCLL type: - string - 'null' passenger_id: description: > Duffel's unique identifier for the passenger on the order that the credit is associated with example: pas_00009hj8USM7Ncg31cBCLL type: - string - 'null' penalty_amount: description: >- The penalty that will be incurred when paying with this airline credit example: '10.20' type: - string - 'null' penalty_currency: description: > The currency of the penalty amount, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. example: GBP format: ISO 4217 type: - string - 'null' spent_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the airline credit was spent. Spent credits are not eligible for payment. example: '2020-04-11T15:48:11.642Z' format: date-time type: - string - 'null' type: description: Type of the airline credit enum: - eticket - mco - emd example: eticket type: string user_id: description: > Duffel's unique identifier for the customer user that the credit is associated with example: icu_00009hj8USM7Ncg31cBCLL type: - string - 'null' required: - id - amount - amount_currency - created_at - issued_on - live_mode - given_name - family_name - type - airline_iata_code - expires_at title: Airline Credit type: object type: array confirmed_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime that indicates when the order cancellation was confirmed example: '2020-01-17T11:51:43.114803Z' format: date-time type: - string - 'null' created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order cancellation was created example: '2020-04-11T15:48:11.642Z' format: date-time type: string expires_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime by which this cancellation must be confirmed example: '2020-01-17T10:42:14Z' format: date-time type: - string - 'null' id: description: Duffel's unique identifier for the resource example: ore_00009qzZWzjDipIkqpaUAj type: string live_mode: description: >- Whether the order cancellation was created in live mode. This field will be set to `true` if the order cancellation was created in live mode, or `false` if it was created in test mode. example: false type: boolean order_id: description: Duffel's unique identifier for the resource example: xxx_00009hthhsUZ8W4LxQgkjo type: string refund_amount: description: > The total value that will be returned to the customer if the order is cancelled, determined according to the fare conditions. When the original order was paid with a mix of cash and airline credit and the cancellation is a void, this is the grand total across both the cash refunded to the original payment method and any re-issued [`airline_credits`](#tag/Order-Cancellations). This may be `0.00` if the fare is non-refundable. It will include the refund amount of the flights and the services booked. This may be null in cases where the refund amount is unknown. This only applies in cases where we are unable to get a refund quote from the carrier. example: '90.80' type: - string - 'null' refund_currency: description: > The currency of the `refund_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you’re using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered). For `hold` orders that are awaiting payment, the refund amount will always be 0.00. example: GBP format: ISO 4217 type: - string - 'null' refund_to: description: > Where the refund, once confirmed, will be sent. `awaiting_payment` is for pay later orders where no payment has been made yet. enum: - arc_bsp_cash - balance - card - voucher - awaiting_payment - airline_credits - original_form_of_payment example: arc_bsp_cash type: string required: - id - order_id - live_mode - expires_at - refund_amount - refund_currency - refund_to - confirmed_at - created_at - airline_credits title: Order Cancellation type: - object - 'null' cancelled_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order was cancelled, if it has been cancelled example: '2020-04-11T15:48:11.642Z' format: date-time type: - string - 'null' changes: description: The passenger-initiated changes for this Order items: description: >- An order change represents alterations to an existing order with an airline properties: change_total_amount: description: > The amount that will be charged or refunded, determined according to the fare conditions. A negative value will reflect a refund. example: '30.50' type: string change_total_currency: description: > The currency of the `change_total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you’re using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered). example: GBP format: ISO 4217 type: string confirmed_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime that indicates when the order change was confirmed example: '2020-01-17T11:51:43.114803Z' format: date-time type: - string - 'null' created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order change was created example: '2020-04-11T15:48:11.642Z' format: date-time type: string expires_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime by which this change must be confirmed example: '2020-01-17T10:42:14.545052Z' format: date-time type: string id: description: Duffel's unique identifier for the resource example: ocr_0000A3tQSmKyqOrcySrGbo type: string live_mode: description: >- Whether the order change was created in live mode. This field will be set to `true` if the order change was created in live mode, or `false` if it was created in test mode. example: false type: boolean new_total_amount: description: >- The total price of the order for all the flights and services booked, including taxes, once the change is confirmed. example: '121.30' type: string new_total_currency: description: > The currency of the `new_total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you’re using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered). example: GBP format: ISO 4217 type: string order_id: description: >- Duffel's unique identifier for the order which is being changed example: ord_0000A3tQcCRZ9R8OY0QlxA type: string penalty_total_amount: description: >- The amount charged by the airline for making this change. example: '15.50' type: string penalty_total_currency: description: > The currency of the `penalty_total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you’re using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered). example: GBP format: ISO 4217 type: string refund_to: description: > Where the refund, once confirmed, will be sent. Refunds are indicated by a negative `change_total_amount`. If the change does not require a refund, this field will be `null`. `original_form_of_payment` refers to the form of payment used to create the order. enum: - voucher - original_form_of_payment example: voucher type: - string - 'null' slices: additionalProperties: false description: >- The slices within an order change that are being added to and/or removed from the order properties: add: description: The slices that will be added to the order items: additionalProperties: false description: A slice that is being removed or added properties: destination: additionalProperties: false properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object destination_type: description: The type of the destination enum: - airport - city example: airport type: string duration: description: >- The duration of the slice, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' fare_brand_name: description: > The name of the fare brand associated with this slice. A fare brand specifies the travel conditions you get on your slice made available by the airline. e.g. a British Airways Economy Basic fare will only include a hand baggage allowance. It is worth noting that the fare brand names are defined by the airlines themselves and therefore they are subject to change without any prior notice. example: Basic type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: xxx_00009hthhsUZ8W4LxQgkjo type: string origin: additionalProperties: false properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object origin_type: description: The type of the origin enum: - airport - city example: airport type: string segments: description: >- The segments - that is, specific flights - that the airline is offering to get the passengers from the `origin` to the `destination` items: additionalProperties: false properties: aircraft: allOf: - additionalProperties: false properties: iata_code: description: >- The three-character IATA code for the aircraft example: '380' type: string id: description: >- Duffel's unique identifier for the resource example: arc_00009UhD4ongolulWd91Ky type: string name: description: The name of the aircraft example: Airbus Industries A380 type: string required: - iata_code - id - name title: Aircraft type: object - description: >- The aircraft that the operating carrier will use to operate this segment arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to arrive, in the destination airport timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to depart, in the origin airport timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string destination: allOf: - properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: iata_code: description: >- The three-character IATA code for the city example: NYC type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: US format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_nyc_us type: string name: description: The name of the city example: New York type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: New York type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: NYC type: string iata_code: description: >- The three-character IATA code for the airport example: JFK type: - string - 'null' iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: US format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: KJFK type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_jfk_us type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 40.640556 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -73.778519 format: float type: number name: description: The name of the airport example: John F. Kennedy International Airport type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: America/New_York type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - city - iata_city_code title: Airport type: object - description: >- The airport at which the segment is scheduled to arrive destination_terminal: description: >- The terminal at the `destination` airport where the segment is scheduled to arrive example: '5' type: - string - 'null' distance: description: >- The distance of the segment in kilometres example: '424.2' type: - string - 'null' duration: description: >- The duration of the segment, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: xxx_00009hthhsUZ8W4LxQgkjo type: string marketing_carrier: additionalProperties: false properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object marketing_carrier_flight_number: description: >- The flight number assigned by the marketing carrier example: '1234' type: string operating_carrier: additionalProperties: false properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object operating_carrier_flight_number: description: >- The flight number assigned by the operating carrier. This may not be present, in which case you should display the `marketing_carrier`'s information and the `marketing_carrier_flight_number`, and simply state the name of the `operating_carrier`. example: '4321' type: - string - 'null' origin: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object origin_terminal: description: >- The terminal at the `origin` airport from which the segment is scheduled to depart example: B type: - string - 'null' passengers: description: >- Additional segment-specific information about the passengers included in the offer (e.g. their baggage allowance and the cabin class they will be travelling in) items: additionalProperties: false properties: baggages: description: >- The baggage allowances for the passenger on this segment that were included in the original offer. Any extra baggage items which were booked as services will be listed in the `services` field instead of here. items: properties: quantity: description: >- The number of items of baggage of the specified `type` allowed on the segment. Where no allowance information is available for a particular `type`, no entry will be present. example: 1 type: integer type: description: The type of the baggage allowance enum: - checked - carry_on example: checked type: string title: Slice Segment Passenger Baggage type: object type: array cabin_class: description: >- The cabin class that the passenger will travel in on this segment enum: - first - business - premium_economy - economy example: economy type: - string - 'null' cabin_class_marketing_name: description: >- The name that the marketing carrier uses to market this cabin class example: Economy Basic type: - string - 'null' passenger_id: description: >- The identifier for the passenger. You may have specified this ID yourself when creating the offer request, or otherwise, Duffel will have generated its own random ID. example: passenger_0 type: string seat: description: > An object containing metadata about the service, like the designator of the seat. properties: designator: description: > The designator used to uniquely identify the seat, usually made up of a row number and a column letter example: 14B type: string disclosures: description: > Each disclosure is text, in English, provided by the airline that describes the terms and conditions of this seat. We recommend showing this in your user interface to make sure that customers understand any restrictions and limitations. example: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats items: description: > An individual term, condition or restriction for this seat type: string type: array name: description: > A name which describes the type of seat, which you can display in your user interface to help customers to understand its features example: Exit row seat type: - string - 'null' title: Service Metadata for a Seat type: - object - 'null' title: Order Slice Segment Passenger type: object type: array required: - id - aircraft - arriving_at - departing_at - destination - destination_terminal - distance - duration - marketing_carrier - marketing_carrier_flight_number - operating_carrier - operating_carrier_flight_number - origin - origin_terminal - passengers type: object type: array required: - id - duration - destination - destination_type - origin - origin_type - fare_brand_name - segments title: Order Change Slices Slice type: object type: array remove: description: >- The slices that will be removed from the order items: additionalProperties: false description: A slice that is being removed or added properties: destination: additionalProperties: false properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object destination_type: description: The type of the destination enum: - airport - city example: airport type: string duration: description: >- The duration of the slice, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' fare_brand_name: description: > The name of the fare brand associated with this slice. A fare brand specifies the travel conditions you get on your slice made available by the airline. e.g. a British Airways Economy Basic fare will only include a hand baggage allowance. It is worth noting that the fare brand names are defined by the airlines themselves and therefore they are subject to change without any prior notice. example: Basic type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: xxx_00009hthhsUZ8W4LxQgkjo type: string origin: additionalProperties: false properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object origin_type: description: The type of the origin enum: - airport - city example: airport type: string segments: description: >- The segments - that is, specific flights - that the airline is offering to get the passengers from the `origin` to the `destination` items: additionalProperties: false properties: aircraft: allOf: - additionalProperties: false properties: iata_code: description: >- The three-character IATA code for the aircraft example: '380' type: string id: description: >- Duffel's unique identifier for the resource example: arc_00009UhD4ongolulWd91Ky type: string name: description: The name of the aircraft example: Airbus Industries A380 type: string required: - iata_code - id - name title: Aircraft type: object - description: >- The aircraft that the operating carrier will use to operate this segment arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to arrive, in the destination airport timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to depart, in the origin airport timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string destination: allOf: - properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: iata_code: description: >- The three-character IATA code for the city example: NYC type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: US format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_nyc_us type: string name: description: The name of the city example: New York type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: New York type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: NYC type: string iata_code: description: >- The three-character IATA code for the airport example: JFK type: - string - 'null' iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: US format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: KJFK type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_jfk_us type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 40.640556 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -73.778519 format: float type: number name: description: The name of the airport example: John F. Kennedy International Airport type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: America/New_York type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - city - iata_city_code title: Airport type: object - description: >- The airport at which the segment is scheduled to arrive destination_terminal: description: >- The terminal at the `destination` airport where the segment is scheduled to arrive example: '5' type: - string - 'null' distance: description: >- The distance of the segment in kilometres example: '424.2' type: - string - 'null' duration: description: >- The duration of the segment, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: xxx_00009hthhsUZ8W4LxQgkjo type: string marketing_carrier: additionalProperties: false properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object marketing_carrier_flight_number: description: >- The flight number assigned by the marketing carrier example: '1234' type: string operating_carrier: additionalProperties: false properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object operating_carrier_flight_number: description: >- The flight number assigned by the operating carrier. This may not be present, in which case you should display the `marketing_carrier`'s information and the `marketing_carrier_flight_number`, and simply state the name of the `operating_carrier`. example: '4321' type: - string - 'null' origin: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object origin_terminal: description: >- The terminal at the `origin` airport from which the segment is scheduled to depart example: B type: - string - 'null' passengers: description: >- Additional segment-specific information about the passengers included in the offer (e.g. their baggage allowance and the cabin class they will be travelling in) items: additionalProperties: false properties: baggages: description: >- The baggage allowances for the passenger on this segment that were included in the original offer. Any extra baggage items which were booked as services will be listed in the `services` field instead of here. items: properties: quantity: description: >- The number of items of baggage of the specified `type` allowed on the segment. Where no allowance information is available for a particular `type`, no entry will be present. example: 1 type: integer type: description: The type of the baggage allowance enum: - checked - carry_on example: checked type: string title: Slice Segment Passenger Baggage type: object type: array cabin_class: description: >- The cabin class that the passenger will travel in on this segment enum: - first - business - premium_economy - economy example: economy type: - string - 'null' cabin_class_marketing_name: description: >- The name that the marketing carrier uses to market this cabin class example: Economy Basic type: - string - 'null' passenger_id: description: >- The identifier for the passenger. You may have specified this ID yourself when creating the offer request, or otherwise, Duffel will have generated its own random ID. example: passenger_0 type: string seat: description: > An object containing metadata about the service, like the designator of the seat. properties: designator: description: > The designator used to uniquely identify the seat, usually made up of a row number and a column letter example: 14B type: string disclosures: description: > Each disclosure is text, in English, provided by the airline that describes the terms and conditions of this seat. We recommend showing this in your user interface to make sure that customers understand any restrictions and limitations. example: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats items: description: > An individual term, condition or restriction for this seat type: string type: array name: description: > A name which describes the type of seat, which you can display in your user interface to help customers to understand its features example: Exit row seat type: - string - 'null' title: Service Metadata for a Seat type: - object - 'null' title: Order Slice Segment Passenger type: object type: array required: - id - aircraft - arriving_at - departing_at - destination - destination_terminal - distance - duration - marketing_carrier - marketing_carrier_flight_number - operating_carrier - operating_carrier_flight_number - origin - origin_terminal - passengers type: object type: array required: - id - duration - destination - destination_type - origin - origin_type - fare_brand_name - segments title: Order Change Slices Slice type: object type: array required: - add - remove title: Order Change Slices type: object required: - id - order_id - live_mode - expires_at - change_total_amount - change_total_currency - new_total_amount - new_total_currency - penalty_total_amount - penalty_total_currency - refund_to - slices - created_at - confirmed_at title: Order Change type: object type: array conditions: description: > The conditions associated with this order, describing the kinds of modifications you can make to it and any penalties that will apply to those modifications. This information assumes the condition is applied to all of the slices and passengers associated with this order - for information at the slice level (e.g. "what happens if I just want to change the first slice?") refer to the `slices`. If a particular kind of modification is allowed, you may not always be able to take action through the Duffel API. In some cases, you may need to contact the Duffel support team or the airline directly. properties: change_before_departure: description: > Whether the whole order can be changed before the departure of the first slice. If all of the slices on the order can be changed then the `allowed` property will be `true`. Refer to the `slices` for information about change penalties. If any of the slices on the order can't be changed then the `allowed` property will be `false`. In this case you should refer to the `slices` conditions to determine if any part of the order is changeable. If the airline hasn't provided any information about whether this order can be changed then this property will be `null`. properties: allowed: description: >- Whether this kind of modification is allowed post-booking example: true type: boolean penalty_amount: description: > If the modification is `allowed` then this is the amount payable to apply the modification to all passengers. If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`. If this is `null` then the `penalty_currency` will also be `null`. example: '100.00' type: - string - 'null' penalty_currency: description: > The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This will be in a currency determined by the airline, which is not necessarily the same as the currency of the offer or order. If this is `null` then `penalty_amount` will also be `null`. example: GBP format: ISO 4217 type: - string - 'null' type: - object - 'null' refund_before_departure: description: > Whether the whole order can be refunded before the departure of the first slice. If all of the slices on the order can be refunded then the `allowed` property will be `true` and information will be provided about any penalties. If any of the slices on the order can't be refunded then the `allowed` property will be `false`. If the airline hasn't provided any information about whether this order can be refunded then this property will be `null`. properties: allowed: description: >- Whether this kind of modification is allowed post-booking example: true type: boolean penalty_amount: description: > If the modification is `allowed` then this is the amount payable to apply the modification to all passengers. If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`. If this is `null` then the `penalty_currency` will also be `null`. example: '100.00' type: - string - 'null' penalty_currency: description: > The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This will be in a currency determined by the airline, which is not necessarily the same as the currency of the offer or order. If this is `null` then `penalty_amount` will also be `null`. example: GBP format: ISO 4217 type: - string - 'null' type: - object - 'null' title: OrderConditions type: object content: description: Whether the order is Self-Managed or Managed enum: - self_managed - managed example: self_managed type: string created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order was created example: '2020-04-11T15:48:11.642Z' format: date-time type: string documents: description: The documents issued for this order items: properties: passenger_ids: description: >- The list of passenger `id`s the document applies to example: - pas_00009hj8USM7Ncg31cBCLL items: type: string type: array type: description: The type of document enum: - electronic_ticket - electronic_miscellaneous_document_associated - electronic_miscellaneous_document_standalone example: electronic_ticket type: string unique_identifier: description: >- The identifier for the document, in the case of electronic tickets this string represents the payment or the entitlement to fly. example: '1252106312810' type: string title: Order Document type: object type: array id: description: Duffel's unique identifier for the resource example: ord_00009hthhsUZ8W4LxQgkjo type: string intended_payment_methods: description: > The intended payment methods for this order. This field is only present for unpaid hold orders. items: oneOf: - additionalProperties: false properties: card_id: description: The ID of the card you intend to pay with example: tcd_0000A3t2sL46m5eDF45kWW type: string charge_amount: description: >- The amount that will be charged to the card payment example: '500.20' type: string charge_currency: description: The currency of the charge amount example: GBP format: ISO 4217 type: string surcharge_amount: description: >- The surcharge amount that will be applied to the card payment example: '30.20' type: - string - 'null' surcharge_currency: description: The currency of the surcharge amount example: GBP format: ISO 4217 type: - string - 'null' type: description: The type of payment method you intend to use enum: - card example: card type: string required: - type - card_id - charge_amount - charge_currency - surcharge_amount - surcharge_currency title: Intended Card Surcharge type: object - additionalProperties: false properties: airline_credit_id: description: >- The ID of the airilne credit you intend to pay with example: tcd_0000A3t2sL46m5eDF45kWW type: string charge_amount: description: >- The amount that will be taken from this airline credit example: '30.20' type: string charge_currency: description: The currency of the charge amount example: GBP format: ISO 4217 type: string penalty_amount: description: >- The penalty that will be incurred when paying with this airline credit example: '10.20' type: string penalty_currency: description: The currency of the penalty amount example: GBP format: ISO 4217 type: string type: description: The type of payment method you intend to use enum: - airline_credit example: airline_credit type: string required: - type - airline_credit_id - charge_amount - charge_currency - penalty_amount - penalty_currency title: Intended Airline Credit Charge type: object type: - array - 'null' live_mode: description: >- Whether the order was created in live mode. This field will be set to `true` if the order was created in live mode, or `false` if it was created in test mode. example: false type: boolean metadata: description: > Metadata contains a set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object, in a structured format. Duffel does not use this information. You should not store sensitive information in this field. example: customer_prefs: window seat payment_intent_id: pit_00009htYpSCXrwaB9DnUm2 type: - object - 'null' offer_id: description: The offer ID used at the time of booking. example: off_00009htYpSCXrwaB9DnUm0 type: string owner: additionalProperties: false description: The airline who owns the order properties: conditions_of_carriage_url: description: URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: |- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object passengers: description: The passengers who are travelling items: properties: born_on: description: The passenger's date of birth example: '1987-07-24' format: date type: string email: description: > The passenger's email address. Note that this data may differ from the airline's records if it was updated directly with the airline since the order was created. example: amelia@duffel.com type: string family_name: description: The passenger's family name example: Earhart type: string gender: description: The passenger's gender enum: - m - f example: f type: string given_name: description: The passenger's given name example: Amelia type: string id: description: >- The `id` of the passenger, returned when the [offer request](/docs/api/offer-requests) was created example: pas_00009hj8USM7Ncg31cBCLL type: string infant_passenger_id: description: >- The `id` of the infant associated with this passenger example: pas_00009hj8USM8Ncg32aTGHL type: - string - 'null' loyalty_programme_accounts: description: >- The loyalty programme accounts for this passenger items: properties: account_number: description: >- The passenger's account number for this loyalty programme account example: '12901014' type: string airline_iata_code: description: >- The IATA code for the airline that this loyalty programme account belongs to example: BA type: string title: Loyalty Programme Account type: object type: array phone_number: description: > The passenger's phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) (international) format. Note that this data may differ from the airline's records if it was updated directly with the airline since the order was created. example: '+442080160509' type: string title: description: The passenger's title enum: - mr - ms - mrs - miss - dr example: mrs type: string type: description: The type of the passenger enum: - adult - child - infant_without_seat example: adult type: string required: - id - type - infant_passenger_id - given_name - family_name - gender - title - born_on - email - phone_number - loyalty_programme_accounts title: Order Passenger type: object type: array payment_status: description: The payment status for this order properties: awaiting_payment: description: >- Whether a full payment has been made, or the airline is waiting for a payment to be made. This will be set to false if the order has been cancelled or if `payment_required_by` has elapsed. example: true type: boolean paid_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order was paid for, if at all example: '2020-01-17T10:42:14.545Z' format: date-time type: - string - 'null' payment_required_by: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime by which you must pay for this order. At this time, if still unpaid, the reserved space on the flight(s) will be released and you will have to create a new order. This will be `null` only for orders where `awaiting_payment` is `false`. example: '2020-01-17T10:42:14.545Z' format: date-time type: - string - 'null' price_guarantee_expires_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the price associated with the order will no longer be guaranteed by the airline and the order will need to be repriced before payment. This will be `null` when there is no price guarantee. example: '2020-01-17T10:42:14.545Z' format: date-time type: - string - 'null' title: OrderPaymentStatus type: object services: description: The services booked along with this order items: additionalProperties: false properties: id: description: Duffel's unique identifier for the resource example: ser_00009UhD4ongolulWd9123 type: string metadata: description: > The metadata varies by the type of service. It includes further data about the service. For example, for baggages, it may have data about size and weight restrictions. example: designator: 14B disclosures: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats name: Exit row seat oneOf: - additionalProperties: false description: >- An object containing metadata about the service, like the maximum weight and dimensions of the baggage. properties: maximum_depth_cm: description: >- The maximum depth that the baggage can have in centimetres example: 75 type: - number - 'null' maximum_height_cm: description: >- The maximum height that the baggage can have in centimetres example: 90 type: - number - 'null' maximum_length_cm: description: >- The maximum length that the baggage can have in centimetres example: 90 type: - number - 'null' maximum_weight_kg: description: >- The maximum weight that the baggage can have in kilograms example: 23 type: - number - 'null' type: description: The type of the baggage enum: - checked - carry_on example: checked type: string required: - type title: Service Metadata for a Baggage type: object - additionalProperties: false description: > An object containing metadata about the service, like the designator of the seat. example: designator: 14B disclosures: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats name: Exit row seat properties: designator: description: > The designator used to uniquely identify the seat, usually made up of a row number and a column letter example: 14B type: string disclosures: description: > Each disclosure is text, in English, provided by the airline that describes the terms and conditions of this seat. We recommend showing this in your user interface to make sure that customers understand any restrictions and limitations. example: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats items: description: > An individual term, condition or restriction for this seat type: string type: array name: description: > A name which describes the type of seat, which you can display in your user interface to help customers to understand its features example: Exit row seat type: - string - 'null' required: - designator - name - disclosures title: Service Metadata for a Seat type: object passenger_ids: description: >- List of passenger `id`s the service applies to. The service applies to all the passengers in this list. example: - pas_00009hj8USM7Ncg31cBCLL items: type: string type: array quantity: description: The quantity of the service that was booked example: 1 minimum: 1 type: integer segment_ids: description: >- List of segment `id`s the service applies to. The service applies to all the segments in this list. example: - seg_00009hj8USM7Ncg31cB456 items: type: string type: array total_amount: description: >- The total price of the service for all passengers and segments it applies to, accounting for quantity and including taxes example: '15.00' type: string total_currency: description: > The currency of the `total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. If an offer or order is priced with balance, it matches your organisation's billing currency. If it is priced with card or airline credit, it is returned in the currency the airline charges in. If it is priced without payment methods and not using Duffel Content, it is returned in the agency point of sale currency. example: GBP format: ISO 4217 type: string type: description: > The type of the service. For now we only return services of type `baggage` and `seat` but we will return other types in the future. We won't consider adding new service types a breaking change. enum: - baggage - seat example: seat type: string required: - id - metadata - passenger_ids - quantity - segment_ids - total_amount - total_currency - type title: Order Service type: object type: array slices: description: >- The [slices](/docs/api/overview/key-concepts) that make up the itinerary of this order. One-way journeys can be expressed using one slice, whereas return trips will need two. items: additionalProperties: false properties: conditions: additionalProperties: false description: > The conditions associated with this slice, describing the kinds of modifications you can make and any penalties that will apply to those modifications. This condition is applied only to this slice and to all the passengers associated with this order - for information at the order level (e.g. "what happens if I want to change all the slices?") refer to the `conditions` at the top level. If a particular kind of modification is allowed, you may not always be able to take action through the Duffel API. In some cases, you may need to contact the Duffel support team or the airline directly. properties: change_before_departure: description: > Whether this slice can be changed before the departure. If the slice can be changed for all of the passengers then the `allowed` property will be `true` and information will be provided about any penalties. If none of the passengers on the slice can be changed then the `allowed` property will be `false`. In all other cases this property will be `null` indicating we can't provide the information for this slice. The `penalty_amount` is specific to changing this slice and may not be the penalties that is applied if the entire order is changed. properties: allowed: description: >- Whether this kind of modification is allowed post-booking example: true type: boolean penalty_amount: description: > If the modification is `allowed` then this is the amount payable to apply the modification to all passengers. If there is no penalty, the value will be zero. If the modification isn't `allowed` or the penalty is not known then this field will be `null`. If this is `null` then the `penalty_currency` will also be `null`. example: '100.00' type: - string - 'null' penalty_currency: description: > The currency of the `penalty_amount` as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This will be in a currency determined by the airline, which is not necessarily the same as the currency of the offer or order. If this is `null` then `penalty_amount` will also be `null`. example: GBP format: ISO 4217 type: - string - 'null' type: - object - 'null' required: - change_before_departure title: OrderSliceConditions type: object destination: additionalProperties: false description: The city or airport where this slice ends properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object destination_type: description: The type of the destination enum: - airport - city example: airport type: string duration: description: >- The duration of the slice, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' fare_brand_name: description: > The name of the fare brand associated with this slice. A fare brand specifies the travel conditions you get on your slice made available by the airline. e.g. a British Airways Economy Basic fare will only include a hand baggage allowance. It is worth noting that the fare brand names are defined by the airlines themselves and therefore they are subject to change without any prior notice. example: Basic type: - string - 'null' id: description: Duffel's unique identifier for the resource example: sli_00009htYpSCXrwaB9Dn123 type: string origin: additionalProperties: false description: The city or airport where this slice begins properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object origin_type: description: The type of the origin enum: - airport - city example: airport type: string segments: description: >- The segments - that is, specific flights - that the airline is offering to get the passengers from the `origin` to the `destination` items: additionalProperties: false properties: aircraft: allOf: - additionalProperties: false properties: iata_code: description: >- The three-character IATA code for the aircraft example: '380' type: string id: description: >- Duffel's unique identifier for the resource example: arc_00009UhD4ongolulWd91Ky type: string name: description: The name of the aircraft example: Airbus Industries A380 type: string required: - iata_code - id - name title: Aircraft type: object - description: >- The aircraft that the operating carrier will use to operate this segment arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to arrive, in the destination airport timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the segment is scheduled to depart, in the origin airport timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string destination: allOf: - properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: iata_code: description: >- The three-character IATA code for the city example: NYC type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: US format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_nyc_us type: string name: description: The name of the city example: New York type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: New York type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: NYC type: string iata_code: description: >- The three-character IATA code for the airport example: JFK type: - string - 'null' iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: US format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: KJFK type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_jfk_us type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 40.640556 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -73.778519 format: float type: number name: description: The name of the airport example: John F. Kennedy International Airport type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: America/New_York type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - city - iata_city_code title: Airport type: object - description: >- The airport at which the segment is scheduled to arrive destination_terminal: description: >- The terminal at the `destination` airport where the segment is scheduled to arrive example: '5' type: - string - 'null' distance: description: The distance of the segment in kilometres example: '424.2' type: - string - 'null' duration: description: >- The duration of the segment, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: seg_00009htYpSCXrwaB9Dn456 type: string marketing_carrier: additionalProperties: false description: >- The airline selling the tickets for this segment. This may differ from the `operating_carrier` in the case of a "codeshare", where one airline sells flights operated by another airline. properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object marketing_carrier_flight_number: description: >- The flight number assigned by the marketing carrier example: '1234' type: string operating_carrier: additionalProperties: false description: >- The airline actually operating this segment. This may differ from the `marketing_carrier` in the case of a "codeshare", where one airline sells flights operated by another airline. properties: conditions_of_carriage_url: description: >- URL to the airline's conditions of carriage. example: >- https://www.britishairways.com/en-gb/information/legal/british-airways/general-conditions-of-carriage type: - string - 'null' iata_code: description: >- The two-character IATA code for the airline. This may be `null` for non-IATA carriers. example: BA type: - string - 'null' id: description: >- Duffel's unique identifier for the airline example: arl_00001876aqC8c5umZmrRds type: string logo_lockup_url: description: >- Path to a svg of the airline lockup logo. A lockup logo is also called a combination logo, in which it combines the logotype and logomark. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-lockup/BA.svg type: - string - 'null' logo_symbol_url: description: >- Path to a svg of the airline logo. This may be `null` if no logo is available. example: >- https://assets.duffel.com/img/airlines/for-light-background/full-color-logo/BA.svg type: - string - 'null' name: description: The name of the airline example: British Airways type: string title: Airline type: object operating_carrier_flight_number: description: >- The flight number assigned by the operating carrier. This may not be present, in which case you should display the `marketing_carrier`'s information and the `marketing_carrier_flight_number`, and simply state the name of the `operating_carrier`. example: '4321' type: - string - 'null' origin: description: >- The airport from which the flight is scheduled to depart properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object origin_terminal: description: >- The terminal at the `origin` airport from which the segment is scheduled to depart example: B type: - string - 'null' passengers: description: >- Additional segment-specific information about the passengers included in the offer (e.g. their baggage allowance and the cabin class they will be travelling in) items: additionalProperties: false properties: baggages: description: >- The baggage allowances for the passenger on this segment that were included in the original offer. Any extra baggage items which were booked as services will be listed in the `services` field instead of here. items: properties: quantity: description: >- The number of items of baggage of the specified `type` allowed on the segment. Where no allowance information is available for a particular `type`, no entry will be present. example: 1 type: integer type: description: The type of the baggage allowance enum: - checked - carry_on example: checked type: string title: Slice Segment Passenger Baggage type: object type: array cabin_class: description: >- The cabin class that the passenger will travel in on this segment enum: - first - business - premium_economy - economy example: economy type: - string - 'null' cabin_class_marketing_name: description: >- The name that the marketing carrier uses to market this cabin class example: Economy Basic type: - string - 'null' passenger_id: description: >- The identifier for the passenger. You may have specified this ID yourself when creating the offer request, or otherwise, Duffel will have generated its own random ID. example: passenger_0 type: string seat: description: > An object containing metadata about the service, like the designator of the seat. properties: designator: description: > The designator used to uniquely identify the seat, usually made up of a row number and a column letter example: 14B type: string disclosures: description: > Each disclosure is text, in English, provided by the airline that describes the terms and conditions of this seat. We recommend showing this in your user interface to make sure that customers understand any restrictions and limitations. example: - Do not seat children in exit row seats - >- Do not seat passengers with special needs in exit row seats items: description: > An individual term, condition or restriction for this seat type: string type: array name: description: > A name which describes the type of seat, which you can display in your user interface to help customers to understand its features example: Exit row seat type: - string - 'null' title: Service Metadata for a Seat type: - object - 'null' title: Order Slice Segment Passenger type: object type: array stops: description: >- Additional segment-specific information about the stops, if any, included in the segment items: additionalProperties: false properties: airport: allOf: - additionalProperties: false properties: airports: description: >- The airports associated to a city. This will only be provided where the `type` is `city`. items: properties: city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: string iata_city_code: description: >- The three-character IATA code for the city where the airport is located example: LON type: string iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string required: - iata_code - id - name - iata_country_code - latitude - longitude - icao_code - time_zone - city_name - iata_city_code title: Airport type: object type: - array - 'null' city: description: >- The metropolitan area where the airport is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). properties: airports: description: >- List of airports associated with the city items: properties: iata_code: description: >- The three-character IATA code for the airport example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the airport is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: number longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: number name: description: The name of the airport example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: string type: object type: array iata_code: description: >- The three-character IATA code for the city example: LON type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string id: description: >- Duffel's unique identifier for the resource example: cit_lon_gb type: string name: description: The name of the city example: London type: string title: City type: - object - 'null' city_name: description: >- The name of the city (or cities separated by a `/`) where the airport is located example: London type: - string - 'null' iata_city_code: description: >- The 3-letter IATA code for the city where the place is located. Only present for airports which are registered with IATA as belonging to a [metropolitan area](https://portal.iata.org/faq/articles/en_US/FAQ/How-do-I-create-a-new-Metropolitan-Area). example: LON type: - string - 'null' iata_code: description: The 3-letter IATA code for the place example: LHR type: string iata_country_code: description: >- The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country where the city is located example: GB format: ISO 3166-1 alpha-2 type: string icao_code: description: >- The four-character ICAO code for the airport example: EGLL type: - string - 'null' id: description: >- Duffel's unique identifier for the resource example: arp_lhr_gb type: string latitude: description: >- The latitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -90° and 90° example: 64.068865 format: float type: - number - 'null' longitude: description: >- The longitude position of the airport represented in [Decimal degrees](https://en.wikipedia.org/wiki/Decimal_degrees) with 6 decimal points with a range between -180° and 180° example: -141.951519 format: float type: - number - 'null' name: description: The name of the place example: Heathrow type: string time_zone: description: >- The time zone of the airport, specified by name from the [tz database](https://en.wikipedia.org/wiki/Tz_database) example: Europe/London type: - string - 'null' type: description: The type of the place enum: - airport - city example: airport type: string required: - iata_city_code - iata_code - id - name - type - iata_country_code - latitude - longitude - icao_code - time_zone - city_name title: Place type: object - description: The airport at which the stop happens arriving_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the stop is scheduled to arrive, in the airport's timezone (see `destination.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string x-validate: Duffel.Web.NaiveDateTimeValidator departing_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the stop is scheduled to depart, in the airport's timezone (see `origin.timezone`) example: '2020-06-13T16:38:02' format: local-date-time type: string x-validate: Duffel.Web.NaiveDateTimeValidator duration: description: >- The duration of the stop, represented as a [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) duration example: PT02H26M type: string id: description: >- Duffel's unique identifier for the resource example: sto_00009htYpSCXrwaB9Dn456 type: string required: - id - airport - arriving_at - departing_at - duration title: Order Slice Segment Stop type: object type: array required: - aircraft - arriving_at - departing_at - destination - destination_terminal - distance - duration - id - marketing_carrier - marketing_carrier_flight_number - operating_carrier - origin - origin_terminal - passengers title: Order Slice Segment type: object type: array required: - destination_type - destination - origin_type - origin - duration - id - segments - conditions title: Order Slice type: object type: array synced_at: description: > Airlines are always the source of truth for orders. The orders returned in the Duffel API are a view of those orders. This field is the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order was last synced with the airline. If this datetime is in the last minute you can consider the order up to date. example: '2020-04-11T15:48:11Z' format: date-time type: string tax_amount: description: >- The amount of tax payable on the order for all the flights booked example: '30.20' type: - string - 'null' tax_breakdown: description: > The airline's breakdown of `tax_amount` by tax code. The list is empty when the airline gives us no usable itemisation. Treat an empty list as "no breakdown available" rather than "no tax". Each line is in the currency the airline quoted it in, which is given per line. Where Duffel converts the price into your billing currency, that currency differs from `tax_currency`, so the lines cannot be compared with `tax_amount` without converting them. Even in a single currency, the lines can add up to less than `tax_amount`: a line the airline quoted without a code, a currency or an amount is dropped, and some airlines itemise only part of the tax they charge. Do not reconcile against it, and do not use it to compute a total. A line's `name` is the short label for the charge and its `description` the fuller explanation of what it is and who levies it. A line's `name`, `description` and `carrier_imposed` are all nullable, and are `null` for a tax code we cannot yet classify. items: properties: amount: description: > The amount charged under this code, for all passengers. A refundable tax appears as a negative amount. example: '26.00' type: string carrier_imposed: description: > Whether the charge is set by the airline itself, rather than by a government or an airport. This is `null` for a code we cannot classify. Do not read `null` as `false`. example: false type: - boolean - 'null' code: description: > The tax code the airline used for this charge, as it was quoted to us. Codes are mostly the IATA ticket tax codes (for example `GB` for UK Air Passenger Duty), but an airline is free to quote a code that is not in that list. example: GB type: string currency: description: > The currency of the `amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. This is the currency the airline quoted the tax in. Where Duffel converts the price into your billing currency, it will differ from `tax_currency`. example: GBP format: ISO 4217 type: string description: description: > A plain-English description of what the charge is for, written by Duffel. This is `null` for a code we do not yet have a description for. It is never the airline's own wording. example: >- UK Air Passenger Duty, an excise duty charged on each passenger departing from a UK airport, banded by distance and cabin. type: - string - 'null' name: description: > A short label for the charge, written by Duffel: the country that levies it (or the airline, for a charge the airline sets itself) followed by the charge. Use it where a line item has to fit beside its amount. This is `null` for a code we do not yet have a name for. It is never the airline's own wording. example: UK Air Passenger Duty type: - string - 'null' required: - code - amount - currency - name - description - carrier_imposed title: Tax Breakdown Item type: object type: array tax_currency: description: > The currency of the `tax_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency unless you’re using Duffel as an accredited IATA agent, in which case it will be in the currency provided by the airline (which will usually be based on the country where your IATA agency is registered). example: GBP format: ISO 4217 type: - string - 'null' total_amount: description: >- The total price of the order for all the flights and services booked, including taxes example: '90.80' type: string total_currency: description: > The currency of the `total_amount`, as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. It will match your organisation's billing currency, with two exceptions. If the order was paid using a card or airline credit, it will be the currency the airline charged in, even if the offer you booked showed your billing currency. If you’re using Duffel as an accredited IATA agent, it will be the currency provided by the airline (usually based on the country where your IATA agency is registered). example: GBP format: ISO 4217 type: string type: description: The type of this order enum: - instant - hold example: instant type: - string - 'null' users: description: > The `id`s of users that are allowed to manage the order. items: example: icu_00009htyDGjIfajdNBZRlw type: string type: array void_window_ends_at: description: > Some paid orders are eligible to be voided, typically within the first 24 hours after payment. An order that is cancelled within this window is eligible for a full refund. Note that orders created near to the initial departure date i.e. within 7 days may not be eligible for void. This field is the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the shall no longer be eligible to be void, after which any refunds shall be subject to the conditions on the order. example: '2020-04-11T15:48:11Z' format: date-time type: - string - 'null' x-preview: true required: - airline_initiated_changes - base_amount - base_currency - booking_reference - cancellation - cancelled_at - changes - conditions - created_at - documents - id - live_mode - owner - passengers - payment_status - services - slices - tax_amount - tax_currency - total_amount - total_currency - metadata - synced_at - offer_id - void_window_ends_at title: Order type: object meta: type: object properties: limit: type: number before: type: string after: type: - string - 'null' description: Successful HTTP response; fixed SDK accepts response.ok. components: schemas: PublishedResponses_PreviousResponseDuffel_Order: type: object properties: id: type: string example: ord_0000BAzrYIJiDdmFJKIhcy booking_reference: type: string example: DJMT4D total_amount: type: string total_currency: type: string live_mode: type: boolean documents: type: array items: type: object properties: id: type: string type: type: string enum: - electronic_ticket unique_id: type: string available_actions: type: array items: type: string securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.