GET/v1/transfers/amenities

List transfer amenities

Retrieve the localized amenity catalog you can offer alongside a transfer.

GET/v1/transfers/amenities

API console

Try it

Send a real request to the sandbox API and inspect the response.

Credentials

Profile code

Public key

Secret key

Query parameters

2 fields

currencystring ISO 4217Optional

Currency

Currency of the returned amounts. Must match the offer or reservation when one already exists.

languagestringOptional

Language

Legacy language field. Prefer the LANG or Accept-Language header.

cURL request

cURL

bash

curl -X GET 'https://api.sandbox.travelandz.com/v1/transfers/amenities?currency=USD' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE'

Add your credentials to send a request.

Response

Click "Try it!" to send a request and see the response here.

Retrieve the localized amenity catalog you can offer alongside a transfer.

Authentication and headers

Header	Description
`Authorization`	`Bearer <secret_key>`. Keep the secret on the server and never write it to client logs.
`X-Travelandz-Id`	`<public_key>:<profile_code>`, where the persisted profile code has the form `dp_<12 alphanumeric>`.
`LANG`	Preferred locale header. `Accept-Language` is also supported.
`Content-Type`	`application/json` for requests with a JSON body.

Request

This endpoint takes no body. Every query parameter is optional.

Request Query Params Schema

currency

enum

EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN

Lowercase values are accepted and normalized. Defaults to USD on a new search and is inherited afterwards.

language

enum

en-USes-ESde-DEfr-FRpt-BRzh-CNit-IT

Legacy field. Prefer the LANG or Accept-Language header.

Success response

Returns the catalog as a top-level JSON array. The key of each entry is what you send in selectedAmenities when you request pricing.

This endpoint does not return prices. The cost of a selection is only known after pricing.

Response Body Schema

key

stringYes

Value to send in selectedAmenities.

name

stringYes

Localized name.

description

stringNo

imageUrl

string

Format: URL

pngImageUrl

string

Format: URL

inputType

enum

booleannumeric

included

booleanYes

True when the amenity is already part of the offer.

selectable

booleanYes

True when the amenity can be added to this offer.

Response examples

json

[
  {
    "key": "baby_seats",
    "name": "Baby seats",
    "description": "Your vehicle will have a child safety seat to keep children under age 4 safe.",
    "imageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/baby-seats.svg",
    "pngImageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/baby-seats.png",
    "inputType": "numeric",
    "included": false,
    "selectable": true
  },
  {
    "key": "child_booster",
    "name": "Child booster",
    "description": "Your vehicle will have a child booster seat to keep children from age 4-8 safe.",
    "imageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/child-booster.svg",
    "pngImageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/child-booster.png",
    "inputType": "numeric",
    "included": false,
    "selectable": true
  },
  {
    "key": "sms_notifications",
    "name": "SMS notifications",
    "inputType": "boolean",
    "included": false,
    "selectable": true
  }
]

Errors

HTTP	Code	Meaning	Recommended action
`400`		The body, query or path is invalid, or contains an unknown property.	Fix the request using the `message` array.
`400`	`transfer_invalid_currency`	The currency is outside the supported list.	Use a supported currency.
`400`	`transfer_invalid_language`	The requested language is not supported.	Use one of the documented language values.
`429`	`transfer_provider_error`	The service is temporarily rate limited.	Retry with exponential backoff.
`502`	`transfer_provider_error`	The request could not be completed.	Do not assume success. Keep your identifiers and read the reservation when the operation could have been created.

Usage notes

An offer can already include some amenities. Check included and selectable on the offer itself before showing this catalog as a list of add-ons.

cURL example

bash

curl --request GET \
  --url "https://api.sandbox.travelandz.com/v1/transfers/amenities?currency=USD" \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"