Detail Simple and Full Request

The detail API call returns the whole details including exact prices for a given activity code, modality code or pickup code (last two are optional).

From a business perspective the activity or service is configured with the following structure:

activity

The detail API call groups the rates, sessions, languages and dates available with the same price for a modality and Activity and clearly define the combinations with a rateKey. All the rateKeys are temporary stored in APITUDE for Activities. Having the rateKey temporarily stored helps you to only make the reference to it in the confirmation operation and the confirmation is pretty simple (check on the confirmation operation)

Consider the following fragment of the response from the detail call (in this example is for two adults):

{
  "operationId": "ACTRTR-AVAILABILITYDetailsSimple-vke6hrrs5r1vncmv6opct9bd9d",
  "auditData": {... },
  "activity": {
    "amountsFrom": [...],
    "operationDays": [...],
    "modalities": [{
      "duration": {... },
      "destinationCode": "BCN",
      "minChildrenAge": 2,
      "maxChildrenAge": 12,
      "amountsFrom": [...],
      "amountUnitType": "PAX",
      "rates": [{
        "rateCode": "GENERIC",
        "rateDetails": [{
          "rateKey": "4qnr135lvuucjm653fb50aj352",
          "operationDates": [{
            "from": "2016-03-29",
            "to": "2016-03-29",
            "cancellationPolicies": [...]
          }, {
            "from": "2016-03-30",
            "to": "2016-03-30",
            "cancellationPolicies": [...]
          }],
          "sessions": [{
            "code": "MORNING",
            "name": "Morning session at 10:00AM"
          }, {
            "code": "EVENING",
            "name": "Evening session at 8:00PM"
          }],
          "languages": [{
            "code": "es",
            "name": "Spanish"
          }, {
            "code": "en",
            "name": "English"
          }]
          "minimumDuration": {... },
          "maximumDuration": {... },
          "paxAmounts": [{
            "paxType": "CHILD",
            "ageFrom": 2,
            "ageTo": 12,
            "amount": 15,
            "boxOfficeAmount": 15
          }, {
            "paxType": "ADULT",
            "ageFrom": 13,
            "ageTo": 999,
            "amount": 65,
            "boxOfficeAmount": 65
          }],
          "agencyCommission": {... },
          "totalAmount": {
            "amount": 130,
            "boxOfficeAmount": 130
          }
        }]
      }],
      "supplierInformation": {... },
      "providerInformation": {... },
      "comments": [...],
      "code": "DALIMENU",
      "name": "Dalí menu and show"
    }]
    "code": "E-E10-PF2SHOW",
    "type": "TICKET",
    "name": "Tablao Palacio de Flamenco - Show 2",
    "currency": "EUR"
  }
}

As it can be seen in the example above, for a given rateKey (“4qnr135lvuucjm653fb50aj352” in the example) which is associated to a modality and activity, a combination of dates, laguages and sessions are offered for the same price (130 in the example). So, the following choices have the same price:

  • Operation dates: 29 and 30 March
  • Languages: English and Spanish
  • Sessions: Morning and Evening.

There are two options when executing the Detail operation. These are:

  • With a full contents factsheet (full) included
  • With a simplified contents factsheet  (simple) included 

It’s recommended to store or cache the contents factcheets to avoid bandwidth usage and reduce the processing time for the detail operation. See cache recommendations for more details on how to cache results. However, in the event that it’s not possible to store the contents, the detail can return them online by using the “full” detail api call. On the contrary if only minimum content information is required you can use the Detail Simple operation. 

Details Simple

This operation returns the details and price of an activity with a reduced contents structure (lighter).

Below an example of how to structure the call:

{
  "code": "E-E10-PF2SHOW",
  "from": "2016-03-29",
  "to": "2016-03-30",
  "language": "en",
  "paxes": [
    {"age": 30},
    {"age": 30}
   ]

The example above contains a service code, a date range (date from and date to) a language in which the descriptions will be returned and a list of paxes with their ages.

Specifications

Live URL: https://api.hotelbeds.com/activity-api/3.0/activities/details

Test URL: https://api.test.hotelbeds.com/activity-api/3.0/activities/details

Method: POST 

NAME

DESCRIPTION

Mandatory

code

Activity code.

Yes

From

Return activities available dates and prices from the specified date (format: YYYY-MM-DD)

Yes

To

Return activities available dates and prices up to the specified date (format: YYYY-MM-DD)

Yes

Language

Language code in which multi-language texts will be returned. (see here for static list of language codes or use the Contents API to retrieve them).

If no language is provided, the results will be returned in the language previously used to authenticate credentials (see authentication procedure).

No

Paxes

List of passengers details .

Yes (at least ages) Example for two adult paxes:

"paxes": [

  {"age": 30},

  {"age": 30}

]

Details Full

This operation returns the details and price of an activity including the full contents factsheet.

The following is an example on how to structure the call:

{
  "code": "E-E10-PF2SHOW",
  "from": "2016-03-29",
  "to": "2016-03-30",
  "language": "en",
  "paxes": [
    {"age": 30},
    {"age": 30}
   ]
}
Specifications

Live URL: https://api.hotelbeds.com/activity-api/3.0/activities/details/full

Test URL: https://api.test.hotelbeds.com/activity-api/3.0/activities/details/full

Method: POST

NAME

DESCRIPTION

Mandatory

code

Activity code.

Yes

From

Return activities available dates and prices from the specified date (format: YYYY-MM-DD)

Yes

To

Return activities available dates and prices up to the specified date (format: YYYY-MM-DD)

Yes

Language

Language code in which multi-language texts will be returned. (see here for static list of language codes or use the Contents API to retrieve them).

If no language is provided, the results will be returned in the language previously used to authenticate credentials (see authentication procedure).

No

Paxes

List of passengers details .

Yes (at least ages) Example for two adult paxes:

"paxes": [

  {"age": 30},

  {"age": 30}

]

In addition to it, there is also the capability to obtain the detailed content for a particular service and modality. The only requirement is to specify this in the request as detailed below:

 

{
  "code": "E-E10-TABLAO3SHO",
  "modalityCode": "COPA SHOW",
  "from": "2016-05-28",
  "to": "2016-05-30",
  "language": "en",
  "paxes": [
    {"age": 30},
    {"age": 8}
   ]
}

Docs Navigation