Generate Voucher for a Booking
You can use this method to generate voucher for a booking using booking reference. - PS: As of now, the voucher is automatically generated immediately after the booking is made.
| Method | Endpoint |
|---|---|
| POST | /api/v3/transfers/bookings/<bref>/voucher |
- <bref> refers to the ‘booking_reference’ returned in the booking response.
View Voucher for a Booking
You can use this method to view voucher if it has been already generated for a booking using booking reference.
| Method | Endpoint |
|---|---|
| GET | /api/v3/transfers/bookings/<bref>/voucher |
- <bref> refers to the ‘booking_reference’ returned in the booking response.
- The response fields are same in view-booking response and generate voucher
Sample Response
{
"transfer": {
"transfer_code": "T!000008008006",
"paxes": [{
"type": "AD",
"surname": "Patrick",
"pax_id": 2,
"name": "Henry"
},
{
"type": "AD",
"surname": "Patrick",
"pax_id": 1,
"name": "James"
}
],
"name": "Accommodation in London to London City Centre with a Driver speaking the Local Language only",
"booking_items": [{
"vehicles": [{
"vehicle_name": "Standard Car",
"vehicle_code": "SA",
"preferred_language": "E",
"max_vehicle_occupancy": {
"max_pax": 2
},
"max_luggage": "2"
}],
"rate_comments": {
"transfer_conditions": "IMPORTANT: All infants and children must ride in an age and size appropriate child safety seat or booster seat. Customers are responsible for providing their own safety seats."
},
"price": 4073,
"pickup_details": {
"pickup_type": "H",
"pickup_code": "H!0103595",
"hotel_name": "1 LEXHAM GARDENS (LON STAYS)"
},
"non_refundable": false,
"drop_details": {
"dropoff_type": "C",
"dropoff_code": "C!000302"
},
"currency": "INR",
"cancellation_policy": {
"under_cancellation": false,
"details": [{
"from": "2017-09-05T00:00:00",
"flat_fee": 4520.32,
"currency": "INR"
}],
"cancel_by_date": "2017-09-04T23:59:59",
"amount_type": "value"
}
}]
},
"supports_cancellation": true,
"supports_amendment": false,
"supplier_reference": "741333",
"search_id": "w6m7eclxupfjihyawgmmuicnai",
"price": {
"total": 4073,
"breakdown": {
"net": [{
"name": "Total",
"included": true,
"currency": "INR",
"amount_type": "value",
"amount": 4072.32
},
{
"name": "SupplierPrice",
"included": true,
"currency": "INR",
"amount_type": "value",
"amount": 4072.32
}
]
}
},
"pickup_time": "23:15:00",
"pickup_date": "2017-09-09",
"payment_type": "AT_WEB",
"payment_status": "pending",
"non_refundable": false,
"no_of_infants": 0,
"no_of_children": 0,
"no_of_adults": 2,
"nationality": "IN",
"holder": {
"title": "Mrs.",
"surname": "James",
"phone_number": "8801622227333",
"name": "Patrick",
"email": "jamie@abc.com"
},
"currency": "INR",
"booking_type": "B",
"booking_status": "",
"booking_reference": "ge7omt2k223omrtl4efwd6xzyu",
"booking_name": "Booking Test",
"booking_id": "GRN-T-201707-000023",
"booking_date": "2017-07-06T01:24:50",
"voucher_issue_date": "2017-03-06T05:41:50",
"supplier_code": "vacation_travels"
}
- Note:
- Voucher will not have price related fields and cancellation policies.
- It will have the following additional fields:
Response
| Attribute | Type | Description |
|---|---|---|
| booking_id | string | Unique booking ID |
| booking_reference | string | Unique booking code. REQUIRED for all future transactions through api |
| booking_name | string | Booking name provided while booking |
| pickup_date | date | pickup date. Format: YYYY-MM-DD |
| pickup_time | time | pickup time. Format HH:MM |
| price | object | Price details of the booking (refer below for more info) |
| non_refundable | boolean | ‘true’ if the rate is Non-refundable. Otherwise, cancellation policies applicable. |
| payment_status | string | Status of the payment. |
| currency | string | Three-letter ISO currency code of the price |
| booking_date | datetime | The date when booking was made |
| status | string | Booking status will be one of the following: 1. confirmed, 2. failed, 3. rejected, 4. pending |
| holder | object | Lead passenger details. Defined in the Holder section in Booking Request |
| transfer | object | Transfer element |
| supports_amendment | boolean | “true” if amendments are allowed |
| supports_cancellation | boolean | “true” if cancellations are allowed |
| booking_comment | string | Optional booking comments passed along to the transfer |
| additional_info | object | Additional information if any. Object of dynamic key value pairs. Eg: { “comments”: “comments come here”, “pickup-Instruction”: “Extra-person charges may apply” |
Transfer
| Attribute | Type | Description |
|---|---|---|
| transfer_code | string | GRN transfer code |
| name | string | Name of the transfer |
| paxes | array | List of the pax in the booking |
| booking_items | array | List of booking items |
| transfer_time | hh:mm |
Booking Item:
| Attribute | Type | Description |
|---|---|---|
| vehicles | array | List of Vehicle elements. vehicles that are part of the booking item. |
| non_refundable | boolean | ‘true’ if the rate is Non-refundable. Otherwise, cancellation policies applicable. |
| rate_comments | object | Additional rate information, if any Object of dynamic key value pairs. Eg: { comments”: “comments come here”, “additional rate info”: “additional details come here” |
| other_inclusions | array | List of additional inclusions (strings), if available |
| cancellation_policy | object | Cancellation policy |
| price | float | Price of the booking item |
| currency | string | Currency of the price. |
| pickup_details | object | See Pickup Details Structure mentioned below |
| dropoff_details | object | See DropOff Details Structure mentioned below |
PickUp Details:
| Attribute | Type | Description |
|---|---|---|
| city_code | string | The city code of the pickup_location |
| pickup_type | string | H - Hotel, S - Station, A - Airport, P - Port, C - City |
| pickup_code | string | Pickup_code of the transfer |
| string | ||
| flight_number train_name address |
string | Depending on the pickup location selected it can have either of the following keys. flight_number - airport (A) train_name - station (S) address and postal_code - city (C) hotel_code - hotel (H) ship_name - port (P) |
| arrival_time | time | arrival_time in pickup_details, departure_time in drop_off_details |
DropOff Details:
| Attribute | Type | Description |
|---|---|---|
| city_code | string | The city code of the dropoff_location |
| dropoff_type | string | H - Hotel, S - Station, A - Airport, P - Port, C - City |
| dropoff_code | string | dropoff_code of the transfer |
| string | ||
| flight_number train_name address |
string | Depending on the dropoff location selected it can have either of the following keys. flight_number - airport (A) train_name - station (S) address and postal_code - city (C) hotel_code - hotel (H) |
| departure_time | time | departure_time in dropoff_details |
Vehicle
| Attribute | Type | Description |
|---|---|---|
| vehicle_type | string | Vehicle type |
| vehicle_code | string | Vehicle code |
| max_vehicle_occupancy | array | An object representing maximum vehicle occupancy.This will be returned when no_of_adults is not available. |
| max_luggage | string | Max luggage allowed key |
| pax_ids | array | List of pax identification details. Represents pax allocation to the vehicle |
| no_of_children | integer | Number of children if available |
| no_of_adults | integer | Number of adults if available |
| no_of_infants | integer | Number of infants if available |
| preferred_language | string | Language selected |
Max Vehicle Occupancy
| Attribute | Type | Description |
|---|---|---|
| max_pax | integer | Maximum number of total guests allowed |
| max_adults | integer | Maximum number of adults allowed |
| max_children | integer | Maximum number of children allowed |