Reservation Display Sequence API Reference

PUT

book/reservation/reservations/{workbenchID}/reservationdisplaysequence 

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

Base path:

Pre-production https://api.pp.travelport.net/11/air/

Production https://api.travelport.net/11/air/

Related Content: Booking Guide

Existing GDS reservation only.

To manually reorder segments, initiate a workbench, send the Reservation Display Sequence request with the new displaySequence values, then commit the workbench. Manually reordering segments is a standalone workflow. No other modifications to the booking are allowed within the workbench.

Request

As part of the request requirements, also see Authentication and Common Flights API Headers.

Query Parameters

None.

Request Body

Object

Description

Required/Optional

ReservationDisplaySequence

Empty top level object.

Paste the ReservationDisplaySequence object copied from a reservation retrieve response, then change the displaySequence values to reflect the desired order.

Includes DisplaySequence object. May include AuxiliaryDisplaySequence, UnpricedSegmentDisplaySequence.

Required

DisplaySequence

One instance for each air, hotel, or car offer on the booking. Includes the following:

displaySequence: Update this value to reflect the desired segment order.

All other information from the retrieve response remains the same.

Required

AuxiliaryDisplaySequence

Returned if a booking includes auxiliary segments per above. One instance for each tour or surface segment on the booking. Includes the following:

displaySequence: Update this value to reflect the desired segment order.

All other information from the retrieve response remains the same.

Required if part of the booking

Response

A successful response returns the ReservationDisplaySequence with updated displaySequence values.

Error conditions

If a request to reorder a booking with NDC content, the following error is returned: RESERVATION DISPLAY SEQUENCE UPDATE IS ONLY SUPPORTED FOR GDS CONTENT SOURCE DURING POST COMMIT WORKFLOW.

If a request attempts to reorder segments that do not match the existing booking, the following error is returned: RESERVATION DISPLAY SEQUENCE IDENTIFIER VALUES MUST MATCH WITH THE RESERVATION WORKBENCH ID/IDENTIFIER VALUES.

Example Request

This request flips the order of segments 2 and 3. 

{
  "ReservationDisplaySequence": {
    "@type": "ReservationDisplaySequence",
    "DisplaySequence": [
      {
        "@type": "DisplaySequence",
        "displaySequence": 1,
        "OfferRef": "offer_1",
        "ProductRef": "product_1",
        "Sequence": 1
      },
      {
        "@type": "DisplaySequence",
        "displaySequence": 3,
        "OfferRef": "offer_1",
        "ProductRef": "product_2",
        "Sequence": 2
      },
      {
        "@type": "DisplaySequence",
        "displaySequence": 2,
        "OfferRef": "offer_2",
        "ProductRef": "product_1"
      }
    ],
    "AuxiliaryDisplaySequence": [
      {
        "@type": "AuxiliaryDisplaySequence",
        "displaySequence": 4,
        "CustomAuxiliarySegmentRef": "customAuxiliarySegment_1"
      }
    ]
  }
}

Example Response

The entire reservation is returned in the response. This example shows only the ReservationDisplaySequence object.

{...
    "ReservationDisplaySequence": {
    "@type": "ReservationDisplaySequence",
    "DisplaySequence": [
      {
        "@type": "DisplaySequence",
        "displaySequence": 1,
        "OfferRef": "offer_1",
        "ProductRef": "product_1",
        "Sequence": 1
      },
      {
        "@type": "DisplaySequence",
        "displaySequence": 2,
        "OfferRef": "offer_2",
        "ProductRef": "product_1"
      },
      {
        "@type": "DisplaySequence",
        "displaySequence": 3,
        "OfferRef": "offer_1",
        "ProductRef": "product_2",
        "Sequence": 3
      }
    ],
    "AuxiliaryDisplaySequence": [
      {
        "@type": "AuxiliaryDisplaySequence",
        "displaySequence": 4,
        "CustomAuxiliarySegmentRef": "customAuxiliarySegment_1"
      }
    ]
  }
...}