Documentation

Routes

This method is used to obtain a ROUTES portfolio

Endpoint

GET https://api.test.hotelbeds.com/transfer-cache-api/1.0/routes?fields={{FIELDS}}&destinationCode={{DESTINATION}}&offset={{OFFSET}}&limit={{LIMIT}}

Request parameters

Name	Type	Description
fields	String	Comma separated list of response fields to return (mandatory)
destinationCode	String	Atlas destination code (mandatory)
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/routes?fields=ALL&destinationCode=PMI&offset=0&limit=1000

Routes Response

The response of Routes provides information of the routes traveled by the transfers

Response Parameters

Name	Type	Description
code	String	Route code (OriginType-OriginCode-DestinationType-DestinationCode)
from	Element	Indicates where the route starts
from/type	String	Origin type (one of: ATLAS, IATA, GIATA, PORT, STATION)
from/code	String	Origin code (i.e.: 1523, PMI, etc)
to	Element	Indicates where the route ends
to/type	String	Origin type (one of: ATLAS, IATA, GIATA, PORT, STATION)
to/code	String	Origin code (i.e.: 1523, PMI, etc)

Response example

[
  {
      "code": "ATLAS-633922-IATA-PMI",
      "from": {
          "type": "ATLAS",
          "code": "633922"
      },
      "to": {
          "type": "IATA",
          "code": "PMI"
      }
  },
  {
      "code": "IATA-PMI-ATLAS-633922",
      "from": {
          "type": "IATA",
          "code": "PMI"
      },
      "to": {
          "type": "ATLAS",
          "code": "633922"
      }
  }
]