Sightseeing Book 
This service is used to perform booking for the sightseeing result.
Sightseeing Book Request
| Tags | Attribute | Description |
|---|---|---|
| searchKey | searchKey* (String) |
A unique search key or identifier associated with the user's search or transaction. |
| offerId | offerId* (String) |
An offer-specific identifier, ensuring clear reference for the selected offer. |
| workflowId | workflowId* (String) |
An offer-specific identifier, ensuring clear reference for the selected offer. |
| clientReference | clientReference* (String) |
Unqiue Refernce No. per booking |
| currency | currency* (String) |
The currency in which the transaction is conducted, providing the currency code or abbreviation. |
| paymentDetails | paymentDetails* (JsonObject) |
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 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. | |
| transactionAmount* (Double) |
Total Amount for the sightseeing | |
| address | address (JsonObject) | 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 (String) | 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. |
Sightseeing Book Response
After sending the sightseeing book request Travlinq will book the specified sightseeing booking.
| Tags | Attribute | Description |
|---|---|---|
| meta | meta (JsonObject) | |
| 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, "Sightseeing booking." | |
| conversationId (String) | Unique ID associated with the conversation or request, "fe22cb8d-67e9-4c29-92af-e44dxxxcb9a9" in this example. | |
| commonData | commonData (JsonObject) | This tag has the common Data in the response. |
| searchKey (String) | A unique search ID, will be returned in the search response. | |
| data | data (JsonObject) | |
| bookingReferenceId (String) | The unique identifier for the booking reference, e.g., "BKR-2023-9090." | |
| bookingStatus (String) | The status of the booking, e.g., "canceled." | |
| currency (String) | The currency associated with the booking charges, e.g., "AED." | |
| supplierLocator (String) | Unique Booking provided by supplier after successful booking | |
| sightseeing | sightseeing (JsonObject) | Contains details of sightseeing booking. |
| offerId (String) | Contains the unique id for the specific result | |
| workflowId (String) | Contains the worflowId for the flow | |
| productName (String) | The Name of product | |
| productDescription (String) | Description about the product | |
| itineraryDescription (String) | Itinerary description about the product | |
| highlights (String) | Highlights of the product | |
| safetyWarnings | safetyWarnings (JsonArray) | Safety Warning about the products |
| warning (String) | contains the warning | |
| location | location (JsonObject) | Contains Geolocation detail |
| cityName (String) | Name of the City | |
| countryName (String) | Name of the Country | |
| latitude (String) | latitude of the product | |
| longitude (String) | longitude of the product | |
| address | address (String) | address of result |
| productCategories | productCategories (JsonArray) | Contains product categories |
| category (String) | Category of the product | |
| inclusions | inclusions (JsonArray) | Contains Included Items of the product |
| included (String) | Name of included item | |
| exclusions | exclusions (JsonArray) | Contains Excluded Items of the product |
| excluded (String) | Name of excluded item | |
| languages | languages (StringArray) | Language for the product |
| durations | durations (JsonArray) | Contains the duration of the product |
| duration (String) | Duration of the product | |
| value (Integer) |
Value of the Duration ( returned if available) | |
| metric (String) |
Metric of the Duration ( returned if available) | |
| whatToExpect | whatToExpect (String) | What To Expect |
| essentialNotes | essentialNotes (String) | Essential Notes about the result |
| redeemInstructions | redeemInstructions (String) | Redeem Instruction about the product |
| pickupInstructions | pickupInstructions (String) | Instructions about the Pickup |
| headerTags | headerTags (JsonArray) | Contains The Header Tags about the product |
| tag (String) | The header tag | |
| termsAndConditions | termsAndConditions (StringArray) | Contains Terms and condition for the result |
| pointsOfInterest | pointsOfInterest (JsonArray) | Contains list of point of interest |
| description (String) | name of the point of interest | |
| frequentlyAskedQuestions | frequentlyAskedQuestions (JsonArray) | Contains all the frequently asked question |
| question (String) | Contains the question | |
| answer (String) | Contains the answer | |
| reviews | reviews (JsonArray) | Contains all the reviews about the product |
| review (String) | Contains the review | |
| rating (String) | rating of the result | |
| images | images (JsonArray) | List of available images |
| imagePath (String) | URL of the image | |
| imageWidth (Double) | Width of image (if available) | |
| imageHeight (Double) | Height of Image (If available) | |
| pricingInfo | pricingInfo (JsonObject) | Contains the Pricing Detail for the product |
| startingFrom (Double) | The minimum price for the product | |
| netAmount (Double) | The final/total price for the product | |
| currency (String) | The Currency for the price | |
| customerAdditionalFareInfo | customerAdditionalFareInfo (JsonObject) | Additional fare information related to customers. |
| transactionFeeEarned (Double) | The transaction fee amount. | |
| tdsOnCommission (Double) | The commission amount on TDS. | |
| commissionEarned (Double) | The Commission Earned | |
| markupEarned (Double) | The total markup amount from the pricing rule. | |
| discount (Double) | The total discount amount from the pricing rule. | |
| vat (Double) | The VAT received from the pricing model, if applicable. | |
| supplierAdditionalFareInfo | supplierAdditionalFareInfo (JsonObject) | Additional fare information related to customers. |
| currency (String) | Supplier Currency | |
| publishedFare (Double) | Published Fare | |
| plbearned (Double) | Plb Earned | |
| incentiveEarned (Double) | Incentive Earned | |
| offeredFare (Double) | Fare offered by Supplier | |
| tdsOnCommission (Double) | The commission amount on TDS. | |
| commissionEarned (Double) | The Commission Earned | |
| tdsOnPlb (Double) | TDS on plb | |
| tdsOnIncentive (Double) | TDS on Incentive | |
| serviceFee (Double) | Service Fee | |
| discount (Double) | Total discount amount | |
| passengers | passengers (JsonArray) | Details about passengers associated with the sightseeing 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 (JsonObject) | Contains details about the passenger. |
| birthDate (String) | The birthdate of the passenger, e.g., "2004-12-15." | |
| 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, e.g., "Anil." | |
| middleName (String) | The middle name of the passenger. | |
| surname (String) | The surname or last name of the passenger, e.g., "Kumar." | |
| contact | contact (JsonObject) | Contains contact information for the passenger. |
| contactProvided (JsonArray) | Provides contact details for the passenger, including email addresses and phone numbers. | |
| emailAddress (JsonArray) | Contains email addresses associated with the passenger. | |
| phone (JsonArray) | Contains phone numbers associated with the passenger. | |
| phoneNumber (String) | The phone number of the passenger. | |
| selectedData | selectedData (JsonObject) | Contains All Data Selected in Required Field FLow |
| options | options (JsonArray) | List of Selected Options |
| key (Integer) | Key for item, to be used for selection | |
| value (String) | Value of the item | |
| dates | dates (JsonArray) | List of Selected Dates |
| key (Integer) | Key for item, to be used for selection | |
| value (String) | Value of the item | |
| tickets | tickets (JsonArray) | List of selected Tickets |
| key (Integer) | Key of the Selected Item | |
| value (String) | Value of the Selected Item | |
| description (String) | Description of the Selected Item | |
| price (Double) | Price of the Selected Item as per quantity | |
| currency (String) | Currency of the Selected Item's Price | |
| quantity (Integer) | Quantity of the selected Item | |
| timeslots | timeslots (JsonArray) | List of Selected Timeslots |
| key (Integer) | Key for item, to be used for selection | |
| value (String) | Value of the item | |
| pickups | pickups (JsonArray) | List of Selected Pickup |
| key (Integer) | Key for item, to be used for selection | |
| value (String) | Value of the item | |
| language | language (JsonArray) | List of Selected Language |
| key (Integer) | Key for item, to be used for selection | |
| value (String) | Value of the item | |
| extras | extras (JsonArray) |
List of Selected Extras |
| key (Integer) |
Key for item, to be used for selection | |
| value (String) |
Value of the item | |
| seatMap | seatMap (JsonArray) |
List of Selected Extras |
| key (Integer) |
Key for item, to be used for selection | |
| value (String) |
Value of the item | |
| shipmentMethod | shipmentMethod (JsonArray) |
List of Selected Extras |
| key (Integer) |
Key for item, to be used for selection | |
| value (String) |
Value of the item | |
| customerInfo | customerInfo (JsonArray) |
List of selected item |
| groupKey (Integer) |
Key of the Group | |
| groupFields | groupFields (JsonArray) |
Group Field of the selected group |
| key (Integer) |
Key of the Field of that Group | |
| value (String) |
Value for the Group Field |
| Sightseeing 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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 | |