Car Retrieve Booking API

Guidance and examples for accessing the Car Retrieve Booking API

The Car Retrieve Booking API allows you to retrieve the details of an Expedia booking, whether booking was done via Booking API or on the Expedia website.

Endpoint

MethodEndpointPrerequisites*
GEThttps://apim.expedia.com/cars/bookings/[TripNumber]An active TripNumber from the Car Booking API.

Required Headers

Key:Expedia API key
Authorization:Expedia API Authorization String
Accept:application/vnd.exp-car.v3+json
User-Id:username@domain.com

The email address associated to the booking.

Partner-Transaction-Id:Partner TransactionID String

Next Steps

  • Cancel a car booking via Car Cancel API.

Example of Car Retrieve Request

Request

https://apim.expedia.com/cars/bookings/71184721958

Example of Retrieve Booking Response

{
    "TransactionId": "f06edfa3-27f4-44e6-838c-b8dd3d0a3210",
    "ItineraryNumber": 7152088262,
    "SupplierConfirmationNumber": "abcdjjggdd",
    "Status": "Cancelled",
    "BookingDateTime": "2016-11-21T02:05:00+0000",
    "LastUpdateDateTime": "2016-11-21T03:05:00+00:00",
        "BillingDetails": {
        "CreditCard": {
            "CardNumber": "XXXXXXXXXXXX4448",
            "CardType": "Visa"
        }
    },
    "TokenizedPaymentDetails": {
        "FpanPaymentInstrumentId": "5D4F566D-9C6D-701B-E2B6-DC0D22D985EC"
    },
    "TripStartDateTime": "2021-13-02T15:40:00-08:00",
    "TripEndDateTime": "2021-23-02T15:40:00-08:00",
    "CarDetails": {
        "VehicleDetails": {
            "Make": "Kia Rio",
            "CarClass": "Economy 2/4Door Car",
            "MinDoors": 4,
            "MaxDoors": 4,
            "FuelLevel": "Full to Full",
            "CarCategory": {
                "Code": "M",
                "Value": "Mini"
            },
            "CarType": {
                "Code": "M",
                "Value": "2/4 Door"
            },
            "TransmissionDrive": {
                "Code": "M",
                "Value": "Manual AWD"
            },
            "FuelAC": {
                "Code": "D",
                "Value": "Diesel Air"
            },
            "Capacity": {
                "AdultCount": 4,
                "ChildCount": 0,
                "SmallLuggageCount": 2,
                "LargeLuggageCount": 1
            }
        },
        "Supplier": {
            "Id": "6",
            "Name": "Alamo Rent A Car",
            "Code": "AL"
        },
        "PickupDetails": {
            "DateTime": "2021-07-05T10:00:00",
            "ShuttleCategory": "AirportShuttleToCounterAndCar",
            "Location": {
                "Code": "SEA",
                "LocationId": "SEAT001",
                "Address": {
                    "Address1": "99 Union St",
                    "Address2": "123",
                    "City": "Seattle",
                    "Province": "WA",
                    "Country": "USA"
                },
                "GeoLocation": {
                    "Latitude": "47.60772",
                    "Longitude": "-122.33936"
                }
            }
        },
        "DropOffDetails": {
            "DateTime": "2021-07-05T10:00:00",
            "ShuttleCategory": "AirportShuttleToCounterAndCar",
            "Location": {
                "Code": "SEA",
                "LocationId": "SEAT001",
                "Address": {
                    "Address1": "99 Union St",
                    "Address2": "123",
                    "City": "Seattle",
                    "Province": "WA",
                    "Country": "USA"
                },
                "GeoLocation": {
                    "Latitude": "47.60772",
                    "Longitude": "-122.33936"
                }
            }
        },
        "RateDetails": {
            "RatePeriod": "Daily",
            "RateCode": "A3D10",
            "Prepay": false,
            "CreditCardRequired": false,
            "Discounts": [
                {
                    "Type": "CouponCode",
                    "Code": "G811490"
                },
                {
                    "Type": "CorpDiscountCode",
                    "Code": "C811490"
                }
            ],
            "Mileages": [
                {
                    "FreeDistance": {
                        "Value": "12",
                        "Unit": "KM"
                    },
                    "FreeDistanceRatePeriod": "Daily",
                    "ExtraCostPerDistance": {
                        "Distance": {
                            "Value": "1",
                            "Unit": "KM"
                        },
                        "Cost": {
                            "Value": "12.36",
                            "Currency": "USD"
                        }
                    }
                },
                {
                    "FreeDistance": {
                        "Value": "12",
                        "Unit": "KM"
                    },
                    "FreeDistanceRatePeriod": "ExtraHour",
                    "ExtraCostPerDistance": {
                        "Distance": {
                            "Value": "1",
                            "Unit": "KM"
                        },
                        "Cost": {
                            "Value": "12.36",
                            "Currency": "USD"
                        }
                    }
                }
            ]
        },
        "Price": {
            "RatePeriodUnitPrice": {
                "Value": "99.00",
                "Currency": "USD",
                "LocalCurrencyPrice": {
                    "Value": "83.73",
                    "Currency": "EUR"
                }
            },
            "BasePrice": {
                "Value": "198.00",
                "Currency": "USD",
                "LocalCurrencyPrice": {
                    "Value": "167.45",
                    "Currency": "EUR"
                }
            },
            "TaxesAndFees": {
                "Value": "10.00",
                "Currency": "USD",
                "LocalCurrencyPrice": {
                    "Value": "8.46",
                    "Currency": "EUR"
                }
            },
             "TotalPriceDueAtBooking": {
                "Value": "406.48",
                "Currency": "USD",
                "LocalCurrencyPrice": {
                    "Value": "343.77",
                    "Currency": "EUR"
                }
            },
            "TotalPrice": {
                "Value": "406.48",
                "Currency": "USD",
                "LocalCurrencyPrice": {
                    "Value": "343.77",
                    "Currency": "EUR"
                }
            }
        },
        "TaxesAndFeesDetails": [
            {
                "Description": "Percent, PREMIUM LOCATION FEE",
                "Amount": {
                    "Value": "10.00",
                    "Currency": "USD",
                    "LocalCurrencyPrice": {
                        "Value": "8.46",
                        "Currency": "EUR"
                    }
                }
            },
            {
                "Description": "Percent, VALUE ADDED TAX",
                "Amount": {
                    "Value": "12.21",
                    "Currency": "USD",
                    "LocalCurrencyPrice": {
                        "Value": "10.33",
                        "Currency": "EUR"
                    }
                }
            }
 
        ],
        "ExtraFeesDetails": [
        {
            "Unit": "ExtraDaily",
            "UnitCount": 1,
            "Amount": {
                "Value": "23.57",
                "Currency": "USD",
                "LocalCurrencyPrice": {
                    "Value": "17.85",
                    "Currency": "GBP"
                }
            }
        }],
        "AdditionalFees": [
            {
                "IsRequired": true,
                "FinanceCategory": "Fee",
                "FinanceSubCategory": "Drop",
                "Amount": {
                    "Value": "325.07",
                    "Currency": "USD",
                    "LocalCurrencyPrice": {
                        "Value": "274.92",
                        "Currency": "EUR"
                    }
                },
                "Description": "DropOffCharge"
            }
        ],
        "SpecialEquipments": [
          {
                "Code": "AdditionalDriver",
                "Name": "Additional driver",
                "RatePeriod": "Daily",
                "BookingStatus": "Unconfirmed",
                "Price": {
                    "Value": "12.58",
                    "Currency": "USD"
                }
            }
       ],
        "RentalLimits": {
            "MinDuration": {
                "Unit": "Day",
                "Count": 1
            },
            "MaxDuration": {
                "Unit": "Day",
                "Count": 1
            }
        },
        "CancellationPolicy": {
            "Cancellable": true,
            "FreeCancellation": true,
            "FreeCancellationEndDateTime": "2020-12-27T10:00:00"
        },
        "CarPolicies": [
            {
                "CategoryCode": "Guarantee",
                "PolicyText": "Credit card required."
            },
            {
                "CategoryCode": "CreditCard",
                "PolicyText": "Credit cards acceptable for deposit, ax ba ca dc ds mc vi. credit cards acceptable for guarantee ax ba ca dc ds mc vi "
            }
        ],
        "Images": [
            {
                "Type": "Thumbnail",
                "Size": "t",
                 "Href": "https://images.trvl-media.com/cars/41/ZI_USA_Ford_Edge_SF_20160706_t.jpg"
             },
             {
                "Type": "Image",
                "Size": "s",
                  "Href": "https://images.trvl-media.com/cars/41/ZI_USA_Ford_Edge_SF_20160706_s.jpg"
              }
        ]
    },
    "Travelers": [{
        "Primary": true,
        "Name": {
            "FirstName": "John",
            "LastName": "Doe",
            "MiddleName": "Edward"
        },
        "Phone": {
            "CountryCode": 1,
            "AreaCode": 206,
            "Number": 9876543
        },
        "Email": "john.doe@gmail.com"
    }],
    "Links": {
        "WebItinRetrieve": {
            "Href": "https://www.expedia.com/1234567"
        },
        "ApiCancel": {
            "Accept": "application/vnd.exp-booking.v3+json",
            "Method": "PUT",
            "Href": "https://apim.expedia.com/cars/bookings/12345"
        }
    },
    "PartnerMetaData": {
        "MetaDataKey": "MetaDataValue"
    }
}

Error Codes

Common Error Codes

HTTP Status CodeError CodeError Message
400UNKNOWN_PATHUnknown request path.
400INVALID_ACCEPT Accept is either missing or invalid. Please provide a correct Accept header as following: Accept:application/vnd.exp-<product>.<version>+<format> (product={car,flight,hotel},version={v3},format={json}).
400Only one Accept header is allowed.
400INVALID_PARTNER_TRANSACTION_ID Partner-Transaction-Id is missing.
400Only one Partner-Transaction-Id header is allowed.
400INVALID_CLIENT_KEY Invalid client key: XXX.
400Only one Key header is allowed.
400INVALID_USER_ID User-Id in http headers is missing or invalid. It must be a valid email.
400Only one User-Id header is allowed.
400INVALID_USER_CREDENTIALSUser credentials are either missing or invalid.
400ITINERARY_NOT_FOUNDThe itinerary was not found. Please provide valid user-id and tripNumber.
400RETRIEVE_ITINERARY_ERRORUnable to retrieve data for tripNumber XXX. Please try again later.
400INVALID_CURRENCYCurrency is either missing or invalid.
400INVALID_ITINERARY_NUMBERThe itinerary number is either missing or invalid. Itinerary Number :%s
400ITIN_NOT_ASSOCIATED_WITH_CLIENT_KEYThe itinerary is not associated with client key.
400UNSUPPORTED_PACKAGE_TYPERequested Product/Products are not supported for %s trip.
500RETRIEVE_APPLICATION_ERRORRetrieve Failed. Application Error.

Warning Codes

Common Warning Codes

CodeMessageDescription
UNSUPPORTED_PRODUCT_TYPEThis booking contains unsupported product types: xxx. Only product type Car is processed by our API. Please handle xxx separately.This warning is returned when booked with unsupported products.

API details

Here, you can explore the endpoint definitions for this API, then go to the API Explorer to try out all the XAP endpoints, download OpenAPI specs, or download our Postman collections. Testing with one or all of these options will give you an understanding of how the examples and schema definitions compare to the actual output.


Did you find this page helpful?
How can we improve this content?
Thank you for helping us improve!