Car Book
- This service method is used to confirm a car reservation.
- The ClientReference should be unique for all the bookings and the passenger details should be passed in the booking request only.
Car Book Request
| Tags | Attribute | Description |
|---|---|---|
| carBookingCriteria | (JsonObject) | |
| searchKey* (String) |
Unique Key for the car search | |
| offerId* (String) |
Unique Key for the car result | |
| bookingReferenceId (String) |
This is for the re-initiate booking.If booking is being confirmed later (after holding),then generated booking reference need to be passed here. Not released yet |
|
| clientReference* (String) |
||
| currency* (String) |
||
| passengers | (List) | |
| passenger | (Object) | |
| passengerKey* (String) |
this is the unique key for the passenger | |
| leadPassenger* (Boolean) |
true if for the lead passenger | |
| ptc* (String) |
passenger type (adult, child) | |
| passengerInfo | (Object) | |
| givenName* (String) |
first name | |
| middleName* (String) |
middle name should be passed if pan is mandatory in Hotel room service | |
| surName* (String) |
surname | |
| gender* (String) |
gender | |
| nameTitle* (String) |
salutation Eg(mr,ms) | |
| birthday* (String) |
passenger's birthdate | |
| contact | (Object) | |
| contactProvided | (List) | |
| emailAddress* (listOfString) |
email address - supports only for a single email id | |
| phone | (List) | |
| label (String) |
label Not released yet |
|
| phoneNumber (String) |
phone number | |
| areaCode (String) |
Not released yet |
|
| loyaltyProgramAccount | (JsonObject) | |
| accountNumber (String) |
account number Not released yet |
|
| dateOfIssue (String) |
date of issue Not released yet |
|
| placeOfIssue (String) |
place of issue Not released yet |
|
| expDate (String) |
expiry date Not released yet |
|
| identityDocument | (JsonObject) | |
| idType (String) |
Not released yet |
|
| idDocumentNumber (String) |
Not released yet |
|
| isCorporatePAN (String) |
Not released yet |
|
| issuingCountryCode (String) |
Not released yet |
|
| applicableCountry (String) |
Not released yet |
|
| placeOfBirth (String) |
Not released yet |
|
| dateOfIssue (String) |
Not released yet |
|
| residenceCountryCode (String) |
Not released yet |
|
| expiryDate (String) |
Not released yet |
|
| taxDetails | (JsonObject) | |
| taxName (String) |
Not released yet |
|
| regNo (String) |
Not released yet |
|
| companyName (String) |
Not released yet |
|
| emailAddress (String) |
Not released yet |
|
| phoneNo (String) |
Not released yet |
|
| address (String) |
Not released yet |
|
| paymentDetails | paymentDetails * (Object) |
|
| paymentMode * (String) |
Ex: CC = Credit Card, CR = Credit, CS = CASH |
|
| transactionAmount * (Double) |
Total transaction amount | |
| cardInfo (String) |
Encrypted.card.details.to.be.passed.here | |
| address | address (Object) |
This address will use for payment details |
| label (String) |
Ex: "Billing" | |
| street (String) |
Ex: "Beeches Apartment","200 Lampton Road" | |
| postalCode (String) |
Ex: "TW345RT" | |
| cityName (String) |
Ex: "NYK" | |
| countryCode (String) |
Ex: "USA" |
Car Book Response
Following table contains the attributes of the booking response and the description.
| 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" | |
| 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 (Object) |
|
| offerId* (String) |
A unique offer id will be returned in the search response per each result.This should be used all subsequent API calls for identify user selected result. | |
| bookingReferenceId* (String) |
Generated booking reference. | |
| supplierLocator* (String) |
This tag contains the supplier locator or the supplier booking reference. | |
| clientReference * (String) |
This attribute should be same as the client reference that has been passed during booking request 2023-04-10T10:00 |
|
| bookingStatus * (String) |
This attribute contains the booking status CONFIRMED |
|
| transactionDate * (String) |
This attribute contains the date of the transaction or the date of the booking. | |
| vehicleInfo | vehicleInfo* (Object) |
This tag contains the vehicle information for the booked car result. |
| vehMakeModel * (String) |
This attribute contains the vehicle model | |
| code * (String) |
This attribute contains the car code | |
| model * (String) |
This attribute contains the vehicle model | |
| vehClass* (String) |
This attribute contains the vehicle class | |
| imageUrl (String) | This attribute contains the image url | |
| notes* (String) |
Warning details will be added as the notes in the booking response. | |
| guaranteeInd * (String) |
This attribute indicates the guaranteed indicator | |
| vehicleTypeInfo | vehicleTypeInfo (Object) |
This tag contains the vehicle type information. |
| category (String) |
Category of the car. | |
| categoryId (String) |
Category of the car. | |
| doorCount* (String) |
Door count of the will be shown here. | |
| arConditioned * (String) |
||
| transmissionInfo | transmissionInfo* (Object) |
This attribute indicates transmission information of the car. |
| type (String) |
This attribute indicates whether this is a manual or automatic car | |
| passengerQuantity* (String) |
Number of passengers will be shown here. | |
| smallBaggageQuantity (String) |
Baggage quantity related information will be shown here. | |
| largeBaggageQuantity (String) |
Baggage quantity related information will be shown here. | |
| totalBaggageQuantity* (String) |
Baggage quantity related information will be shown here. | |
| prepaid * (Boolean) |
This attribute indicates whether this is a pre paid reservation or not. | |
| fuelInfo | fuelInfo * (String) |
This tag contains the fuel related information of the car. |
| fuelType * (String) |
||
| excessDetail (String) |
||
| vehicleRate | vehicleRate * (Object) |
This tag contains the price related information of the relevant car. |
| vehicleCharge | vehicleCharge * (Object) |
|
| amount * (Double) |
Amount attribute contains the total fare of the reservation. | |
| currencyCode* (String) |
Currency code received | |
| amount * (Double) |
Amount attribute contains the total fare of the reservation. | |
| currencyCode* (String) |
This attribute contains the client currency. | |
| taxes | taxes (List) |
This tag contains all the out put taxes which are included in the total fare. |
| name * (String) |
||
| amount * (Double) |
||
| included (Boolean) |
This attribute shows whether the tax amount is included in the above total fare amount. | |
| supplierAdditionalFareInfo | supplierAdditionalFareInfo(JsonObject) | Additional fare information related to supplier |
| currency (String) |
Currency received in supplier response (Buying currency) | |
| discount (Double) |
Any discount return in supplier response (Currently car suppliers do not return any discount ) Not released yet |
|
| publishedFare (Double) |
Amount received in supplier response (Buying amount) | |
| commissionEarned (Double) |
Any commission amount returned in supplier response (Currently cars suppliers do not return any commission value) Not released yet |
|
| offeredFare (Double) |
Not released yet |
|
| tdsOnCommission (Double) |
Not released yet |
|
| serviceFee (Double) |
Not released yet |
|
| customerAdditionalFareInfo | customerAdditionalFareInfo(JsonObject) | Additional fare information related to customer |
| transactionFeeEarned (Double) |
This attribute contains the transaction fee amount. | |
| tdsOnCommission (Double) |
Commission amount on tds will be shown here. Not released yet |
|
| commissionEarned (Double) |
This attribute shows the total commission amount. | |
| 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) | |
| cgst (Double) |
GST received from pricing model if applicable.Currently there is no gst component for cars Not released yet |
|
| sgst (Double) |
Not released yet |
|
| igst (Double) |
Not released yet |
|
| pricedCoverages | pricedCoverages* (List) |
Priced coverage tag shows all the inclusions and exclusions. |
| description * (String) |
||
| included* (Boolean) |
This attribute shows whether the mentioned fare information is an inclusion or not | |
| financialInfo | financialInfo * (Object) |
|
| supplier * (String) |
||
| subSupplierCode (String) | Not released yet | |
| payment | payment (Object) |
Not released yet |
| tmc (String) |
This tag contains supplier owner name. tmc - Travel Management Company. Not released yet |
|
| paymentTypes (String) |
Not released yet | |
| paymentNetwork (String) |
Not released yet | |
| passengers | (JsonObject) | |
| passenger | (JsonArray) | |
| passengerKey* (String) |
this is the unique key for the passenger | |
| isLead* (Boolean) |
true if for the lead passenger | |
| ptc* (String) |
passenger type (adult, child) | |
| passenger's meal preference | ||
| passengerInfo | (JsonArray) | |
| givenName* (String) |
first name | |
| middleName* (String) |
middle name should be passed if pan is mandatory in Hotel room service | |
| surName* (String) |
surname | |
| gender* (String) |
gender | |
| nameTitle* (String) |
salutation Eg(mr,ms) | |
| birthday* (String) |
passenger's birthdate | |
| contact | (JsonArray) | |
| postalAddress | (JsonObject) | |
| label (String) |
label Not released yet |
|
| street (String) |
street name Not released yet |
|
| postalCode (String) |
postal code Not released yet |
|
| cityName (String) |
city name Not released yet |
|
| countryCode (String) |
country code Not released yet |
|
| contactsProvided | (JsonArray) | Supports only for a single contact provide |
| contactsProvided | (JsonObject) | |
| emailAddress* (listOfString) |
email address - supports only for a single email id | |
| phone | (JsonObject) | |
| label (String) |
label Not released yet |
|
| phoneNumber * (String) |
phone number | |
| areaCode * (String) |
Not released yet |
|
| loyaltyProgramAccount | (JsonObject) | |
| accountNumber (String) |
account number Not released yet |
|
| dateOfIssue (String) |
date of issue Not released yet |
|
| placeOfIssue (String) |
place of issue Not released yet |
|
| expDate (String) |
expiry date Not released yet |
|
| identityDocument | (JsonObject) | |
| idType (String) |
identification type (PAN,PASSPORT) are the supported types Not released yet |
|
| idDocumentNumber (String) |
id number Not released yet |
|
| isCorporatePAN (String) |
(only for PAN type) - if it is a corporate PAN Not released yet |
|
| issuingCountryCode (String) |
country of issue Not released yet |
|
| applicableCountry (String) |
applicable country Not released yet Not released yet |
|
| placeOfBirth (String) |
birth place Not released yet |
|
| dateOfIssue (String) |
issue date Not released yet |
|
| residenceCountryCode (String) |
residence country Not released yet Not released yet |
|
| expiryDate (String) |
expiry date Not released yet |
|
| vehicleLocationDetails | vehicleLocationDetails (Object) |
|
| pickUpLocationDetail | pickUpLocationDetail* (Object) |
Pick up location related information will be shown in this tag. |
| name * (String) |
||
| address * (String) |
||
| phoneNumber * (String) |
||
| locationInfo * (String) |
||
| longitude (String) |
||
| latitude (String) |
||
| workingHoursDetails | workingHoursDetails* (Object) |
This tag contains the working hours related information. |
| day * (String) |
This attribute contains the working day | |
| openHours * (String) |
This attribute contains the working hours - start time | |
| closeHours * (String) |
This attribute contains the working hours - end time | |
| dropOffLocationDetail | dropOffLocationDetail* (Object) |
Drop off location related information will be shown in this tag. |
| name* (String) |
||
| address * (String) |
||
| phoneNumber* (String) |
||
| locationInfo (String) |
||
| longitude (String) |
||
| latitude (String) |
||
| workingHoursDetails | workingHoursDetails* (Object) |
This tag contains the working hours related information. |
| day * (String) |
This attribute contains the working day | |
| openHours * (String) |
This attribute contains the working hours - start time | |
| closeHours * (String) |
This attribute contains the working hours - end time |
| Car 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 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | |