Marhaba Book Retrieve
This service is used to retrieve a marhaba booking.Marhaba Book Retrieve Request
| Tags | Attribute | Description |
|---|---|---|
| MarhabaBookRetrieveCriteria | (JsonObject) | |
| productType* (String) |
Booked Product Type Code like A for Air , H for Hotel |
|
| bookingReferenceId (String) |
Reference id of the Booking (Required if ClientReferenceId is empty) | |
| clientReferenceId (String) |
Specifies the client reference (Required if bookingReferenceId is empty) |
| Marhaba Book Retrieve Response | |
|---|---|
Marhaba Book Retrieve Response
After sending the marhaba book request Travlinq will book the selected marhaba .
| Tags | Attribute | Description |
|---|---|---|
| meta | meta (Object) |
|
| success (String) |
Response status will be return Ex: "true" | |
| statusCode (Boolean) |
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 booking." | |
| conversationId (String) |
Unique ID associated with the conversation or request, "fe22cb8d-67e9-4c29-92af-e44dxxxcb9a9" in this example. | |
| data | data (Object) |
|
| bookingReferenceId (String) |
The unique identifier for the booking reference, e.g., "BKR-2023-9090." | |
| clientReferenceId (String) |
Specifies the client reference | |
| bookingStatus (String) |
Specifies status of booking | |
| Marhaba | marhaba (Object) |
This tag has the marhaba details. |
| productName (String) |
Name of the marhaba | |
| productCode (String) |
Code of the marhaba | |
| transactionDate (String) |
Date of the transaction | |
| serviceDate (String) |
Date of the booking | |
| 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 (If Applicable) | chauffeurServiceDetails (Array) |
Contains an array of chauffeurs. |
| 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 | |
| Pricing Info | pricingInfo (Object) |
This tag has the pricing information. |
| netAmount (Double) |
Amount of the auxiliary | |
| currency (String) |
Indicates the currency code, such as "AED," associated with the product's pricing. | |
| customerAdditionalFareInfo | customerAdditionalFareInfo (Object) |
This tag has 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 offer. |
| 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." | |
| 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 |
| contactProvided (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. | |