Consolidated Routehappy Endpoint

The Consolidated Routehappy endpoint provides access to all Routehappy Content types - Amenities, UPAs, and UTAs - from a single request, with a new schema and new functionality compared with the previous Routehappy Rich Content APIs.

Request parameters

The top-level parameters in a request to the Consolidated Routehappy endpoint are req_id, acct_code, control, currency, data, pcc, travel_agency_id, and office_id. Much of the definition of your request will fall within the control and data parameters.

Channels that provide security codes need to use just one of pcc, travel_agency_id or office_id, they are not required to pass all three at the same time. In case more than one of the fields are provided at the same time, pcc will take precedence over travel_agency_id, and travel_agency_id will take precedence over office_id.

Request identifier

Use the req_id parameter when you need to tie any request to its response with your own string. The response returns a field with the same value as passed in the request. Please note that the uniqueness of this value is your responsibility.

Example

To receive a response to this request containing your unique string, include the req_id field in the request as such:

{
    "req_id": "some_unique_string",
    "data": {
        "itineraries": [
            {
                "segments": [
                    {
                        "arr": "TPE",
                        "cabin": 3,
                        "cxr": "BR",
                        "date": "2022-09-08",
                        "dep": "CDG",
                        "fltno": 88,
                        "rbd": "C"
                    }
                ]
            }
        ]
    }
}

In return, you'd get something similar to:

{
    "req_id": "some_unique_string",
    "data": {
        "advance_change": [],
        "amenity": {
            "aircrafts": [
                {
                    "cabin_pressure": "normal",
                    "display_text": "777 (widebody)",
                    "id": "3",
                    "model": "777",
                    "quality": "standard",
                    "type": "widebody",
                    "updated_at": "2016-05-31T10:00:47Z",
                    "window_size": "standard"
                }
            ],
    // ...

Control parameters

Control parameters are all specified within a control object in the request body and describe the specifications of the types of Routehappy Content to be included in the response.

{
	"control" : {
		// control parameters go here
	},
	// ...
}

Amenities control

UPAs control

Segments Control

UTAs control

Data parameters

Data parameters are all specified within a data object in the request body and describe the specifications of the requested tickets/reservations.

{
	// ...
	"data" : {
		// control parameters go here
	},
	// ...
}

Itinerary parameters

Itinerary parameters reside within the itineraries array and describe the specification of single itinerary.

Segment parameters

Segment parameters reside within the segments array and describe the specification of a single segment.

Header controls

Some settings are controlled by the headers, which are for general usage and not tightly related to the itineraries.

Example of using both headers in a request:

curl --location --request POST 'https://retailing.apis.atpco.net/retailing/consolidated' \
--header 'Content-Type: application/json' \
--header 'x-seller-id: 12345678' \
--header 'Accept-Language: en-UK' \
--header 'Authorization: Bearer token'\
--data-raw '{
    "data": {
        "itineraries": [
            {
                "segments": [
                    {
                        "dep": "IAD",
                        "arr": "MUC",
                        "cxr": "UA",
                        "fltno": 106,
                        "date": "2022-06-17",
                        "cabin": 1,
                        "fbc": "HH346LGT",
                        "rbd": "H"
                    }
                ]
            }
        ]
    }
}'