DEdespegar
Availability

Availability

get/availability

Request

  • Base URL
    https://api-dev.despegar.com/v3/activities-api
  • URL
    https://api-dev.despegar.com/v3/activities-api/availability
  • Auth
    API key in header x-apikey

Query parameters

idstring required

This information must be obtained from the response of the 'Modalities' service,

modalitystring required

Modality chosen by the user; this information must be obtained from the detail service response, in the structure: 'modalities' -> 'id'.

datestring date required

Date on which the activity will take place; the format to send is YYYY-MM-DD.

sitestring required
Example:br

Refers to the country code; it must contain two alphabetic characters

language'es' | 'pt' | 'en' required

This field must be filled with the language in which you want to receive the response

additionalsstring

Refers to the ID of the additional attraction; this information must be obtained from the response of the 'Modalities' service, field 'id' within the 'additionals' structure.

distributionstring
Example:2-8-8-4-4

In this field, send the distribution of people in the activity. The first position always refers to the number of adults; the remaining positions should be the ages of the minors (children or infants).Example: for an activity with 2 adults, two 8-year-olds, and two 4-year-olds

schedulenumber

In this field, send the distribution of people in the activity. The first position always refers to the number of adults; the remaining positions should be the ages of the minors (children or infants).Example: for an activity with 2 adults, two 8-year-olds, and two 4-year-olds

Response

Successful response

choice_idstring

ID generated to identify the ticket data and the valid fare to make the reservation.

namestring

Attraction name.

modality_choice_namestring

Name of the chosen modality.

typestring

Refers to the type of activity.

languagestring

Identifies the language.

sitestring

Country code identifying the site. E.g.: BR, AR.

destinationstring

IATA code identifying the destination. E.g.: ORL, BUE.

fromstring date-time

Start date of the activity in ISO 8601 format.

tostring date-time

End date of the activity in ISO 8601 format.

highlightsstring[]

List of highlights or featured attractions included in the activity.

Example response

{
  "highlights": [
    "Sample Highlight 1",
    "Sample Highlight 2"
  ],
  "ticket_validity": {
    "use_date": "2024-01-01",
    "use_expiration_date": "2024-01-01T23:59:59Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.