Last updated 10 minutes ago

Airlines Endpoint

The Airlines endpoint provides data for custom UPA categories and brands available for a given carrier.

The Airlines endpoint is tied exclusively to your Channel UID (a unique string related to your account), and the access allowed to that account. If your Channel UID has access to a specific set of carriers — say "XX", "AA", "BB" and "CC" — then the response from the Airlines endpoint will include the custom UPA categories and brand information only for those carriers.

GET /airlines

Response structure

Main structure:

Attributes Type Description/Values
airlines array A list of all airlines accessible by this account. Elements conform to the "Airline structure," below

Airline structure:

Attributes Type Description/Values
id string The airline IATA code for this entry.
upa_categories array A list of all custom categories created by this airline. Elements conform to the "UPA Category structure," below.
fare_types array A list of all brands available for this airline. Elements conform to the "Fare Type structure," below.

UPA Category structure:

Attributes Type Description/Values
id string The category ID as a machine readable format that can be used in either the Hub BC endpoint or Consolidated endpoint request structure.
name string The name of the category in human-readable format.

Fare Type structure:

Attributes Type Description/Values
id integer A sequence number for the brand.
name string The name of the brand in human-readable format.

Example response

{
	"airlines": [
		{
			"id": "AA",
			"upa_categories": [
				{
					"id": "some-upa-cat",
					"name": "Some custom UPA category"
				}
			],
			"fare_types": [
				{
					"id": 7094,
					"name": "MAIN CABIN SPECIAL OFFER"
				}
			]
		}
	]
}