GET Transfers by context, contextId

Overview

Retrieve transfers by Booking ID

Request

GET /[context]/[contextId]/Transfers

Request Information

Request Parameters

Name
Type
Requirement
Description
context
String
Mandatory 
Context in Request URI should be 'bookings'
contextId
Integer
Mandatory 
ContextId in Request URI should be Booking ID

Response Information

Response Properties

Name
Type
Description
transfers
List<Transfer>
Transfer list

Transfers

Name
Type
Description
product
HrefWrapper
URI of transfer product
transferName
String
Name of transfer product
currency
String
Currency
totalPrice
Decimal
Total gross price for all customers on transfer
netPrice
Decimal
Gross price minus any commission for the transfer
airportPickup
Boolean
•	true 
Transfer is picking up customers from an airport 
•	false 
 Transfer is picking up customers from a non-airport location
airportDropoff
Boolean
•	true 
Transfer is dropping off customers to an airport 
•	false 
 Transfer is dropping off customers to a non-airport location
flightDate
String
Flight date for transfer
flightTime
String
Flight time for transfer
flightNumber
String
Flight Number of the transfer
isComplimentaryTransfer
Boolean
Provides information on whether transfer is complimentary or not
customers
HrefWrapper
URI used to retrieve all customers on transfer
customerStatuses
Key Value Pair
Key/value pairs indicating the number of customers per status on the transfer; e.g.: 
{ 
 "confirmed": 2,
 "cancelled" : 1 
}
customerStatusIds
List<CustomerStatuses>
List of customer statuses along with url for each customer on that status
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product

Customerstatusids

Name
Type
Description
status
String
Customers status
customers
List<HrefWrapper>
Url of Customers in relevant status

Product

Name
Type
Description
href
String
URI of the resource

Customers

Name
Type
Description
href
String
URI of the resource

Response Codes

HTTP status code
Description
200 OK
The resource was retrieved successfully
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
404 Not Found
The specified resource was not found
500 Internal Server Error
An unexpected error occurred on the API server

Response Example

{
  "transfers": [
    {
      "product": {
        "href": "/products/91066"
      },
      "transferName": "Airport to Nouvo City Hotel private transfer",
      "currency": "AUD",
      "totalPrice": 120,
      "netPrice": 110.75,
      "airportPickup": true,
      "airportDropoff": true,
      "flightDate": "2018-12-21",
      "flightTime": "10:10",
      "flightNumber": "UA105",
      "isComplimentaryTransfer": false,
      "customers": {
        "href": "/transfers/887124/customers"
      },
      "customerStatuses": {
        "confirmed": 2,
        "tentative": 1
      },
      "customerStatusIds": [
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        },
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        }
      ],
      "id": 887124,
      "href": "context/contextid/transfers/887124",
      "sequence": "202403312359580000"
    },
    {
      "product": {
        "href": "/products/91066"
      },
      "transferName": "Airport to Nouvo City Hotel private transfer",
      "currency": "AUD",
      "totalPrice": 120,
      "netPrice": 110.75,
      "airportPickup": true,
      "airportDropoff": true,
      "flightDate": "2018-12-21",
      "flightTime": "10:10",
      "flightNumber": "UA105",
      "isComplimentaryTransfer": false,
      "customers": {
        "href": "/transfers/887124/customers"
      },
      "customerStatuses": {
        "confirmed": 2,
        "tentative": 1
      },
      "customerStatusIds": [
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        },
        {
          "status": "tentative",
          "customers": [
            {
              "href": "/context/5057124/customers/4945398"
            },
            {
              "href": "/context/5057124/customers/4945398"
            }
          ]
        }
      ],
      "id": 887124,
      "href": "context/contextid/transfers/887124",
      "sequence": "202403312359580000"
    }
  ]
}