List fare brands

POST

api

flights

fare-brands

curl -X POST "https://api.staging.ttool.travel/hub/api/v1/flights/fare-brands" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "requestId": "3f1a1c9e-7b2d-4c7e-9a1f-2b3c4d5e6f70", "proposalId": "8d0e3b6a-2f41-4b8e-b1c9-5d6e7f8a9b0c" }'

{
  "successful": true,
  "isCombination": false,
  "leavingFareOptions": [
    {
      "title": "Value",
      "code": "VALUE",
      "price": 436.00,
      "description": "Checked bag included",
      "fareOptions": ["1 x 23kg checked bag", "Seat selection"],
      "services": [
        { "title": "Checked baggage", "description": "23 kg", "inclusionType": 1 },
        { "title": "Refund", "description": "With fee", "inclusionType": 2 }
      ]
    }
  ],
  "returningFareOptions": []
}

Only call this when offer.hasFareBrands is true. See Fare families.

Body

string (uuid)

required

requestId from search.

string (uuid)

required

The offer’s offerId.

Response

boolean

true when outbound and return brands must be chosen together. There’s then one key for the whole trip, in leavingFareOptions.

FareBrand[]

Show properties

string

For example Value.

string

The brand key. Pass it to change-options as fareBrandCode. Its format is airline-specific (a name, a number, a token), so treat it as opaque.

number

Total price of the offer with this brand.

string

string[]

Short feature lines for display.

object[]

title, description, inclusionType: 0 not available, 1 included, 2 for a fee.

FareBrand[]

Return-leg brands for a packed round trip priced per leg.

Errors

HTTP	`errorCode`	Action
404	`FARE_BRANDS_NOT_AVAILABLE`	No fare families for this offer. Use the base fare.
502	`FARE_BRANDS_SERVICE_UNAVAILABLE`	Retry with back-off.

curl -X POST "https://api.staging.ttool.travel/hub/api/v1/flights/fare-brands" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "requestId": "3f1a1c9e-7b2d-4c7e-9a1f-2b3c4d5e6f70", "proposalId": "8d0e3b6a-2f41-4b8e-b1c9-5d6e7f8a9b0c" }'

{
  "successful": true,
  "isCombination": false,
  "leavingFareOptions": [
    {
      "title": "Value",
      "code": "VALUE",
      "price": 436.00,
      "description": "Checked bag included",
      "fareOptions": ["1 x 23kg checked bag", "Seat selection"],
      "services": [
        { "title": "Checked baggage", "description": "23 kg", "inclusionType": 1 },
        { "title": "Refund", "description": "With fee", "inclusionType": 2 }
      ]
    }
  ],
  "returningFareOptions": []
}

curl -X POST "https://api.staging.ttool.travel/hub/api/v1/flights/fare-brands" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "requestId": "3f1a1c9e-7b2d-4c7e-9a1f-2b3c4d5e6f70", "proposalId": "8d0e3b6a-2f41-4b8e-b1c9-5d6e7f8a9b0c" }'

{
  "successful": true,
  "isCombination": false,
  "leavingFareOptions": [
    {
      "title": "Value",
      "code": "VALUE",
      "price": 436.00,
      "description": "Checked bag included",
      "fareOptions": ["1 x 23kg checked bag", "Seat selection"],
      "services": [
        { "title": "Checked baggage", "description": "23 kg", "inclusionType": 1 },
        { "title": "Refund", "description": "With fee", "inclusionType": 2 }
      ]
    }
  ],
  "returningFareOptions": []
}

Get started

Guides

Reference

API endpoints

Body

Response

Errors

​Body

​Response

​Errors

Body

Response

Errors