GET Customers by context, contextId
Overview
Retrieve customers by a Context ID
Request
GET /[context]/[contextId]/Customers
Request Information
Request Parameters
Name
Type
Requirement
Description
context
String
Mandatory
Context of the request e.g Booking, Accommodation, Trips, Sightseeing etc.
contextId
Integer
Mandatory
ID of the context
Response Information
Response Properties
Name
Type
Description
customers
List<Customer>
List of Customers
Customers
Name
Type
Description
title
String
Title
firstName
String
First name of customer
middleName
String
Middle name of customer
surname
String
Surname of customer
dateOfBirth
String
Date of birth of customer
homePhone
String
Home phone number of customer
mobilePhone
String
Mobile phone number of customer
emailAddress
String
Email address of customer
homeAddress
Address
Home Address of customer
passport
Passport
Passport of customer
travelInsurancePolicyNumber
String
Travel Insurance Policy Number of customer
travelInsuranceCompany
String
Travel Insurance Company of customer
travelInsuranceCompanyPhone
String
Travel Insurance Company Phone Number
status
String
Status of customer In the context of a component (i.e Trip, Accommodation, Transfer, AdditionalService, Sightseeing), this can be: • confirmed - Customer is booked on component (Note: Only on-statement agents can confirm a customer without payment, otherwise customers can only be confirmed if required payment is already made) • tentative - Customer is tentatively booked on component • onRequest - Customer has requested to be booked on component, but it needs to be confirmed with the supplier • cancelled - Customer has been cancelled on component
restricted
Boolean
• true Customer is on a non-API booking. For security purposes, only the firstName, surname and currency will be returned • false Customer is on an API booking – all recorded details will be returned
currency
String
Currency
originalPrice
Decimal
Customer gross price prior to any promotion being applied (only included if promotion exists) *Valid only in the context of a Trip
grossPrice
Decimal
Customer gross price for all components on booking
promotionCode
String
Promotion code applied to customer on trip *Valid only in the context of a Trip *If customer having more than one promotion this will be blank
promotionName
String
Promotion name applied to customer on trip *Valid only in the context of a Trip *If customer having more than one promotion this will be blank
netPrice
Decimal
Customer gross price minus any commission for all components on booking
discountAmount
Decimal
Booking adjustment (discount amount) will be deducted from the original price.
feeAmount
Decimal
Booking adjustment (fee amount) will be added to the original price.
emergencyContact
Contact
Emergency contact of customer
dietaryNote
String
Dietary Note of customer
medicalNote
String
Medical Note of customer
singleSupplement
Boolean
This is only valid in the context of a Trip • true Book single room for customer • false Book twin share room for customer (default)
singleSupplementStatus
String
Single Supplement status
singleSupplementOriginalPrice
Decimal
Total single supplement original-price for the customer on the trip *Valid only in the context of a Trip *If the customer has no single supplements this will not be present
singleSupplementGrossPrice
Decimal
Total single supplement gross-price for the customer on the trip *Valid only in the context of a Trip *If the customer has no single supplements this will not be present
singleSupplementNetPrice
Decimal
Total single supplement net-price for the customer on the trip *Valid only in the context of a Trip *If the customer has no single supplements this will not be present
singleSupplementDiscountAmount
Decimal
Booking adjustment (discount amount) will be deducted from the original price of the single supplement.
singleSupplementFeeAmount
Decimal
Booking adjustment (fee amount) will be added to the original price of the single supplement.
payments
HrefWrapper
URI to get the list of payments for the booking or the customer
depositAmount
Decimal
Amount of deposit owed by the customer
permitStatus
String
Permit Status for the customer if it is available
id
Integer
ID of the resource
href
String
URI of the resource
sequence
Int64
Sequence of product
Homeaddress
Name
Type
Description
addressLine1
String
Address Line 1 of customer
addressLine2
String
Address Line 2 of customer
city
String
City of customer
state
String
State of customer
postcode
String
Postcode of customer
countryName
String
Country of customer (Only used in GET request)
countryCode
String
Country Code of customer (Used to set country for the address in POST and PATCH requests)
Passport
Name
Type
Description
number
String
Passport number Any value (must have at least 1 non-whitespace character)
nationality
String
Passport nationality ISO 3166-1 Alpha-2 code (e.g. US)
placeOfIssue
String
Passport place of issue Any value (must have at least 1 non-whitespace character)
dateOfIssue
String
Passport date of issue
dateOfExpiry
String
Passport date of expiry
Emergencycontact
Name
Type
Description
firstName
String
First name of contact
surname
String
Surname of contact
homePhone
String
Home phone number of contact
mobilePhone
String
Mobile phone number of contact
relationship
String
Relationship of contact
Payments
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
{
"customers": [
{
"title": "Mr",
"firstName": "Homer",
"middleName": "Pete",
"surname": "Simpson",
"dateOfBirth": "1970-01-01",
"homePhone": "0115487956",
"mobilePhone": "0435485548",
"emailAddress": "homer@simpson.com",
"homeAddress": {
"addressLine1": "74 Brokesley Street",
"addressLine2": "Bournemouth",
"city": "Kingswood",
"state": "Vic",
"postcode": "3167",
"countryName": "Australia",
"countryCode": "AU"
},
"passport": {
"number": "N89171298",
"nationality": "US",
"placeOfIssue": "US",
"dateOfIssue": "2010-01-01",
"dateOfExpiry": "2020-01-01"
},
"travelInsurancePolicyNumber": "4552",
"travelInsuranceCompany": "Slexicover Direct",
"travelInsuranceCompanyPhone": "0435698542",
"status": "incomplete",
"restricted": "false",
"currency": "usd",
"originalPrice": 1500,
"grossPrice": 1145,
"promotionCode": "ABCD",
"promotionName": "Cool promotion",
"netPrice": 858.75,
"discountAmount": 200.0,
"feeAmount": 640.0,
"emergencyContact": {
"firstName": "Jess",
"surname": "Peter",
"homePhone": "0115487956",
"mobilePhone": "0435485548",
"relationship": "Mother"
},
"dietaryNote": "Allergic to seafood",
"medicalNote": "Knee replacement",
"singleSupplement": "true",
"singleSupplementStatus": "On Request",
"singleSupplementOriginalPrice": 640.0,
"singleSupplementGrossPrice": 576.0,
"singleSupplementNetPrice": 518.4,
"singleSupplementDiscountAmount": 150.0,
"singleSupplementFeeAmount": 350.55,
"payments": {
"href": "/customers/7458965/payments"
},
"depositAmount": 425.0,
"permitStatus": "Inca Trail On Request",
"id": 887124,
"href": "context/contextid/customers/887124",
"sequence": "202403312359580000"
},
{
"title": "Mr",
"firstName": "Homer",
"middleName": "Pete",
"surname": "Simpson",
"dateOfBirth": "1970-01-01",
"homePhone": "0115487956",
"mobilePhone": "0435485548",
"emailAddress": "homer@simpson.com",
"homeAddress": {
"addressLine1": "74 Brokesley Street",
"addressLine2": "Bournemouth",
"city": "Kingswood",
"state": "Vic",
"postcode": "3167",
"countryName": "Australia",
"countryCode": "AU"
},
"passport": {
"number": "N89171298",
"nationality": "US",
"placeOfIssue": "US",
"dateOfIssue": "2010-01-01",
"dateOfExpiry": "2020-01-01"
},
"travelInsurancePolicyNumber": "4552",
"travelInsuranceCompany": "Slexicover Direct",
"travelInsuranceCompanyPhone": "0435698542",
"status": "incomplete",
"restricted": "false",
"currency": "usd",
"originalPrice": 1500,
"grossPrice": 1145,
"promotionCode": "ABCD",
"promotionName": "Cool promotion",
"netPrice": 858.75,
"discountAmount": 200.0,
"feeAmount": 640.0,
"emergencyContact": {
"firstName": "Jess",
"surname": "Peter",
"homePhone": "0115487956",
"mobilePhone": "0435485548",
"relationship": "Mother"
},
"dietaryNote": "Allergic to seafood",
"medicalNote": "Knee replacement",
"singleSupplement": "true",
"singleSupplementStatus": "On Request",
"singleSupplementOriginalPrice": 640.0,
"singleSupplementGrossPrice": 576.0,
"singleSupplementNetPrice": 518.4,
"singleSupplementDiscountAmount": 150.0,
"singleSupplementFeeAmount": 350.55,
"payments": {
"href": "/customers/7458965/payments"
},
"depositAmount": 425.0,
"permitStatus": "Inca Trail On Request",
"id": 887124,
"href": "context/contextid/customers/887124",
"sequence": "202403312359580000"
}
]
}