Get Product

The following sections describe each how to retrieve product from a supplier.

Path

GET /api/consumer/product/{productId}

Input parameters

Field	mandatory	Type	format	Description	Example
Accept-Language	N	String	ISO 639-1	Default value : en	en
productId	Y	Integer	N/A	The unique ID of the Product	42
externalClientId	N	string	255 alphanumeric characters maximum	Identifier that is appended to the Booking URL to allow Consumer Systems to track traveler bookings	ABCDEF

Output

Field	Type	format	Description	Example
id	integer	N/A	id of the product	65
externalId	string	N/A	external id of the product	cwdc52e
title	string	N/A	title of the product	Cannes by night
creationDate	date	DateTime	date of creation of the product	5/12/2022 17:32
updateDate	date	DateTime	date of the last update of the product	5/12/2022 17:32
internalName	string	N/A	name of the product	Cannes by night
reference	string	N/A	reference of the product	5615_cannes
instantConfirmation	boolean	true, false	Indicates whether the product offers instant booking confirmation	true
instantDelivery	boolean	true, false	Indicates whether the product offers instant ticket delivery after booking	true
likelyToBeSoldOut	boolean	true, false	Indicates whether the activity is expected to sell out soon. A value of true suggests limited remaining spots or high demand, while false indicates that availability is not currently at risk	false
skipTheLine	boolean	true, false	Does this product include priority access that allows participants to bypass standard admission queues?	true
availabilityType	string	START_TIME, OPENING_HOURS	availability type	contact
redemptionMethod	string	MANIFEST, DIGITAL, PRINT	Ticket redemption method	PRINT
subtitle	string	N/A	subtitle of the product	Cannes by night
short description	string	N/A	short description of the product	a great tour to discover cannes by night, bars, restaurants, old city, and more !
description	string	N/A	description of the product	a great tour to discover cannes by night, bars, restaurants, old city, and more !
thumbnailImage	string	URL	URL of the thumbnail image for this product	http://static.apidae-tourisme.com/filestore/objets-touristiques/images/225/17/11538913.jpg
bookingEngine	string	string	ELLOHA, REGIONDO, VIATOR, BOOKINGKIT, HOLIBOB, DISCOVER, SHERPA, TRIPADVISOR, GOOGLEPLACES, VAKARIO, VAOLO, ALLIANCE_RESEAUX, TICKETAC, APIDAE, MANAWA, GURUWALK, TRAVEL_CURIOUS, COVER_MANAGER, MR_PLAN	website used to book the activity
bookingURL	string	URL	url to book the product	https://amadeus.booking.holibob.tech/product/2430574d-1f2e-4e1f-8148-5c682a733f45?externalCLientId=ABCDEF
minPrice	double	N/A	price minimum for this product	10
maxPrice	double	N/A	price maximum for this product	150
priceCurrency	string	ISO 4217	currency to book the product	EUR
pricingUnit	string	PER_PERSON, PER_VEHICLE, GROUP, FAMILY, PER_EQUIPMENT, PACKAGE, PER_BOAT, NONE,	unit for the price	PER_PERSON
minParticipants	integer	N/A	minimum number of person for this product	5
maxParticipants	integer	N/A	maximum number of person for this product	30
adress	string	N/A	adress of the product	13 rue d’antibes, 06150 Cannes
placeId	integer	string	google id of the address	dswfef15dq
website	string	URL	website url of the product	https://www.nightflow.com/cannes-nightlife/
geolocation	object	N/A	geolocation of the product
geolocation/latitude	float	decimal degrees format from -90 to 90	latitude	45.279864
geolocation/longitude	float	decimal degrees format from -180 to 180	longitude	6.813755
geolocation/geoHash	string	N/A	hash of the coordinate	ds5cdc84fe
duration	string	ISO 8601	duration of the product	PT30M
galleryImage	object	N/A	list of images
galleryImage/title	string	N/A	title of the image	cannes port
galleryImage/url	string	URL	url of the image
galleryImage/order	integer	N/A	order of appearance in the gallery	1
taxonomies	List	N/A	List of the taxonomies linked to this product	[ [ { “id”: “activities-tours-by-theme”, “name”: “Tours by theme”, “level”: 1 }, { “id”: “activities-tours-by-theme-walking-tours”, “name”: “Walking tours”, “level”: 2 } ], [ { “id”: “activities-nature-outdoors”, “name”: “Nature & outdoors”, “level”: 1 }, { “id”: “activities-nature-outdoors-land-activities”, “name”: “Land activities”, “level”: 2 } ] ]
taxonomies/Id	string	N/A	slug term of the taxonomy	activities-tours-by-theme
taxonomies/name	string	N/A	name of the taxonomy	Tours by theme
taxonomies/level	integer	N/A	level of the taxonomy	1
aiGenerated	Object	N/A	Object containing a list of domain generated by ai	{ “translation”: true}
aiGenerated/translation	boolean	N/A	Flag to indicate if the recommendation is AI generated or not for translation	true

Response Body

{
  "id": 2325254,
  "externalId": "zFTHNapiAyPJhKVu2nKP",
  "organizationId": 2325208,
  "authorId": 2325208,
  "name": "Les Incontournables ",
  "creationDate": "2022-05-10T11:56:30.039+00:00",
  "updateDate": "2022-05-10T12:00:37.577+00:00",
  "deleted": false,
  "type": "experiences",
  "products": [
    {
      "id": 275860,
      "externalId": "3994bafd-af5a-4b48-9881-221f616e26ec",
      "title": "Valentine's day dinner and show at Lido Paris",
      "creationDate": "2022-01-11T04:12:28.562+00:00",
      "updateDate": "2022-02-13T04:18:43.528+00:00",
      "shortDescription": "Feel the romanticism of Paris celebrating Saint Valentine's Day at Lido Paris, the most romantic cabaret in town! Before the show starts, you'll be served a 3-course dinner. Then, sit back and enjoy the Paris Merveilles show! Fascinating acrobats, incredible ice skaters, and the glamourous Bluebell Girls reinvent Paris adorned with fabulous hand-made costumes all made of feathers, rhinestones, and glitter.",
      "description": "Feel the romanticism of Paris celebrating Saint Valentine's Day at Lido Paris, the most romantic cabaret in town! Before the show starts, you'll be served a 3-course dinner. Then, sit back and enjoy the Paris Merveilles show! Fascinating acrobats, incredible ice skaters, and the glamourous Bluebell Girls reinvent Paris adorned with fabulous hand-made costumes all made of feathers, rhinestones, and glitter.",
      "thumbnailImage": "921beac1-ac07-406f-8ffa-d6b66fbd1f99",
      "bookingEngine": "HOLIBOB",
      "bookingUrl": "https://alentour.booking.holibob.tech/product/3994bafd-af5a-4b48-9881-221f616e26ec?bookingExternalReference=2325208",
      "minPrice": 0,
      "maxPrice": 0,
      "priceCurrency": "EUR",
      "pricingUnit": "NONE",
      "address": "Paris, France",
      "placeId": "",
      "website": "",
      "geoLocation": {
        "latitude": 48.872332,
        "longitude": 2.300801,
        "geoHash": "u09wh2gmu"
      },
      "duration": "",
      "galleryImages": [
        {
          "url": "https://images.holibob.tech/eyJrZXkiOiJwcm9kdWN0SW1hZ2VzL2VhNzdkODZkLTYyMTYtNDNhZi04OWJmLWE3ZTVhMjI1NzcwMSJ9",
          "order": 0
        }
      ],
      "supplier": {
        "id": 128642,
        "name": "Lido de Paris",
        "externalId": "80501e2e-29c4-447e-a3ef-4ea7d4c67510",
        "contact": {},
        "countryCode": "FR",
        "countryName": "France"
      },
      "onlineBookable": true,
      "descriptors": [
        {
          "type": "EXCLUDED",
          "reason": "DEPRECATED"
        }
      ],
      "availableLanguages": [
        "en",
        "es",
        "fr"
      ],
      "taxonomies": [
        [
          {
              "id": "activities-tours-by-theme",
              "name": "Tours by theme",
              "level": 1
          },
          {
              "id": "activities-tours-by-theme-walking-tours",
              "name": "Walking tours",
              "level": 2
          }
        ],
        [
          {
              "id": "activities-nature-outdoors",
              "name": "Nature & outdoors",
              "level": 1
          },
          {
              "id": "activities-nature-outdoors-land-activities",
              "name": "Land activities",
              "level": 2
        }
        ]
      ]
    }
  ]
}

Status code

List of HTTP codes

HTTP code	Code description
200	Successful retrieval of product
400	Wrong filter expression
401	Unauthorized
403	Forbidden
404	No supplier matching specified criteria
500	Internal server error