Skip to content

Sightseeing Book
Run in Postman

/api/v1/reservation/sightseeing-book   
This service is used to perform booking for the sightseeing result.

Sightseeing Book Request

Tags Attribute Description
sightseeingBookingCriteria (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.
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.
questions questions
(Array)
Contains an array of questions and their corresponding answers, enabling structured information retrieval.
questionCode
(String)
An essential identifier that uniquely distinguishes each question within the array.
questionText
(String)
The human-readable text representing the question, providing context for users or systems.
answerText
(String)
The corresponding answer or response to the associated question, offering valuable information.
passengers passengers*
(Array)
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*
(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.
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.
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 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 (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 Request
{
  "searchKey": "6bca2fd7-dcbe-482a-b8fb-b8abedf73871",
  "offerId": "f43e86c1-4673-4bb6-8afb-c46a04e616a90MARHABASTR00000001",
  "clientReferenceId": "BK-1209",
  "totalNet": 106,
  "currency": "AED",
  "questions": [
    {
      "code": "QUE111",
      "text": "Sample Question?",
      "answer": "Sample Answer"
    }
  ],
  "passengers": [
    {
      "passengerKey": "SH4H23B-1",
      "ptc": "ADT",
      "leadPassenger": true,
      "passengerInfo": {
        "birthDate": "2004-12-15",
        "gender": "M",
        "nameTitle": "Mr",
        "givenName": "Anil",
        "middleName": "",
        "surname": "Kumar"
      },
      "contact": {
        "contactProvided": [
          {
            "emailAddress": [
              "AA@BA.COM"
            ],
            "phone": [
              {
                "phoneNumber": "68465464654"
              }
            ]
          }
        ]
      }
    }
  ],
  "paymentDetails": {
    "cardInfo": "",
    "paymentMode": "",
    "address": {
      "label": "",
      "street": "",
      "postalCode": "",
      "cityName": "",
      "countryCode": ""
    }
  }
}


Sightseeing Book Response

After sending the sightseeing book request Travlinq will book the specified sightseeing booking.

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, "Sightseeing booking."
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
(Object)
bookingReferenceNumber*
(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."
sightseeing sightseeing *
(Object)
Contains details of sightseeing booking.
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.
productName*
(String)
It presents a unique product name corresponding to the selected result for clear identification.
productCode*
(String)
It presents a unique product code that aids in distinguishing the product within the response.
productCategory*
(String)
It presents the product category that aids in distinguishing the product within the response.
productDescription*
(String)
Offers a comprehensive description of the product, providing detailed information for client understanding.
priceInfo priceInfo*
(Object)
Provides comprehensive pricing and fare information, ensuring transparency in the breakdown of pricing components.
netAmount *
(Double)
Specifies the net amount of the product, aiding in understanding the overall price of the product.
currency *
(String)
Indicates the currency code, such as "AED," associated with the product's pricing.
taxes taxes *
(Array)
Contains information about taxes associated with the sightseeing offer.
name*
(String)
The name or label of the tax.
amount*
(Double)
The amount of the tax.
included*
(Boolean)
Indicates whether the tax is included in the product price (true) or added on top of the price (false).
taxCode*
(String)
A code or identifier for the tax, if applicable.
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.
commissionEarned*
(Double)

Not released yet
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 sightseeing
Not released yet
sgst*
(Double)

Not released yet
igst*
(Double)

Not released yet
passengers passengers*
(Array)
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*
(Object)
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*
(Object)
Contains contact information for the 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.
Sightseeing book response
{
  "meta": {
    "success": true,
    "statusCode": 1,
    "statusMessage": "SUCCESS",
    "actionType": "Sightseeing book",
    "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
  },
  "commonData": {
    "searchKey": "6bca2fd7-dcbe-482a-b8fb-b8abedf73871"
  },
  "data": [
    {
      "bookingReferenceId": "",
      "bookingStatus": "Confirmed",
      "transactionDate": "2023-10-09",
      "clientReference": "",
      "supplierReferenceId": "",
      "sightseeing": {
        "bookingStatus": "",
        "offerId": "6bca2fd7-dcbe-482a-b8fb-b8abedf7387100006179TTR00000000",
        "productName": "Mumbai City - Private Walking Tour",
        "productCode": "E-E10-IN-BOHCITY",
        "productCategory": "Transfer",
        "productDescription": "Some Description",
        "pricingInfo": {
          "netAmount": 900,
          "currency": "AED",
          "taxes": [
            {
              "name": "",
              "amount": 9,
              "included": true,
              "taxCode": ""
            }
          ],
          "customerAdditionalFareInfo": {
            "transactionFeeEarned": 0,
            "tdsOnCommission": 0,
            "commissionEarned": 0,
            "markupEarned": 0,
            "discount": 0,
            "vat": 0,
            "cgst": 0,
            "sgst": 0,
            "igst": 0,
            "additionalProperties": []
          }
        }
      },
      "passengers": [
        {
          "passengerKey": "SH4H23B-1",
          "ptc": "ADT",
          "leadPassenger": true,
          "passengerInfo": {
            "birthDate": "2004-12-15",
            "gender": "M",
            "nameTitle": "Mr",
            "givenName": "Anil",
            "middleName": "",
            "surname": "Kumar"
          },
          "contact": {
            "contactProvided": [
              {
                "emailAddress": [
                  "AA@BA.COM"
                ],
                "phone": [
                  {
                    "phoneNumber": "68465464654"
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  ],
  "version": "1.0.0"
}