PickUps

This method is used to obtain a PICKUPS portfolio.

Pickups Request

Endpoint

GET https://api.test.hotelbeds.com/transfer-cache-api/1.0/pickups?fields= {{FIELDS}} &language= {{LANG}} &codes= {{CODES}} &OFFSET= {{OFFSET}} &limit= {{LIMIT}}
TIMEOUT: 60 seconds

 

Request parameters

Name Type Description
fields String Comma separated list of response fields to return (mandatory)
language String ISO 639-1 (2 digit) Language code (mandatory)
codes String Comma separated list of Pickup codes (optional)
offset int it's the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value (optional)
limit int allows you to set the number of objects returned in one page (optional)

Request Example

https://api.test.hotelbeds.com/transfer-cache-api/1.0/pickups?fields=ALL&language=en&offset=124&limit=2

 

Pickups Response

The response of Pickups provides information of the available pickup points

Response Parameters

Name Type Description
code Integer Pickup code
name String Pickup Name
hotelCode String Code of the hotel associated to the pickup point (can be null)
isTerminal String "S" or "N" Indicates if the pickup corresponds to a terminal
companyCode String Code of the company that provides the service
officeCode Integer Code of the office of the company that provides the service
receptiveCode Integer Code of the receptive of the office that provides the service
serviceType String Type of service
countryCode String Country where the service is provided
providerCode String Code of the service provider
address String Address of the pickup point
city String Name of the city where the service is provided
postalCode String Postal code of the city where the service is provided
zoneCode String Internal code of the zone where the service is provided
latitude Float Latitude data for geolocation
longitude Float Longitude data for geolocation
webCheckpickup Boolean indicates whether the user needs to check pickup time on external website

Response JSON Example

[
  {
      "code": 820,
      "name": "Arrival Gate ACE",
      "hotelCode": null,
      "isTerminal": "S",
      "companyCode": "E10",
      "officeCode": 29,
      "receptiveCode": 47,
      "serviceType": "PRVT",
      "countryCode": null,
      "providerCode": null,
      "address": " ",
      "city": null,
      "postalCode": null,
      "zoneCode": "AEROPUERTO",
      "latitude": null,
      "longitude": null,
      "webCheckpickup": false
  },
  {
      "code": 823,
      "name": "Taxi Stop Morromar",
      "hotelCode": 137701,
      "isTerminal": "N",
      "companyCode": "E10",
      "officeCode": 29,
      "receptiveCode": 47,
      "serviceType": "SHRD",
      "countryCode": "ES",
      "providerCode": null,
      "address": "Calle Tomillo 6",
      "city": "Matagorda",
      "postalCode": "35500",
      "zoneCode": null,
      "latitude": 28.934771,
      "longitude": -13.621521,
      "webCheckpickup": false
  }
]

Docs Navigation