> ## 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. # Get Order Change Request > Retrieve an order change request with change offers ## OpenAPI ````yaml openapi/zh/duffel-flights.json GET /apis/v1/duffel/flights/order-change-requests/{id} 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/order-change-requests/{id}: get: tags: - duffel summary: Get Order Change Request description: Retrieve an order change request with change offers operationId: get_duffel_order_change_request responses: 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: description: >- An order change request represents a request to change slices in an existing paid order properties: created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order change request was created example: '2020-01-17T10:12:14.545Z' format: date-time type: string id: description: The ID of your order change request example: ocr_0000A3bQP9RLVfNUcdpLpw type: string 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 order_change_offers: description: >- The list of the offers available to perform change on the order. items: description: >- An order change offer represents flights that can be used to replace a slice in an existing paid order properties: change_total_amount: description: > The amount that will be charged or returned to the original payment method if refunded, determined according to the fare conditions. This may be negative to reflect a refund. example: '90.80' 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 - 'null' conditions: description: > The conditions associated with this offer, describing the kinds of modifications you can make post-booking 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 offer - 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 offer can be changed before the departure of the first slice. If all of the slices on the offer 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 offer 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 offer is changeable. If the airline hasn't provided any information about whether this offer 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 offer can be refunded before the departure of the first slice. If all of the slices on the offer 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 offer can't be refunded then the `allowed` property will be `false`. If the airline hasn't provided any information about whether this offer 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: OfferConditions type: object created_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was created example: '2020-01-17T10:12:14.545Z' format: date-time type: string expires_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer will expire and no longer be usable to create an order example: '2020-01-17T10:42:14.545Z' format: date-time type: string id: description: Duffel's unique identifier for the resource example: oco_0000A3vUda8dKRtUSQPSXw type: string live_mode: description: >- Whether the order change offer was created in live mode. This field will be set to `true` if the order change offer was created in live mode, or `false` if it was created in test mode. example: false type: boolean new_total_amount: description: >- The price of this offer if it was newly purchased example: '35.50' type: - string - 'null' 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 type: string order_change_id: description: >- The ID for an order change if one has already been created from this order change offer example: oce_0000A4QasEUIjJ6jHKfhHU type: - string - 'null' penalty_total_amount: description: >- The penalty imposed by the airline for making this change example: '10.50' type: - string - 'null' 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 - 'null' private_fares: description: The private fares applied on this offer. items: properties: corporate_code: description: >- The corporate code that was applied, if any example: FLX53 type: - string - 'null' tour_code: description: The tour code that was applied, if any example: 578DFL type: - string - 'null' tracking_reference: description: >- The tracking reference that was applied, if any example: ABN:2345678 type: - string - 'null' type: description: The type of private fare applied enum: - corporate - leisure - negotiated example: corporate type: string required: - type - corporate_code - tracking_reference - tour_code title: Offer Private Fares type: object type: array refund_to: description: | Where the refund, once confirmed, will be sent. enum: - original_form_of_payment - airline_credits - voucher type: string 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 updated_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the offer was last updated example: '2020-01-17T10:12:14.545Z' format: date-time type: string required: - change_total_amount - change_total_currency - created_at - updated_at - expires_at - id - new_total_amount - new_total_currency - live_mode - penalty_total_amount - penalty_total_currency - conditions - private_fares - slices - refund_to - order_change_id title: Order Change Offer type: object type: array order_id: description: The order ID that you want to change example: ord_0000A3bQ8FJIQoEfuC07n6 type: string slices: description: The slices to be added and/or removed properties: add: description: The slices to be added items: properties: cabin_class: description: >- The cabin that the passengers want to travel in enum: - first - business - premium_economy - economy example: economy type: - string - 'null' departure_date: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the passengers want to depart example: '2020-04-24' format: date type: string destination: description: The 3-letter IATA code for the place example: LHR type: string origin: description: The 3-letter IATA code for the place example: LHR type: string type: object type: array remove: description: The slices to be removed items: properties: slice_id: description: Duffel's unique identifier for the resource example: xxx_00009hthhsUZ8W4LxQgkjo type: string type: object type: array type: object updated_at: description: >- The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime at which the order change request was last updated example: '2020-01-17T10:12:14.545Z' format: date-time type: string title: Order Change Request 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: securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.