Amadeus · Schema

Equipment

extra equipment information

TravelTravel TechnologyReservationsFlightsHotelsAirlinesHospitalityTours and ActivitiesCars and TransfersDestination ContentItinerary ManagementTrip PlanningArtificial IntelligenceMarket Insights

Properties

Name Type Description
code string extra equipment codes, which can take following values code | name ------ | ------------------------------------- BBS | Baby stroller/Push chair BYC | Bicycle rack CBB | Cargo barrier rack CBF | Cargo
itemId string extra equipment identifier
description string extra equipment description
quotation object quotation representing a price valuation and its components. The monetaryAmount at the root are the sum of base and all the taxes/fees/discounts
converted object quotation representing a price valuation and its components. The monetaryAmount at the root are the sum of base and all the taxes/fees/discounts
isBookable boolean true if extra equipment is available for booking
taxIncluded boolean true if tax included in extra equipment price
includedInTotal boolean true if extra equipment price is included in total transfer amount
View JSON Schema on GitHub

JSON Schema

transfer-search-equipment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amadeus/refs/heads/main/json-schema/transfer-search-equipment-schema.json",
  "title": "Equipment",
  "description": "extra equipment information",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "extra equipment codes, which can take following values\n\ncode   | name                                 \n------ | -------------------------------------  \nBBS    | Baby stroller/Push chair\nBYC    | Bicycle rack\nCBB    | Cargo barrier rack\nCBF    | Cargo barrier front\nCBS    | Booster seat for child under 135cm or up to 12 years\nCSB    | Child seat determined by weight/age of child 1-3 years / 9-18 Kg\nCSI    | Child seat determined by weight/age of child 0-12 month/0-13Kg\nCST    | Child seat determined by weight/age of child 4-7 years/15 \u2013 30 Kg\nSBR    | Snow board racks\nSKB    | Ski box\nSKR    | Ski rack\nTAB    | Travel Tablet \nWAR    | Wheelchair access ramp\nWHC    | Wheelchair\nWIF    | Wi-Fi access\nCNT    | Charger cable\n",
      "enum": [
        "BBS",
        "BYC",
        "CBB",
        "CBF",
        "CBS",
        "CSB",
        "CSI",
        "CST",
        "SBR",
        "SKB",
        "SKR",
        "TAB ",
        "WAR",
        "WHC",
        "WIF",
        "CNT"
      ],
      "example": "BBS"
    },
    "itemId": {
      "type": "string",
      "description": "extra equipment identifier",
      "example": "12345"
    },
    "description": {
      "type": "string",
      "description": "extra equipment description",
      "example": "Sample description text."
    },
    "quotation": {
      "description": "quotation representing a price valuation and its components. The monetaryAmount at the root are the sum of base and all the taxes/fees/discounts",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "monetaryAmount": {
              "type": "string",
              "example": "10.5"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "currencyCode": {
              "type": "string",
              "example": "USD"
            },
            "isEstimated": {
              "type": "boolean",
              "description": "indicates if the price is pre-estimated prior to ride. Becomes mandatory for transferType = TAXI"
            },
            "base": {
              "description": "base price",
              "allOf": [
                {
                  "$ref": "#/definitions/PointsAndCash"
                }
              ]
            },
            "discount": {
              "description": "discount amount of base price",
              "allOf": [
                {
                  "$ref": "#/definitions/PointsAndCash"
                }
              ]
            },
            "taxes": {
              "description": "Taxes breakdown",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tax"
              }
            },
            "fees": {
              "description": "Fees breakdown",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Fee"
              }
            },
            "totalTaxes": {
              "$ref": "#/definitions/PointsAndCash"
            },
            "totalFees": {
              "$ref": "#/definitions/PointsAndCash"
            }
          }
        }
      ]
    },
    "converted": {
      "description": "quotation representing a price valuation and its components. The monetaryAmount at the root are the sum of base and all the taxes/fees/discounts",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "monetaryAmount": {
              "type": "string",
              "example": "10.5"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "currencyCode": {
              "type": "string",
              "example": "USD"
            },
            "isEstimated": {
              "type": "boolean",
              "description": "indicates if the price is pre-estimated prior to ride. Becomes mandatory for transferType = TAXI"
            },
            "base": {
              "description": "base price",
              "allOf": [
                {
                  "$ref": "#/definitions/PointsAndCash"
                }
              ]
            },
            "discount": {
              "description": "discount amount of base price",
              "allOf": [
                {
                  "$ref": "#/definitions/PointsAndCash"
                }
              ]
            },
            "taxes": {
              "description": "Taxes breakdown",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Tax"
              }
            },
            "fees": {
              "description": "Fees breakdown",
              "type": "array",
              "items": {
                "$ref": "#/definitions/Fee"
              }
            },
            "totalTaxes": {
              "$ref": "#/definitions/PointsAndCash"
            },
            "totalFees": {
              "$ref": "#/definitions/PointsAndCash"
            }
          }
        }
      ]
    },
    "isBookable": {
      "type": "boolean",
      "description": "true if extra equipment is available for booking",
      "example": true
    },
    "taxIncluded": {
      "type": "boolean",
      "description": "true if tax included in extra equipment price",
      "example": true
    },
    "includedInTotal": {
      "type": "boolean",
      "description": "true if extra equipment price is included in total transfer amount",
      "example": "199.50"
    }
  },
  "required": [
    "code"
  ]
}