Get product by ID - Headout API docs

curl --location 'https://www.headout.com/api/public/v2/products/<PRODUCT_ID>/?campaignName=<CAMPAIGN_NAME>&languageCode=<LANGUAGE_CODE>&currencyCode=<CURRENCY_CODE>' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "id": "19513",
  "name": "Edge Observation Deck Tickets",
  "canonicalUrl": "https://www.headout.com/edge-observation-deck-tickets/tickets-to-edge-observation-deck-e-19513/",
  "city": {
    "code": "NEW_YORK",
    "name": "New York",
    "image": {
      "url": "//cdn-imgix.headout.com/media/images/ee075882083344be170ed38c8c76b4a1-new-york-city-01.jpeg"
    }
  },
  "media": [
    {
      "url": "https://cdn-imgix.headout.com/media/images/7dff2143faf0c49109d1aeca8a7dcd9f-19513-new-york-edge-observation-deck-adimssion-tickets--09.jpg",
      "type": "IMAGE"
    }
  ],
  "startLocation": {
    "latitude": 40.753395080566406,
    "longitude": -74.00105285644531
  },
  "productType": "ATTRACTION",
  "reviewsSummary": {
    "ratingsCount": 5743,
    "averageRating": 4.4
  },
  "pricing": {
    "currency": "USD",
    "profileType": "PER_PERSON",
    "headoutSellingPrice": 39.2,
    "commissionAmount": 3.92
  },
  "listingPrice": {
    "type": "PER_PERSON",
    "currencyCode": "USD",
    "minimumPrice": {
      "originalPrice": 39.2,
      "finalPrice": 39.2
    },
    "bestDiscount": 0
  },
  "currency": {
    "code": "USD",
    "currencyName": "United States Dollar",
    "symbol": "US$",
    "localSymbol": "$",
    "precision": 2
  },
  "hasInstantConfirmation": true,
  "hasMobileTicket": true,
  "primaryCategory": {
    "id": "1",
    "name": "Tickets"
  },
  "primarySubCategory": {
    "id": "1007",
    "name": "Landmarks",
    "categoryId": "1"
  },
  "primaryCollection": {
    "id": "4012",
    "name": "Edge NYC",
    "cityCode": "NEW_YORK"
  },
  "variants": [
    {
      "id": "38164",
      "name": "General Admission: Timed Entry",
      "description": "Entry to Edge Observatory Deck at the time slot selected",
      "duration": 60000,
      "inventoryType": "FIXED_START_FLEXIBLE_DURATION",
      "pax": {
        "min": 1,
        "max": 10
      },
      "cashback": {
        "value": 0,
        "type": "ABSOLUTE"
      },
      "ticketDeliveryInfoHtml": null,
      "inputFields": [
        {
          "id": "NAME",
          "name": "Full Name",
          "dataType": "STRING",
          "level": "PRIMARY_CUSTOMER"
        }
      ],
      "tags": [
        "RECOMMENDED"
      ],
      "pricing": {
        "currency": "USD",
        "profileType": "PER_PERSON",
        "headoutSellingPrice": 39.2,
        "commissionAmount": 3.92
      }
    }
  ],
  "inventorySelectionType": "NORMAL",
  "cancellationPolicy": {
    "cancellable": false,
    "cancellableUpToInMinutes": null
  },
  "reschedulePolicy": {
    "reschedulable": false,
    "reschedulableUpToInMinutes": null
  }
}

GET

api

public

products

{productId}

curl --location 'https://www.headout.com/api/public/v2/products/<PRODUCT_ID>/?campaignName=<CAMPAIGN_NAME>&languageCode=<LANGUAGE_CODE>&currencyCode=<CURRENCY_CODE>' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "id": "19513",
  "name": "Edge Observation Deck Tickets",
  "canonicalUrl": "https://www.headout.com/edge-observation-deck-tickets/tickets-to-edge-observation-deck-e-19513/",
  "city": {
    "code": "NEW_YORK",
    "name": "New York",
    "image": {
      "url": "//cdn-imgix.headout.com/media/images/ee075882083344be170ed38c8c76b4a1-new-york-city-01.jpeg"
    }
  },
  "media": [
    {
      "url": "https://cdn-imgix.headout.com/media/images/7dff2143faf0c49109d1aeca8a7dcd9f-19513-new-york-edge-observation-deck-adimssion-tickets--09.jpg",
      "type": "IMAGE"
    }
  ],
  "startLocation": {
    "latitude": 40.753395080566406,
    "longitude": -74.00105285644531
  },
  "productType": "ATTRACTION",
  "reviewsSummary": {
    "ratingsCount": 5743,
    "averageRating": 4.4
  },
  "pricing": {
    "currency": "USD",
    "profileType": "PER_PERSON",
    "headoutSellingPrice": 39.2,
    "commissionAmount": 3.92
  },
  "listingPrice": {
    "type": "PER_PERSON",
    "currencyCode": "USD",
    "minimumPrice": {
      "originalPrice": 39.2,
      "finalPrice": 39.2
    },
    "bestDiscount": 0
  },
  "currency": {
    "code": "USD",
    "currencyName": "United States Dollar",
    "symbol": "US$",
    "localSymbol": "$",
    "precision": 2
  },
  "hasInstantConfirmation": true,
  "hasMobileTicket": true,
  "primaryCategory": {
    "id": "1",
    "name": "Tickets"
  },
  "primarySubCategory": {
    "id": "1007",
    "name": "Landmarks",
    "categoryId": "1"
  },
  "primaryCollection": {
    "id": "4012",
    "name": "Edge NYC",
    "cityCode": "NEW_YORK"
  },
  "variants": [
    {
      "id": "38164",
      "name": "General Admission: Timed Entry",
      "description": "Entry to Edge Observatory Deck at the time slot selected",
      "duration": 60000,
      "inventoryType": "FIXED_START_FLEXIBLE_DURATION",
      "pax": {
        "min": 1,
        "max": 10
      },
      "cashback": {
        "value": 0,
        "type": "ABSOLUTE"
      },
      "ticketDeliveryInfoHtml": null,
      "inputFields": [
        {
          "id": "NAME",
          "name": "Full Name",
          "dataType": "STRING",
          "level": "PRIMARY_CUSTOMER"
        }
      ],
      "tags": [
        "RECOMMENDED"
      ],
      "pricing": {
        "currency": "USD",
        "profileType": "PER_PERSON",
        "headoutSellingPrice": 39.2,
        "commissionAmount": 3.92
      }
    }
  ],
  "inventorySelectionType": "NORMAL",
  "cancellationPolicy": {
    "cancellable": false,
    "cancellableUpToInMinutes": null
  },
  "reschedulePolicy": {
    "reschedulable": false,
    "reschedulableUpToInMinutes": null
  }
}

Retrieve full details for a single product by its ID, including all variants, pricing, images, content, location, and input fields required for booking. Optionally localize the response by specifying a language code and currency.

curl --location 'https://www.headout.com/api/public/v2/products/<PRODUCT_ID>/?campaignName=<CAMPAIGN_NAME>&languageCode=<LANGUAGE_CODE>&currencyCode=<CURRENCY_CODE>' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "id": "19513",
  "name": "Edge Observation Deck Tickets",
  "canonicalUrl": "https://www.headout.com/edge-observation-deck-tickets/tickets-to-edge-observation-deck-e-19513/",
  "city": {
    "code": "NEW_YORK",
    "name": "New York",
    "image": {
      "url": "//cdn-imgix.headout.com/media/images/ee075882083344be170ed38c8c76b4a1-new-york-city-01.jpeg"
    }
  },
  "media": [
    {
      "url": "https://cdn-imgix.headout.com/media/images/7dff2143faf0c49109d1aeca8a7dcd9f-19513-new-york-edge-observation-deck-adimssion-tickets--09.jpg",
      "type": "IMAGE"
    }
  ],
  "startLocation": {
    "latitude": 40.753395080566406,
    "longitude": -74.00105285644531
  },
  "productType": "ATTRACTION",
  "reviewsSummary": {
    "ratingsCount": 5743,
    "averageRating": 4.4
  },
  "pricing": {
    "currency": "USD",
    "profileType": "PER_PERSON",
    "headoutSellingPrice": 39.2,
    "commissionAmount": 3.92
  },
  "listingPrice": {
    "type": "PER_PERSON",
    "currencyCode": "USD",
    "minimumPrice": {
      "originalPrice": 39.2,
      "finalPrice": 39.2
    },
    "bestDiscount": 0
  },
  "currency": {
    "code": "USD",
    "currencyName": "United States Dollar",
    "symbol": "US$",
    "localSymbol": "$",
    "precision": 2
  },
  "hasInstantConfirmation": true,
  "hasMobileTicket": true,
  "primaryCategory": {
    "id": "1",
    "name": "Tickets"
  },
  "primarySubCategory": {
    "id": "1007",
    "name": "Landmarks",
    "categoryId": "1"
  },
  "primaryCollection": {
    "id": "4012",
    "name": "Edge NYC",
    "cityCode": "NEW_YORK"
  },
  "variants": [
    {
      "id": "38164",
      "name": "General Admission: Timed Entry",
      "description": "Entry to Edge Observatory Deck at the time slot selected",
      "duration": 60000,
      "inventoryType": "FIXED_START_FLEXIBLE_DURATION",
      "pax": {
        "min": 1,
        "max": 10
      },
      "cashback": {
        "value": 0,
        "type": "ABSOLUTE"
      },
      "ticketDeliveryInfoHtml": null,
      "inputFields": [
        {
          "id": "NAME",
          "name": "Full Name",
          "dataType": "STRING",
          "level": "PRIMARY_CUSTOMER"
        }
      ],
      "tags": [
        "RECOMMENDED"
      ],
      "pricing": {
        "currency": "USD",
        "profileType": "PER_PERSON",
        "headoutSellingPrice": 39.2,
        "commissionAmount": 3.92
      }
    }
  ],
  "inventorySelectionType": "NORMAL",
  "cancellationPolicy": {
    "cancellable": false,
    "cancellableUpToInMinutes": null
  },
  "reschedulePolicy": {
    "reschedulable": false,
    "reschedulableUpToInMinutes": null
  }
}

Authorizations

Headout-Auth

string

header

required

Path Parameters

productId

string

required

ID of the product to fetch.

Query Parameters

languageCode

enum<string>

default:EN

Language code for localizing response content including product names, descriptions, and URLs. Defaults to English (EN). Content falls back to English when a translation is unavailable. See supported language codes.

Available options:

EN,

ES,

FR,

IT,

DE,

PT,

NL,

PL,

KO,

JA,

ZH_HANS,

ZH_HANT,

AR,

DA,

false,

RO,

RU,

SV,

TR

currencyCode

string

Currency code for displaying prices (e.g., USD, EUR, GBP). All price fields in the response will use this currency. See Currency Codes.

campaignName

string

Partner-specific campaign identifier for tracking conversions and attributing bookings to marketing campaigns.

Response

200 - application/json

Successful response

Full product details including all variants, pricing, content, and media. Variants in this response include a pricing field.

string

Headout's unique product identifier. Use this to fetch full product details via the getProductById endpoint.

name

string

Display name of the experience (e.g., "Skip-the-Line Tickets to the Eiffel Tower").

canonicalUrl

string

The canonical Headout URL for this product page. Use for linking and affiliate tracking.

content

object

Editorial content for the product including highlights, summary, inclusions, and exclusions.

Show child attributes

city

object

The city where this experience takes place.

Show child attributes

media

object[]

Product images and videos for display in listings and product detail pages.

Show child attributes

startLocation

object

Coordinates and address details of the meeting/departure point for this experience.

Show child attributes

endLocation

object

Coordinates and address details of the drop-off/end point for this experience.

Show child attributes

productType

enum<string>

Experience category. Useful for filtering and display logic.

Available options:

TOUR,

ACTIVITY,

EVENT,

ATTRACTION,

TRANSFER,

AIRPORT_TRANSFER,

ADD_ON

reviewsSummary

object

Aggregated rating and review count from verified Headout customers.

Show child attributes

pricing

Affiliate Pricing · object

Canonical pricing object. Use this for all display and starting-price decisions.

At the product level, values represent the minimum bookable price across all variants and time slots — i.e. the "from" / starting price. Even a single-variant product can vary by date because time-slot and supplier inventory pricing changes; treat this as the lowest currently-known starting point, not a fixed quote. Use inventory.pricing for live, bookable totals.

Show child attributes

listingPrice

object

deprecated

Deprecated. Use pricing instead for the starting "from" price. Retained on the response for backward compatibility and will not be removed, but should not be used in new integrations.

Show child attributes

currency

object

Currency in which all prices in this response are denominated.

Show child attributes

localeSpecificUrls

object

Localized product page URLs keyed by language code (EN, ES, FR, etc.), for use in multilingual storefronts.

Show child attributes

hasInstantConfirmation

boolean

Whether bookings for this product are confirmed immediately without manual review.

hasMobileTicket

boolean

Whether this product supports mobile/digital tickets (no print required).

primaryCategory

object

The main experience category this product belongs to (e.g., Tickets, Tours).

Show child attributes

primarySubCategory

object

The subcategory within the primary category (e.g., Museums, Landmarks under Tickets).

Show child attributes

primaryCollection

object

The primary themed collection grouping this product (e.g., Empire State Building, Broadway Shows).

Show child attributes

variants

object[]

Show child attributes

inventorySelectionType

enum<string>

Inventory selection flow for this product. Determines how date/time selection should be presented to users.

Available options:

NORMAL,

SEATMAP

cancellationPolicy

object

Strictest cancellation policy applicable across all variants of this product.

Show child attributes

reschedulePolicy

object

Strictest reschedule policy applicable across all variants of this product.

Show child attributes

address

object

Primary location details for the experience, when available.

Show child attributes

pois

object[] | null

Points of interest associated with this product.

Show child attributes

cutoffTimeInMinutes

integer | null

Booking cutoff time in minutes before visit time, when applicable.

List all products

List availabilities - Normal

⌘I