Marhaba Book 
This service is used to perform booking for the marhaba result.
Marhaba Book Request
| Tags | Attribute | Description |
|---|---|---|
| MarhabaBookingCriteria | (JsonObject) | |
| searchKey* (String) |
A unique search key or identifier associated with the user's search or transaction. | |
| offerId* (String) |
An offer-specific identifier, ensuring clear reference for the selected offer. | |
| clientReference* (String) |
Unique client reference number per booking, provided by the API consumer. If no bookingReferenceId is received from the Book response, send this value as clientReferenceId in the Marhaba Booking Retrieve request. |
|
| totalNet* (Double) |
The total net amount associated with the transaction, usually in a specific currency. | |
| currency* (String) |
The currency in which the transaction is conducted, providing the currency code or abbreviation. | |
| Auxiliaries | auxiliaries (Array) |
Contains an array of auxiliaries to be booked. |
| auxiliaryOfferId (String) |
An offer-specific identifier, ensuring clear reference for the selected auxiliaries. | |
| quantity (Integer) |
This specifies the quantity of auxiliaries being booked | |
| chauffeurServiceDetails | chauffeurServiceDetails (Object) |
Contains chauffeur details. |
| noOfBags (String) |
Number of bags to be picked up by chauffeur | |
| contactNumber (String) |
Contact number of the chauffeur | |
| building (String) |
Specifies building number | |
| street (String) |
Specifies the street | |
| landmark (String) |
landmark of the address | |
| pickupDate (Date) |
Specifies the pick up date | |
| pickupTime (Time) |
Specifies the pick up time | |
| passengers | passengers* (Array) |
Details about passengers associated with the marhaba offer. |
| passengerKey* (String) |
A unique key or identifier for the passenger. | |
| ptc* (String) |
The Passenger Type Code (PTC) that indicates the type of passenger, e.g., "ADT" for an adult. | |
| leadPassenger* (Boolean) |
Indicates whether the passenger is the lead passenger (true) or not (false). | |
| passengerInfo | passengerInfo* (Object) |
Contains detailed information about the passenger. |
| birthDate* (String) |
The passenger's date of birth in the format "YYYY-MM-DD." | |
| gender* (String) |
The gender of the passenger (e.g., "M" for male). | |
| nameTitle* (String) |
The title or salutation of the passenger (e.g., "Mr"). | |
| givenName* (String) |
The given name or first name of the passenger. | |
| middleName (String) |
The middle name of the passenger (if applicable). | |
| surname* (String) |
The surname or last name of the passenger. | |
| contact | contact* (Object) |
Contains contact information for the passenger.Mandatory field for lead passenger |
| contactsProvided* (Array) |
Provides contact details for the passenger, including email addresses and phone numbers. | |
| emailAddress* (Array) |
Contains email addresses associated with the passenger. | |
| phone* (Array) |
Contains phone numbers associated with the passenger. | |
| phoneNumber* (String) |
The phone number of the passenger. | |
| paymentDetails | paymentDetails* (Object) |
Contains information related to the payment details, including card information, payment mode, and address. |
| cardInfo (String) | Information about the payment card, if applicable. It may include encrypted details such as card type, number, and expiration date. | |
| paymentMode (String) | The selected payment mode used for the transaction, which could be credit card, debit card, PayPal, etc. | |
| address | address (Object) | Contains details about the billing or shipping address associated with the payment. |
| label (String) | An optional label or identifier for the address, which can help users distinguish between multiple addresses. | |
| street (Array) | The street or building information for the address, ensuring accurate delivery or billing. | |
| postalCode (String) | The postal or ZIP code of the address, aiding in location-specific identification. | |
| cityName (String) | The name of the city or locality associated with the address. | |
| countryCode (String) | The country code or abbreviation corresponding to the address's location. | |
Marhaba Book Response
After sending the marhaba book request Travlinq will book the selected marhaba .
| Tags | Attribute | Description |
|---|---|---|
| meta | meta (Object) |
|
| success (Boolean) |
Response status will be return Ex: true | |
| statusCode (Integer) |
Response statusCode will be return Ex: 1 | |
| statusMessage (String) |
Response statusMessage will be return Ex: "SUCCESS" | |
| actionType (String) |
Describes the type of action related to the response, in this case, "Marhaba book". | |
| conversationId (String) |
Unique ID associated with the conversation or request, "fe22cb8d-67e9-4c29-92af-e44dxxxcb9a9" in this example. | |
| commonData | commonData (Object) |
This tag has the common Data in the response. |
| searchKey * (String) |
A unique search ID, will be returned in the search response. | |
| data | data (Array) |
|
| bookingReferenceId* (String) |
The unique identifier for the booking reference, e.g., "BKR-2023-9090". Use this value in the Marhaba Booking Retrieve and Cancel requests. | |
| bookingStatus* (String) |
Booking status is shown there eg Confirmed. Possible values: Confirmed, Vouchered, On Request, Not Available. | |
| transactionDate* (String) |
Date on which booking is done | |
| clientReference* (String) |
Specifies the client reference | |
| supplierLocator* (String) |
Booking reference (locator) returned by the supplier, e.g., "M70049571". | |
| Marhaba | marhaba (Object) |
This tag has the common Data in the response. |
| offerId (String) |
Offer identifier of the booked marhaba | |
| productName (String) |
Name of the marhaba | |
| productCode (String) |
Code of the marhaba | |
| productCategory (String) |
Category of the marhaba | |
| productDescription (String) |
Description of the marhaba | |
| serviceDate (String) |
Date of the service in the format "YYYY-MM-DD" | |
| cancellationPolicy (String) |
Cancellation policy of the booked marhaba (HTML text) | |
| Auxiliaries | auxiliaries (Array) |
Contains an array of auxiliaries booked with the marhaba. |
| auxiliaryOfferId (String) |
An offer-specific identifier, ensuring clear reference for the selected auxiliaries. | |
| productName (String) |
Name of the auxiliary | |
| productCode (String) |
Code of the auxiliary | |
| productCategory (String) |
Category of the auxiliary | |
| vehicleType (String) |
Vehicle type (chauffeur auxiliary only) | |
| pricingInfo (Object) |
Pricing of the auxiliary (netAmount, currency) | |
| isChauffeurDetailsRequired (Boolean) |
Indicates whether chauffeur details are required for the auxiliary | |
| chauffeurServiceDetails | chauffeurServiceDetails (Object) |
Chauffeur details sent in the book request (returned only when provided). |
| noOfBags (Integer) |
Number of bags to be picked up by chauffeur | |
| contactNumber (String) |
Contact number of the chauffeur | |
| building (String) |
Specifies building number | |
| street (String) |
Specifies the street | |
| landmark (String) |
landmark of the address | |
| pickupDate (Date) |
Specifies the pick up date | |
| pickupTime (Time) |
Specifies the pick up time | |
| Pricing Info | pricingInfo (Object) |
This tag has the common Data in the response. |
| netAmount (Double) |
Amount of the auxiliary | |
| currency * (String) |
Indicates the currency code, such as "AED," associated with the product's pricing. | |
| customerAdditionalFareInfo | customerAdditionalFareInfo (Object) |
Additional fare information related to customer |
| transactionFeeEarned (Double) |
This attribute contains the transaction fee amount. | |
| commissionEarned (Double) |
Commission amount will be shown here. | |
| markupEarned (Double) |
Total markup amount from pricing rule will be shown here. | |
| discount (Double) |
Total discount amount from pricing rule will be shown here. | |
| vat (Double) |
Vat received from pricing model (if vat rule is applied) | |
| plbearned (Double) |
plbearned will be shown | |
| incentiveEarned (Double) |
Incentive amount earned | |
| tdsOnIncentive (Double) |
tds amount on incentive will be shown | |
| passengers | passengers (Array) |
Details about passengers associated with the marhaba booking (same as sent in the book request). |
| passengerKey (String) |
A unique key or identifier for the passenger. | |
| ptc (String) |
The Passenger Type Code (PTC) that indicates the type of passenger, e.g., "ADT" for an adult. | |
| leadPassenger (Boolean) |
Indicates whether the passenger is the lead passenger (true) or not (false). | |
| passengerInfo | passengerInfo (Object) |
Contains detailed information about the passenger. |
| birthDate (String) |
The passenger's date of birth in the format "YYYY-MM-DD." | |
| gender (String) |
The gender of the passenger (e.g., "M" for male). | |
| nameTitle (String) |
The title or salutation of the passenger (e.g., "Mr"). | |
| givenName (String) |
The given name or first name of the passenger. | |
| middleName (String) |
The middle name of the passenger (if applicable). | |
| surname (String) |
The surname or last name of the passenger. | |
| contact | contact (Object) |
Contact information of the passenger (returned for the passenger whose contact was sent in the request). |
| contactsProvided (Array) |
Provides contact details for the passenger, including email addresses and phone numbers. | |
| emailAddress (Array) |
Contains email addresses associated with the passenger. | |
| phone (Array) |
Contains phone numbers associated with the passenger. | |
| phoneNumber (String) |
The phone number of the passenger. |
| Marhaba Book Response | |
|---|---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |