getoptionals

Returns the optional services available for a tour (extras/add-ons).

This endpoint returns the list of optional services available for a tour and date range. It does not calculate the total amount for a reservation.

endpoints

production

https://newapi.vpttours.com/getoptionals

request parameters

brochure
[int][required]

Brochure code.


code
[int][required]

Tour code.


language
[int]

Language code in which we want to make the request.


start_date
[date][required]

Start date of the main circuit.

Use the actual circuit start date to obtain the optional services available for that trip.


end_date
[date][required]

End date of the main circuit.

Use the actual circuit end date to obtain the optional services available for that trip.


response data

codempre
[int]

Company code.


codfovia
[int]

Optional service brochure code.

For circuit optional reservations, send this value as brochure in booktour.


coditine
[int]

Optional service code.

For circuit optional reservations, send this value as code in booktour.


desitine
[string]

Optional service description.


permiweb
[int]

Indicates if the optional service is allowed on the web.


codpobla
[int]

City code related to the optional service.


despobla
[string]

City name related to the optional service.


precio
[decimal]

Optional service unit price per passenger/person.

This value is not the total reservation amount.


precio_nino
[decimal|null]

Optional service unit price per child, when applicable.

If null, no specific child price is available.


comision
[decimal]

Commission percentage applied to the optional service.


coddivisa
[int]

Currency code.


simdivisa
[string]

Currency symbol.


fechaini
[date]

Date of the optional service for the selected circuit.

For circuit optional reservations, send this value as date in booktour.

Do not use the departure date of the main circuit as the optional service date.


important note

The prices returned by getoptionals are unit prices per passenger/person.

This endpoint only returns the optional services available for a tour and date range. It does not calculate the total amount for a booking or reservation, because passenger occupancy is not required in this request.

For circuit optional reservations, the booking data must be taken from the same item returned by getoptionals:

The optionals node returned by gettour is informational. To book a circuit optional, use the booking data returned by getoptionals.

If the same optional service appears more than once in getoptionals, each result must be treated independently. Do not combine brochure, code, date or price values from different results.

To book the optional service, send the selected values in booktour together with the paxs node, optional: 1 and the reservationcode of the already confirmed main circuit reservation.

The API will return the quantity and total amount calculated according to the passengers sent.

Example:

getoptionals result:
codfovia: 264
coditine: 14
fechaini: 2027-01-18
precio: 86 USD

booktour:
brochure: 264
code: 14
date: 2027-01-18

Passengers sent in paxs: 2
Total amount returned by API: 172 USD

request example

{
  "logindata": {
    "useremail": "{{vpt_login}}",
    "userpass": "{{vpt_pass}}",
    "integrator_token": "XXXXXX"
  },
  "requestdata": {
    "brochure": 211,
    "code": 51820,
    "start_date": "2025-06-28",
    "end_date": "2025-07-15",
    "language": "1"
  }
}

response example

[
  {
    "codempre": "1",
    "codfovia": "235",
    "coditine": "18",
    "desitine": "BARRIO LATINO Y BARRIO DE MONTMARTRE",
    "permiweb": "0",
    "codpobla": "823",
    "despobla": "PARIS",
    "precio": "65.00",
    "precio_nino": null,
    "comision": "10.00",
    "coddivisa": "2",
    "simdivisa": "USD",
    "fechaini": "2025-07-02"
  },
  {
    "codempre": "1",
    "codfovia": "235",
    "coditine": "14",
    "desitine": "CRUCERO E ILUMINACIONES DE PARIS",
    "permiweb": "0",
    "codpobla": "823",
    "despobla": "PARIS",
    "precio": "83.00",
    "precio_nino": null,
    "comision": "10.00",
    "coddivisa": "2",
    "simdivisa": "USD",
    "fechaini": "2025-07-02"
  },
  {
    "codempre": "1",
    "codfovia": "235",
    "coditine": "24",
    "desitine": "VERSALLES CON PALACIO Y JARDINES",
    "permiweb": "0",
    "codpobla": "823",
    "despobla": "PARIS",
    "precio": "106.00",
    "precio_nino": null,
    "comision": "10.00",
    "coddivisa": "2",
    "simdivisa": "USD",
    "fechaini": "2025-07-02"
  }
]