s

Search Available Transfer Services by Area and Date

Availability is the first operation in the booking flow of API, it allows to check which available transfer services can be booked in the requested area for a given date and for a given passengers group.

Parameters

Name

Description

Accept

string

( header )

*required application/json

Accept - Encoding

string

( header )

*required gzip

Authorization

string

( header )

*required Your API Key

*required Your PID Key

Customer-Ip

string

( header )

*required IP address of the customer, as captured by your integration. Send IPV4 addresses only.

Ensure your integration passes the customer’s IP, not your own. This value helps determine their location and other settings.

Also used for fraud recovery and other important analytics.

action

string

( query )

*required "transferLists" as a parameter

fromType

string

( query )

Pickup type code (IATA, ATLAS,PORT,STATION)

fromCode

string

( query )

Pickup code (depending on selected type)

toType

string

( query )

Drop off type code (IATA, ATLAS,PORT,STATION)

toCode

string

( query )

Drop off code (depending on selected type)

departure_datetime

string

( query )

Departure dateTime

return_datetime

string

( query )

Return dateTime (in case of roundtrip)

adults

int

Number of adult passengers (+18)

children

int

Number of child passengers (4~17)

infants

int

Number of infant passengers (0~3)

isoneway

string

Triptype-one way/round trip[ex-Yes/No]

REQUEST

API Endpoint: https://www.abengines.com/api/v1/travel-api/transfer-booking/

header: array(
'Content-Type:application/json',
'Accept-encoding: gzip',
'PID:'ADD-PID-KEY',
'x-api-key:'ADD-API-YOUR-KEY'
);

POST: 
{
    "action": "transferLists",
    "fromType": "ATLAS",
    "fromCode": "124194",
    "toType": "IATA",
    "toCode": "AMS",
    "departure_datetime": "2023-08-12T10:00:00",
    "isoneway": "Yes",
    "adults": 1,
    "children": 0,
    "infants": 0
}

Response

The API returns an HTTP response, which generally includes the result of the request invocation

{
  "status": 200,
  "status_message": "OK",
  "responseData": {
    "search": {
      "language": "en",
      "departure": {
        "date": "2023-08-12",
        "time": "10:00:00"
      },
      "comeBack": {
        "date": "-999999999-01-01",
        "time": "00:00:00"
      },
      "occupancy": {
        "adults": 1,
        "children": 0,
        "infants": 0
      },
      "from": {
        "code": "5643",
        "description": "Sistina",
        "type": "ATLAS"
      },
      "to": {
        "code": "CIA",
        "description": "Rome, Ciampino Airport",
        "type": "IATA"
      }
    },
    "services": [
      {
        "id": 0,
        "direction": "DEPARTURE",
        "transferType": "PRIVATE",
        "vehicle": {
          "code": "CR",
          "name": "Car"
        },
        "category": {
          "code": "PRM",
          "name": "Premium product type"
        },
        "pickupInformation": {
          "from": {
            "code": "5643",
            "description": "Sistina",
            "type": "ATLAS"
          },
          "to": {
            "code": "CIA",
            "description": "Rome, Ciampino Airport",
            "type": "IATA"
          },
          "date": "2023-08-12",
          "time": "06:40:00",
          "pickup": {
            "address": "Via Sistina,136  ",
            "number": null,
            "town": "ROME",
            "zip": "00187",
            "description": "You will be picked up at the hotel reception. If you are unable to locate the driver/agent, please call KOI TECHNOLOGIES on +971 567562977 (WhatApp available), +971 45754333. Please do not leave the pick-up area without having contacted the agent/driver first. If the supplier doesn't answer the phone, please call our emergency telephone number listed at the bottom of the voucher before leaving the pick-up area.",
            "altitude": null,
            "latitude": 41.904008,
            "longitude": 12.487254,
            "checkPickup": {
              "mustCheckPickupTime": false,
              "url": null,
              "hoursBeforeConsulting": null
            },
            "pickupId": 23229,
            "stopName": "HOTEL RECEPTION",
            "image": null
          }
        },
        "minPaxCapacity": 1,
        "maxPaxCapacity": 2,
        "content": {
          "vehicle": {
            "code": "CR",
            "name": "Car"
          },
          "category": {
            "code": "PRM",
            "name": "Premium"
          },
          "images": [
            {
              "url": "http://media.activitiesbank.com/giata/transfers/TRD/small/prvt-prm-cr.png",
              "type": "SMALL"
            },
            {
              "url": "http://media.activitiesbank.com/giata/transfers/TRD/medium/prvt-prm-cr.png",
              "type": "MEDIUM"
            },
            {
              "url": "http://media.activitiesbank.com/giata/transfers/TRD/large/prvt-prm-cr.png",
              "type": "LARGE"
            },
            {
              "url": "http://media.activitiesbank.com/giata/transfers/TRD/extralarge/prvt-prm-cr.png",
              "type": "EXTRALARGE"
            }
          ],
          "transferDetailInfo": [
            {
              "id": "ER",
              "name": "Exclusive ride for you",
              "description": null,
              "type": "GENERAL_INFO"
            },
            {
              "id": "DTDS",
              "name": "Door to door service",
              "description": null,
              "type": "GENERAL_INFO"
            },
            {
              "id": "M&GS",
              "name": "Meet & Greet service",
              "description": null,
              "type": "GENERAL_INFO"
            },
            {
              "id": "BAHB",
              "name": "1 item of hand baggage allowed per person",
              "description": null,
              "type": "GENERAL_INFO"
            },
            {
              "id": "BA",
              "name": "1 piece of baggage allowed per person ( max.dimensions 158cm) length+width+height=158cm",
              "description": null,
              "type": "GENERAL_INFO"
            },
            {
              "id": "VOUC",
              "name": "VOUCHER ",
              "description": "Remember to bring a printed copy of this voucher and a valid photo ID with you.",
              "type": "GENERIC_GUIDELINES"
            },
            {
              "id": "DRVR",
              "name": "CAN'T FIND DRIVER",
              "description": "In the event of being unable to locate the driver, please call the emergency number indicated in this voucher.",
              "type": "GENERIC_GUIDELINES"
            },
            {
              "id": "MGEN",
              "name": "Meet and Greet in English",
              "description": "Meet and Greet in English",
              "type": "GENERIC_GUIDELINES"
            },
            {
              "id": "CBBS",
              "name": "CHILDBOOSTER / BABY SEAT",
              "description": "Child car seats and boosters are not included unless specified in your booking and can carry an extra cost. Should you need to book them, please contact your point of sale prior to travelling.",
              "type": "GENERIC_GUIDELINES"
            },
            {
              "id": "PLEGACHAIR",
              "name": "Foldable wheelchairs",
              "description": "Adapted vehicles are suitable for foldable wheelchairs. If the wheelchair cannot be folded, an extra cost may be applicable for customers",
              "type": "GENERIC_GUIDELINES"
            }
          ],
          "customerTransferTimeInfo": [
            {
              "value": 0,
              "type": "CUSTOMER_MAX_WAITING_TIME",
              "metric": "minutes"
            }
          ],
          "supplierTransferTimeInfo": [
            {
              "value": 15,
              "type": "SUPPLIER_MAX_WAITING_TIME_DOMESTIC",
              "metric": "minutes"
            }
          ],
          "transferRemarks": [
            {
              "type": "CONTRACT",
              "description": "Pick-up point\nYou will be picked up at the hotel reception. If you are unable to locate the driver/agent, please call KOI TECHNOLOGIES on +971 567562977 (WhatApp available), +971 45754333. Please do not leave the pick-up area without having contacted the agent/driver first. If the supplier doesn't answer the phone, please call our emergency telephone number listed at the bottom of the voucher before leaving the pick-up area.\n\nTransfer information:\n\n* Maximum client waiting time 0 minutes\n* Maximum waiting time for drivers in domestic arrivals 15 minutes\n\n\n* Remember to bring a printed copy of this voucher and a valid photo ID with you.* In the event of being unable to locate the driver, please call the emergency number indicated in this voucher.* Meet and Greet in English* Child car seats and boosters are not included unless specified in your booking and can carry an extra cost. Should you need to book them, please contact your point of sale prior to travelling.* Adapted vehicles are suitable for foldable wheelchairs. If the wheelchair cannot be folded, an extra cost may be applicable for customers\n\n* Exclusive ride for you* Door to door service* Meet & Greet service* 1 item of hand baggage allowed per person* 1 piece of baggage allowed per person ( max.dimensions 158cm) length+width+height=158cm\n\n",
              "mandatory": true
            }
          ]
        },
        "price": {
          "totalAmount": 10632.15,
          "netAmount": null,
          "currencyId": "INR"
        },
        "rateKey": "DEPARTURE|ATLAS|5643|IATA|CIA|2023-08-12|06:40|2023-08-12|10:00|1~0~0||2|248510|ROE PRV PRM H24|248510|ROE PRV PRM H24|207|PRVT|7|CR|PRM|10632.15|ROMA AREA|AERO CIAMP|23229|1391|ROE|SIMPLE|c4d875044c4f29113837c8f153f4d8c5",
        "cancellationPolicies": [
          
        ],
        "links": [
          {
            "rel": "self",
            "href": "/availability",
            "method": "GET"
          },
          {
            "rel": "confirm",
            "href": "/booking",
            "method": "POST"
          }
        ],
        "factsheetId": 1391
      }
    ]
  }
}