curl --location 'https://www.headout.com/api/public/v2/inventories/520436588/' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "inventoryId": "520436588",
  "inputFields": [
    {
      "id": "8616",
      "type": "Phone",
      "name": "Phone",
      "description": null,
      "dataType": "STRING",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": 40,
        "minValue": null,
        "maxValue": null,
        "required": true
      },
      "level": "PRIMARY_CUSTOMER"
    },
    {
      "id": "227242",
      "type": "Custom",
      "name": "Pick-up details",
      "description": "Select your preferred pick-up point",
      "dataType": "ENUM",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": null,
        "minValue": null,
        "maxValue": null,
        "required": true,
        "values": {
          "type": "TEXT",
          "value": ["Ahern Hotel", "Airbnb (Residential Rentals)", "Alexis Park Resort"]
        }
      },
      "level": "ALL_CUSTOMER"
    },
    {
      "id": "340287",
      "type": "Custom",
      "name": "Pickup Location",
      "description": "Choose your pickup point",
      "dataType": "LOCATION",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": null,
        "minValue": null,
        "maxValue": null,
        "required": true,
        "values": {
          "type": "PREDEFINED_LOCATION",
          "value": [
            {
              "id": 480318,
              "latitude": 44.426767,
              "longitude": 26.102538,
              "address": "Bucharest, Romania",
              "displayName": "Z Executive Boutique Hotel",
              "timingConfig": {
                "startTime": null,
                "endTime": null,
                "minPeriod": null,
                "maxPeriod": null
              },
              "note": {
                "content": "",
                "language": "EN"
              }
            }
          ]
        }
      },
      "level": "PRIMARY_CUSTOMER"
    },
    {
      "id": "412051",
      "type": "Custom",
      "name": "Drop-off Address",
      "description": null,
      "dataType": "LOCATION",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": 200,
        "minValue": null,
        "maxValue": null,
        "required": false
      },
      "level": "PRIMARY_CUSTOMER"
    }
  ]
}

Inventory

Get inventory details by ID

Don’t worry! Existing integrations using input fields from the Get Product response will continue to work for booking submissions—no changes are required in the interim. This endpoint is designed to handle the small number (~5%) of inventories where suppliers define inventory-specific input fields that differ from the variant definition, removing the need for manual intervention.

Fetch the exact customer input fields required for a specific inventory before creating a booking. While the fields returned by Get Product are sufficient for most bookings, some inventories may require additional or overridden fields based on supplier configuration. Common examples include pickup location, drop-off address, nationality, passport number, meal preference, age, weight, or hotel name.

Use the returned field id (numeric string) as the key when submitting inputFields in the Create booking request.

GET

api

public

inventories

{inventoryId}

curl --location 'https://www.headout.com/api/public/v2/inventories/520436588/' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "inventoryId": "520436588",
  "inputFields": [
    {
      "id": "8616",
      "type": "Phone",
      "name": "Phone",
      "description": null,
      "dataType": "STRING",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": 40,
        "minValue": null,
        "maxValue": null,
        "required": true
      },
      "level": "PRIMARY_CUSTOMER"
    },
    {
      "id": "227242",
      "type": "Custom",
      "name": "Pick-up details",
      "description": "Select your preferred pick-up point",
      "dataType": "ENUM",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": null,
        "minValue": null,
        "maxValue": null,
        "required": true,
        "values": {
          "type": "TEXT",
          "value": ["Ahern Hotel", "Airbnb (Residential Rentals)", "Alexis Park Resort"]
        }
      },
      "level": "ALL_CUSTOMER"
    },
    {
      "id": "340287",
      "type": "Custom",
      "name": "Pickup Location",
      "description": "Choose your pickup point",
      "dataType": "LOCATION",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": null,
        "minValue": null,
        "maxValue": null,
        "required": true,
        "values": {
          "type": "PREDEFINED_LOCATION",
          "value": [
            {
              "id": 480318,
              "latitude": 44.426767,
              "longitude": 26.102538,
              "address": "Bucharest, Romania",
              "displayName": "Z Executive Boutique Hotel",
              "timingConfig": {
                "startTime": null,
                "endTime": null,
                "minPeriod": null,
                "maxPeriod": null
              },
              "note": {
                "content": "",
                "language": "EN"
              }
            }
          ]
        }
      },
      "level": "PRIMARY_CUSTOMER"
    },
    {
      "id": "412051",
      "type": "Custom",
      "name": "Drop-off Address",
      "description": null,
      "dataType": "LOCATION",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": 200,
        "minValue": null,
        "maxValue": null,
        "required": false
      },
      "level": "PRIMARY_CUSTOMER"
    }
  ]
}

curl --location 'https://www.headout.com/api/public/v2/inventories/520436588/' \
--header 'Headout-Auth: <YOUR_API_KEY>'

{
  "inventoryId": "520436588",
  "inputFields": [
    {
      "id": "8616",
      "type": "Phone",
      "name": "Phone",
      "description": null,
      "dataType": "STRING",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": 40,
        "minValue": null,
        "maxValue": null,
        "required": true
      },
      "level": "PRIMARY_CUSTOMER"
    },
    {
      "id": "227242",
      "type": "Custom",
      "name": "Pick-up details",
      "description": "Select your preferred pick-up point",
      "dataType": "ENUM",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": null,
        "minValue": null,
        "maxValue": null,
        "required": true,
        "values": {
          "type": "TEXT",
          "value": ["Ahern Hotel", "Airbnb (Residential Rentals)", "Alexis Park Resort"]
        }
      },
      "level": "ALL_CUSTOMER"
    },
    {
      "id": "340287",
      "type": "Custom",
      "name": "Pickup Location",
      "description": "Choose your pickup point",
      "dataType": "LOCATION",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": null,
        "minValue": null,
        "maxValue": null,
        "required": true,
        "values": {
          "type": "PREDEFINED_LOCATION",
          "value": [
            {
              "id": 480318,
              "latitude": 44.426767,
              "longitude": 26.102538,
              "address": "Bucharest, Romania",
              "displayName": "Z Executive Boutique Hotel",
              "timingConfig": {
                "startTime": null,
                "endTime": null,
                "minPeriod": null,
                "maxPeriod": null
              },
              "note": {
                "content": "",
                "language": "EN"
              }
            }
          ]
        }
      },
      "level": "PRIMARY_CUSTOMER"
    },
    {
      "id": "412051",
      "type": "Custom",
      "name": "Drop-off Address",
      "description": null,
      "dataType": "LOCATION",
      "validation": {
        "regex": null,
        "minLength": null,
        "maxLength": 200,
        "minValue": null,
        "maxValue": null,
        "required": false
      },
      "level": "PRIMARY_CUSTOMER"
    }
  ]
}

Authorizations

Headout-Auth

string

header

required

Path Parameters

inventoryId

integer<int64>

required

The inventory ID to fetch booking fields for. Obtain this from the id field in the inventory listing response.

Query Parameters

languageCode

string

default:EN

Language code for field names and predefined option labels (e.g., EN, ES). Defaults to EN.

Response

Successful response

Booking fields required for a specific inventory.

inventoryId

string

The inventory ID as a string.

inputFields

object[]

Fields to collect from customers before creating a booking for this inventory. Use the field id (numeric string) as the key when submitting in the booking request.

Show child attributes

List inventory - Seatmap

Validate - Seatmap

⌘I

Guide

Cities

Collections

Categories

Subcategories

Products

Availabilities

Inventory

Inventory Validate

Venue

Bookings

Manage webhook configuration

Webhooks

Get inventory details by ID

Authorizations

Path Parameters

Query Parameters

Response