1. Bookings

Get individual booking data

URL: /auth/booking/get-booking-data

Parameters:

reservationId - the reservation id you wish to get the data for.

Curl example:

curl -X POST -H "Content-Type: application/json" -H "aether-application-key: xxx" -H "aether-account: exampleAccount" -H "aether-agent: exampleAgent" -H "aether-password: 32d81aa261ca91ea9721ded23c274f91" -H "aether-customization: my.white.label" -H "Cache-Control: no-cache" -d '{"reservationId":"1234"}' "http://[aether2.domain]/auth/booking/get-booking-data"

Response

Field Name

Type

Comments

AccountAlias

String

Company name

AccountID

Int

AccountName

String

Account Login Name

AccountPrefix

String

3 letter prefix to the billing documents

Address

String

AgencyReference

String

The agency reference entered by the agent at the time of the booking

AgentID

Int

The agent id for the agent who made the booking

AgentName

String

The name of the agent who made the booking

B2C

Boolean

Is the booking a B2C booking

Billable

Boolean

Was the booking a made via a direct contract by the client to the provider

BillingDate

Date

The date which the booking needs to be billed at

BillingStateID

The billing status of the booking

BillingStatuses

Array

Payable/Receivable statuses

CancellationDate

Date

The cancellation date (if booking was cnacelled)

CancellationPolicies

Object

see below

CheckInDate

Date

The start date of the booking

CheckOutDate

Date

The end date of the booking

CityName

String

The destination city

ClearingStateID

In case the booking was done via a credit card, what is the clearing status

CountryID

Destination country id

Currency

Currency ISO code

3 letter ISO code of the currency, related to the price

CustomerCountryCode2

Country ISO code

2 letter ISO code for the customer country

CustomerCountryName

String

The name of the customer country name

Date

The date in which the booking was made

DocketID

Int

The docket (itinerary) id the booking belongs to

The customer Email

FirstName

String

Customer first name

Guests

Object

see below

HotelID

Int

if applicable

HotelStars

Int

0-5

LastName

String

Customer last name

PackageReservationId

Int

The package reservation id, if reservation is part of a package

ParentAccountID

Int

The parent account id of the account who made the booking

PayAtTheHotel

Boolean

Is the booking pre-pay/post pay

PaymentMethod

How was the booking payed/payable

Phone

String

Phone number of the user

Price

Float

The gross price of the booking

ProviderReferences

String

The provider reference as received from the provider and as it appears on the voucher

Providers

String

Who are the providers who supplied the products for the booking

RelatedIds

Object

basic details of bookings from the same docket

ReservationDetails

Object

see below

ReservationID

Int

The ID of the current booking

SerialID

Int

Consecutive number for each account

ServiceAddress

String

The address of the service

ServiceCityID

The destination city ID of the service

ServiceCityName

String

The destination city name

ServiceCitySeoName

String

SEO slug

ServiceCountryName

String

destination country name

ServiceCountrySeoName

String

SEO slug

ServiceFax

String

ServiceName

String

Full name of the booked service

ServicePhone

String

ServiceSeoName

String

SEO slug

ServiceType

String

hotel/flight/package/etc

ServiceTypeID

Services

Object

SpecialRequests

Array

TechnicalStateID

VoucherSent

Boolean

VoucherType

Int

ZipCode

String

CancellationPolicies object

Field Name	Type	Comments
Amount	Float	The amount that will be charged OR the amount of nights, depending on the AmountType
AmountCur	Currency	3 letter ISO code
AmountType	string	nights/currency
Date	Date	The start date of the policy
Description	String	The description of the cancellation policy
ReservationID	Int
SubID	Int	The service id for which the policy applies

Guest Object

Field Name	Type	Comments
Age	Int	The age of the guest
Firstname	String
GuestID	Int
Lastname	String
SubID	Int	the service id the guest belongs to
Title	String	Title of the guest, "M" for male, "C" for child, etc.

ReservationDetails Object

Depends on the service type, for hotels you'll get rooms, for flights, legs, etc.

Services Object

Field Name

Type

Comments

RowType

Int

accountCurrency

Currency

3 letter ISO code of the buying account currency

accountPrice

Float

board

String

2 letter board code

customerCurrency

Currency

3 letter ISO code of the customer price currency

customerPrice

Float

description

String

Service description

end_date

Date

The end date of the service (i.e. checkout date)

Int

Service ID

lead_name

String

The lead pax name for the service

provider

String

The provider name who supplied the service

providerCurrency

Currency

3 letter ISO code of the provider price currency

providerPrice

Float

providerRef

String

The service booking reference on the providers system

remarks

String

reservationid

Int

start_date

Date

The start date of the service (i.e. checkin date)

status

String

The status of the service (i.e. "Cancelled", "Confirmed", etc.)

subid

Int

The service subid, connecting it to the ReservationDetails Object

Get multiple bookings data

URL: /auth/booking/get-bookings-since

Parameters:

reservationId - the reservation id get all bookings made on your agent since

timestamp - a timestamp to get all bookings made on your agent since

limit - how many bookings (maximum is 20)

At least one of reservationId OR timestamp is required, and you can send both

Response

a collection of booking data as described in the "Get individual booking data" section above

Comments

Resources	Search this site