POST Transfers by context, contextId

Overview

Create transfer on a Booking

Request

POST /[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
flightDate
String
Mandatory 
Date (Optional for patch but required if either date or time is needed to be updated)
flightTime
String
Mandatory 
Time (Optional for patch but required if either date or time is needed to be updated)
flightNumber
String
Mandatory 
Any value (must have at least 1 non-whitespace character) - Optional for patch
customers
List<HrefWrapper>
Mandatory 
URIs of customers to book on the transfer that has already been added to booking
Existing customers on the transfer will not be affected – this only books new customers on the transfer. (Optional for patch)
product
HrefWrapper
Mandatory 
URI of relevant product
This can be retrieved via the related product (eg: relatedAccommodation, relatedTransfers, relatedSightseeing etc.) property in Retrieve Trip Product
externalReference
String
Optional 
An optional unique identifier for preventing duplicate components in a booking. When provided, this reference is checked to ensure the same component (trip or service) is not added more than once. Partners can use this to avoid duplicate entries in component creation.

Product

Name
Type
Requirement
Description
href
String
Optional 
URI of the resource

Customers

Name
Type
Requirement
Description
href
String
Optional 
URI of the resource

Request Example

{
  "flightDate": "2024-12-21",
  "flightTime": "10:10",
  "flightNumber": "UA105",
  "customers": [
    {
      "href": "/bookings/5057124/customers/4945397"
    },
    {
      "href": "/bookings/5057124/customers/4945397"
    }
  ],
  "product": {
    "href": "/products/91066"
  },
  "externalReference": null
}

Response Information

Response Properties

Name
Type
Description
id
Integer
ID of the resource
href
String
URI of the resource

Response Codes

HTTP status code
Description
200 OK
The resource was updated successfully
201 Created
The resource was created
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
500 Internal Server Error
An unexpected error occurred on the API server
202 Accepted
The request was accepted
404 Not Found
The specified resource was not found
403 Forbidden
One or more parameters has already been set on the resource record and cannot be updated

Response Example

{
  "id": 887124,
  "href": "context/contextid/transfers/887124"
}