Booking Detail Response

As detailed before, the response for the booking details contains all the booking information including the contents factsheet. 

NODE/ATTRIBUTE

TYPE

DESCRIPTION

@operationId

String

Factsheet Operational ID, informative only.

errors

List<Error>

Contains a list of errors (error code and error description)

errors/@code

String

Error code

errors/@text

String

Error description

errors/@internalDescription

String

Internal error description

auditData

Element

This element contains internal information. You can provide it in the event of needing specific support. 

booking

Booking

Booking information

booking/@creationDate

Date

Booking creation date

booking/@creationUser

Date

API Key used to create the booking.

booking/paymentData/

String

Payment data for bookings that provided payment information in the confirmation.

booking/paymentData/@paymentType

PaymentType

Payment type

booking/paymentData/paymentType/@code

String

Payment type code. It can be one of the following:

  • P: Prepayment. Bookings need to be paid before confirming.
  • C: Credit. Customers can book until a limited amount of credit is reached.

 booking/paymentData/invoicingCompany

InvoiceCompany

Invoice company information.

 booking/paymentData/invoicingCompany/@code

String

Invoice company code

 booking/paymentData/invoicingCompany/@name

String

Invoice company name

booking/paymentData/invoicingCompany/@registrationNumber

String

Invoice company registration number

booking/paymentData/@description

String

Comments regarding the booking payment.

booking/@reference

String

Booking reference number provided in the confirmation response.

booking/@status

String

Booking status

  • PRECONFIRMED
  • CONFIRMED
  • CANCELLED

booking/@currency

String

Price currency code. See Contents api for details on the different currency codes.

booking/@pendingAmount

Double

Amount pending to be paid for the booking.

booking/@clientReference

String

Client reference code provided in the confirmation request

booking/Holder

BookingHolder

Booking holder information element 

booking/holder/@name

String

Booking holder name

booking/holder/@surname

String

Booking holder surname

booking/holder/@title

String

Booking holder title (Mr, Ms, Miss)

booking/holder/@email

String

Booking holder email

booking/holder/@address

String

Booking holder address

booking/holder/@zipCode

String

Booking holder zip code

booking/holder/@mailing

Boolean

Value set to “true” if the holder has agreed to receive communications via e-mail.

booking/holder/@country

String

Country name

Booking/holder/@telephones

List<String>

Booking holder telephones list

booking/@total

Double

Total amount of the booking

booking/@totalNet

Double

Total net amount of the booking

booking/activities

Activity

List of booked services

booking/activities/@id

String

Booked activity id (different to activity code as provided in other api calls prior to the booking confirmation). Needed to perform modifications.

booking/activities/contactInfo

ActivityContactInfo

Contact information for the activity. Includes emergency phones where the final customer can call if he/she has a problem with the activity.

Address where the activity takes place is also included.

booking/activities/contactInfo/telephone

String

Telephone number for the   specific service in the booking.

booking/activities/contactInfo/address

String

Activity address

booking/activities/contactInfo/postalCode

String

Activity postal code

booking/activities/contactInfo/city

String

City where the activity takes place.

booking/activities/contactInfo/country

String

Country in which the activity is located.

booking/activities/contactInfo/country/@code

String

Country code

booking/activities/contactInfo/country/@name

String

Country name. It will be provided in the same language as the request indicated

booking/activities/contactInfo/country/destinations

String

Destination list where the activity takes place. A single destination is returned in a confirmed booking.

booking/activities/contactInfo/destinations/@code

String

Destination code.

booking/activities/contactInfo/destinations/@name

String

Destination name. It will be provided in the same language as the request indicated

booking/activities/agencyCommission

AgencyCommision

Information regarding the commission. Valid for commissionable clients.

booking/activities/agencyCommission/@percentage

Double

Commission percentage.

booking/activities/agencyComission/@amount

Double

Commission amount

booking/activities/agencyCommission/@vatAmount

Double

Commission vat.

booking/activities/agencyCommission/@vatPercentage

Double

Commission vat percentage applied.

booking/activities/amountDetail AmountDetail Prices summary for the activity in the booking.

booking/activities/paxAmount/@paxType

PaxType

ADULT or CHILD.

booking/activities/paxAmount/@ageFrom

Integer

Age from for the pax type

booking/activities/paxAmount/@ageTo

Integer

Age to for the pax type

booking/activities/paxAmount/@amount

Double

Price of the service for the pax type-


booking/activities/paxAmount/@boxOfficeAmount

Double

Box office price of the service for the pax type

booking/activities/totalAmount

AmountDetail

Activity total price in the booking.

booking/activities/totalAmount/@amount

Double

Activity total price

booking/activities/totalAmount/@boxOfficeAmount

Double

Activity total box office price

booking/activities/providerInformation

ActivityProviderInformation

Provider details

 

booking/activities/providerInformation/@name

String

Activity Provider Name

booking/activities/providerInformation/@bookingReference

String

Activity Provider external reference

booking/activities/pickup

ExcursionDetail

Details regarding the excursion

booking/activities/pickup/@pickupCode

String

Code for the pick up point

booking/activities/pickup/@pickupName

String

Name for the pick up point

booking/activities/pickup/@hotelCode

Long

Hotel code for the pick up point (it the pickup is a hotel)

booking/activities/pickup/@time

Date

Is the time of the pickup

booking/activities/pickup/operationDate PickupOperationDate
booking/activities/pickup/operationDate/@from date Is the relevant operation date in which the pickup has been selected. 

booking/activities/bundles

BundledService

A bundle product is a combination of two or more activities that are sold together as one service. Usually bundles provide not only better prices overall as selling more than one product together but also offers an attractive package for the end consumer.

Bundle products are sold jointly in one service but, on the contrary, one voucher for each service included in the bundle has to be provided to the final consumer (this is because the services included are for the completely different activities, i.e. Disney Orlando and Universal Orlando).

If the booking contains a bundle, specific details for each bundle voucher will be provided.

booking/activities/bundles/@order

Integer

Activity order in the bundle

booking/activities/bundles/activity BundleActivity Provides all relevant information on the bundle. 

booking/activities/bundles/activity/@code

String

Activity code in the bundle

booking/activities/bundles/activity/@name

String

Activity name. It will be provided in the same language as the request indicated

booking/activities/bundles/activity/@type ActivityType Is the type of product (excursion or ticket) that is included in the bundle. 

booking/activities/bundles/activity/modality

String

Modality details

booking/activities/bundles/activity/modality/@code

String

Modality code for that activity in the bundle

booking/activities/bundles/activity/modality/@name

String

Modality name for that activity in the bundle. It will be provided in the same language as the request indicated

booking/activities/bundles/@payableName

String

Invoicing company, please include in the voucher.

booking/activities/bundles/comments

List<Comment>

List of comments to be included in the voucher. It will be provided in the same language as the request indicated 

booking/activities/bundles/comments/@type

String

Comment type. Possible value is “CONTRACT_REMARKS”. Please, include the comments in the voucher.

booking/activities/bundles/comments/@text

String

Comment text.

booking/activities/bundles/@providerInformation

ProviderInformation

 

booking/activities/bundles/providerInformation/@name

String

Activity Provider Name

booking/activities/bundles/providerInformation/@bookingReference

String

Activity Provider external reference number.  The external reference number is extremely relevant to be included in the voucher. It will serve in case of an issue to allow the supplier to effectively find the booking on their side.

booking/activities/@status

String

Status for the activity in the list of confirmed Activities. It can be:

  • CONFIRMED
  • CANCELLED
  • MODIFIED

booking/activities/supplier

SupplierInformation

Supplier information. To be included in the voucher.

booking/activities/supplier@name

String

Supplier name

booking/activities/supplier/@vatNumber

String

Supplier VAT number

booking/activities/comments

List<Comment>

Comments list. To be shown in the voucher.

booking/activities/comments/@type

String

Comment type. Possible values are:

  • CONTRACT_REMARKS

booking/activities/comments/@text

String

Comments text.

booking/activities/@type

String

Activity type. It can be:

  • TICKET
  • EXCURSION
  • BUNDLE

booking/activities/modality

Modality

Selected modality information including rate, session and language.

booking/activities/modality/@code

String

Modality code

booking/activities/modality/@name

String

Modality name. It will be provided in the same language as the request indicated

booking/activities/modality/rates

Rate

Selected rate

booking/activities/modality/rates/@code

String

Rate code

booking/activities/modality/rates/@name

String

Rate name

booking/activities/modality/rates/rateDetails List<RateDetails>

booking/activities/modality/rates/rateDetails/session

Session

Modality Session

booking/activities/modality/rates/rateDetails/session/@code

String

Session code

booking/activities/modality/rates/rateDetails/session/@name

String

Session name. It will be provided in the same language as the request indicated

booking/activities/modality/rates/rateDetails/language

Language

Activity language.

booking/activities/modality/rates/rateDetails/language/@code

String

Language code

booking/activities/modality/rates/rateDetails/language /@name

String

Language name

booking/activities/questions List<PaxQuestion> Are the relevant questions that are made to end consumers and that are required to ensure that he or she can use enjoy the activity and to prevent issues. Example of questions are: passport number, weight, height, etc.

booking/activities/questions/question

PaxQuestion

contains the particular question that is required to be answered

booking/activities/questions/question/@code

String

Question code

booking/activities/questions/question/@text

String

Question text. It will be provided in the same language as the request indicated

booking/activities/questions/question/@required

Boolean

True if the question is mandatory to be answered.

booking/activities/questions/question/@answer

String

Answer provided in the confirmation to the question.

booking/activities/vouchers

List<Voucher>

List of vouchers. Some specific activities can return specific vouchers and they must be provided to the final customer.

Vouchers can be per pax or per service.

Voucher structure can also be returned in the same way when the content type is application/xml or application/json.

The voucher structure contains information regarding how the voucher is structured and all the needed elements to be presented such as barcodes or specific reference numbers.

The information is returned in the following detail:

booking/activities/vouchers/customerId

String

Each pax in the paxes list contains a unique identifier (customerId) that identiofies that pax in the booking.

 If each one of the paxes need to get a different voucher, then the identification of the pax that owns the voucher is returned here.

booking/activities/vouchers/code

String

Voucher identifier.

booking/activities/vouchers/language

String

Voucher language code.

booking/activities/vouchers/url

String

Voucher URL where it can be download from. In this case, this will be the voucher to be given to the final consumer. Without it, the final consumer will not be granted access to enjoy the activity.

booking/activities/vouchers/mimeType

String

Voucher mime type. The following types are available:

  • text/html: Voucher in HTML
  • application/pdf: Voucher in PDF
  • application/json: Voucher structure in JSON
  • application/xml: Voucher structure in XML

Some can contain the voucher structure additionally or instead of the vouchers in PDF or HTML.

When a voucher URL in XML or JSON is provided, you have the choice of building your own voucher with the information included in the XML or JSON message returned by the provided URL.

The following table (also shown in the booking detail spec) explains when it’s possible to build your own voucher and when you must deliver the generated voucher to your final customer:

Format

Deliver to the final customer

Build your own voucher

Only PDF and/or HTML

Yes

No

Only XML and/or JSON

No

Yes

Both PDF/HTML and XML/JSON

Yes

Yes

 

booking/activities/@code

String

Activity code. Same code as it was provided in the detail or search api calls.

booking/activities/@name

String

Activity name.

booking/activities/@dateFrom

Date

Date from. If the duration is 1 day, then dateFrom is the same as dateTo.

booking/activities/@dateTo

Date

Date to. If the duration is 1 day, then dateFrom is the same as dateTo.

booking/activities/rateBreakdown PriceBreakdown Contains all information on supplements, discounts and fees.

booking/activities/rateBreakdown/supplements

List<Supplement>

List of applied supplements.

booking/activities/rateBreakdown/supplements/@type

String

Supplement type (descriptive text)

booking/activities/rateBreakdown/supplements/@quantity

Integer

Number of supplments of the same type applied.

booking/activities/rateBreakdown/supplements/@from

Date

Supplement is applicable from

booking/activities/rateBreakdown/supplements/to

Date

Supplement is applicable to

booking/activities/rateBreakdown/supplements/name

String

Supplement name

booking/activities/rateBreakdown/supplements/info

String

Supplement information

booking/activities/rateBreakdown/supplements/amount

Double

Supplement amount (included in total price)

booking/activities/rateBreakdown/discounts/

List<Discount>

List of applied discounts

booking/activities/rateBreakdown/discounts/@type

String

Discount type (descriptive)

booking/activities/rateBreakdown/discounts/@quantity

Integer

Number of discounts of the same type applied.

booking/activities/rateBreakdown/discounts/@from

Date

Discount applicable from date

booking/activities/rateBreakdown/discounts/@to

Date

Discount applicable to date

booking/activities/rateBreakdown/discounts/@name

String

Discount name

booking/activities/rateBreakdown/discounts/@info

String

Discount information

booking/activities/rateBreakdown/discounts/@amount

Double

Discount amount (included in total price)

booking/activities/rateBreakdown/fees

List<Fee>

List of fees

booking/activities/rateBreakdown/fee/@type

String

Fee type (descriptive)

booking/activities/rateBreakdown/fee/@amount

Double

Fee amount

booking/activities/cancellationPolicies

List<CancellationPolicy>

CancellationPolicies. Price to pay to cancel the booking.

booking/activities/cancellationPolicies/@dateFrom

Date

Date as from when the cancellation policy applies. The date from is considering the destination date from. It also includes the time as part of the response.

booking/activities/cancellationPolicies/@amount

Double

Amount that will apply if the service is cancel after the date from.

booking/paxes

List<Paxinfo>

List of paxes in the booking.

booking/paxes/@customerId

String

Customer identification. It is used in other elements (vouchers, seating…) to refer a pax.

booking/paxes/@age

Long

Pax age.

booking/paxes/PaxType

String

Pax type: ADULT or CHILD

booking/paxes/@birthDate

Date

Pax birth date if available.

booking/paxes/@passport

String

Pax identification number (usually Passport or other valid document).

booking/paxes/@name

String

Booking holder name

booking/paxes/@surname

String

Booking holder surname

booking/paxes/@title

String

Booking holder title (Mr, Ms, Miss)

booking/paxes/@email

String

Booking holder email

booking/paxes/@address

String

Booking holder address

booking/paxes/@zipCode

String

Booking holder zip code

booking/paxes/@mailing

Boolean

True if the pax has agreed to be contacted by e-mail.

booking/paxes/@country

String

Booking holder country name

booking/paxes/@telephones

List<String>

Booking holder telephones list

booking/paxes/seat

List<Seat>

Some activities such as theaters or football matches may include a seat per pax.

In the event that a seat has been assigned to the pax, then the seat is described here. Example:

  • entranceDoor: “NORTH”,
  • gate: “N4”
  • row: “14”
  • seat: G

booking/paxes/seat/@entranceDoor

String

Entrance door to reach the seat.

booking/paxes/seat/@gate

String

Gate to select to reach the seat.

booking/paxes/seat/@row

String

Row in which the seat is located.

booking/paxes/seat/@seat

String

Seat identification in the row.

booking/paxes/confirmationCode

ConfirmationCode

If specific confirmation code has been issued for the pax, then it’s returned in this section and it must be included in the voucher.

booking/paxes/confirmationCode/@unitType

String

Code type. Valid values are:

  • SERVICE: Same confirmation code for all the paxes in the activity.
  • PAX: A different confirmation code is issued for each pax.

booking/paxes/confirmationCode/@code

String

Code assigned to the pax.

booking/activities/content

Contents

Full contents factsheet for the activity booked. Please see get contents api call for more details regarding the contents factsheet structure. Also refer to the Contents by Operation

 

Docs Navigation