> ## Documentation Index > Fetch the complete documentation index at: https://partner.headout.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # List all products Retrieve bookable experiences (tickets, tours, activities) for a specific city. Filter results by collection, category, or subcategory to narrow down products. Each product includes pricing, images, reviews, availability info, and cancellation policies. Use `primaryCategoryOnly=true` together with `categoryId` to restrict results to products whose **primary** category matches — excluding products where that category is only a secondary association. ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}} curl --location 'https://www.headout.com/api/public/v2/products/?cityCode=&collectionId=&campaignName=&languageCode=¤cyCode=&limit=&offset=' \ --header 'Headout-Auth: ' ``` ```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}} { "products": [ { "id": "19513", "name": "Edge Observation Deck Tickets", "canonicalUrl": "https://www.headout.com/edge-observation-deck-tickets/tickets-to-edge-observation-deck-e-19513/", "content": { "highlights": "• Gaze down from the outdoor sky deck on the 100th floor\n• Step onto the glass floor and see the city beneath your feet", "highlightsHtml": "", "shortSummary": "Visit the highest outdoor sky deck in the Western Hemisphere at Hudson Yards.", "summaryHtml": "

Visit the highest outdoor sky deck in the Western Hemisphere at Hudson Yards.

", "inclusions": "• Access to the 100th-floor outdoor sky deck\n• Access to the 101st-floor indoor viewing area", "inclusionsHtml": "", "exclusions": "• Food and beverages\n• Guided tour", "exclusionsHtml": "", "faqHtml": "

What are the opening hours?

Edge is open daily from 10 AM to 10 PM.

", "ticketDeliveryInfoHtml": "

You will receive your mobile tickets via email upon confirmation.

" }, "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.75412368774414, "longitude": -74.0009765625, "address": "30 Hudson Yards", "city": "New York", "postalCode": "10001", "country": "United States" }, "endLocation": { "latitude": 40.75412368774414, "longitude": -74.0009765625, "address": "30 Hudson Yards", "city": "New York", "postalCode": "10001", "country": "United States" }, "productType": "ATTRACTION", "reviewsSummary": { "ratingsCount": 2763, "averageRating": 4.03 }, "pricing": { "currency": "USD", "profileType": "PER_PERSON", "headoutSellingPrice": 41.0, "netPrice": 33.62 }, "listingPrice": { "type": "PER_PERSON", "currencyCode": "USD", "minimumPrice": { "originalPrice": 41.0, "finalPrice": 41.0 }, "bestDiscount": 0 }, "currency": { "code": "USD", "currencyName": "United States Dollar", "symbol": "US$", "localSymbol": "$", "precision": 2 }, "localeSpecificUrls": { "EN": "https://www.headout.com/edge-observation-deck-tickets/tickets-to-edge-observation-deck-e-19513/", "ES": "https://www.headout.com/es/edge-observation-deck-tickets/tickets-to-edge-observation-deck-e-19513/", "FR": "https://www.headout.com/fr/edge-observation-deck-tickets/tickets-to-edge-observation-deck-e-19513/" }, "hasInstantConfirmation": true, "hasMobileTicket": true, "primaryCategory": { "id": "1", "name": "Tickets" }, "secondaryCategories": [], "primarySubCategory": { "id": "1007", "name": "Landmarks", "categoryId": "1" }, "primaryCollection": { "id": "4012", "name": "Edge NYC", "cityCode": "NEW_YORK" }, "variants": [ { "id": "35412", "name": "General Admission", "description": "Access to the 100th-floor outdoor sky deck and 101st-floor indoor viewing area.", "duration": 3600000, "inventoryType": "FIXED_START_FLEXIBLE_DURATION", "pax": { "min": 1, "max": 10 }, "cashback": { "value": 5.0, "type": "PERCENTAGE" }, "ticketDeliveryInfoHtml": "

Mobile ticket delivered via email.

", "inputFields": [ { "oldId": 1, "id": "NAME", "name": "Full Name", "dataType": "STRING", "validation": { "regex": "^[a-zA-Z ]+$", "minLength": 1, "maxLength": 100, "minValue": null, "maxValue": null, "required": true }, "level": "PRIMARY_CUSTOMER" }, { "oldId": 2, "id": "EMAIL", "name": "Email Address", "dataType": "STRING", "validation": { "regex": "^[\\w.+-]+@[\\w-]+\\.[\\w.]+$", "minLength": 5, "maxLength": 150, "minValue": null, "maxValue": null, "required": true }, "level": "PRIMARY_CUSTOMER" } ], "tags": [ "EDGE" ] } ], "inventorySelectionType": "NORMAL", "cancellationPolicy": { "cancellable": false, "cancellableUpToInMinutes": null }, "reschedulePolicy": { "reschedulable": false, "reschedulableUpToInMinutes": null } } ], "nextUrl": "/api/public/v2/products?cityCode=NEW_YORK&offset=1&limit=1", "prevUrl": null, "total": 69, "nextOffset": 1 } ``` ## OpenAPI ````yaml specs/openapi-v2-api-partner.yaml GET /api/public/v2/products/ openapi: 3.1.0 info: title: Headout API Docs - API Partner v2 version: 0.0.1 servers: - url: https://www.headout.com description: Production server - url: https://www.sandbox-headout.com description: Sandbox server security: [] paths: /api/public/v2/products/: get: tags: - Products summary: List all products operationId: v2ListProducts parameters: - $ref: '#/components/parameters/cityCode' - $ref: '#/components/parameters/collectionId' - $ref: '#/components/parameters/categoryId' - $ref: '#/components/parameters/subCategoryId' - $ref: '#/components/parameters/languageCode' - $ref: '#/components/parameters/currencyCode' - $ref: '#/components/parameters/campaignName' - name: offset in: query schema: type: integer default: 0 description: Number of products to skip for pagination. - name: limit in: query schema: type: integer default: 20 description: Maximum number of products to return per page. - name: primaryCategoryOnly in: query schema: type: boolean default: false description: >- When `true` and `categoryId` is provided, restricts results to products whose **primary** category matches the requested `categoryId`. By default (`false`), results include products linked to any subcategory under that category, even if it is only a secondary category. Has no effect when `categoryId` is not provided. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/V2Products' security: - apiKeyAuth: [] components: parameters: cityCode: name: cityCode in: query required: true schema: type: string description: >- Uppercase city identifier (e.g., `NEW_YORK`, `DUBAI`, `LONDON`). Use the [Cities API](/api-partner/v2/cities) to retrieve all available city codes. collectionId: name: collectionId in: query schema: type: string description: >- Filter products by a specific themed collection (e.g., Broadway Shows, Theme Parks). Obtain collection IDs from the [Collections API](/api-partner/v2/collections). categoryId: name: categoryId in: query schema: type: string description: >- Filter products by a top-level experience type (e.g., Tickets, Tours, Transportation). Obtain category IDs from the [Categories API](/api-partner/v2/categories). subCategoryId: name: subCategoryId in: query schema: type: string description: >- Filter products by a specific subcategory within a category (e.g., Museums, Landmarks). Obtain subcategory IDs from the [Subcategories API](/api-partner/v2/subcategories). languageCode: name: languageCode in: query schema: type: string default: EN enum: - EN - ES - FR - IT - DE - PT - NL - PL - KO - JA - ZH_HANS - ZH_HANT - AR - DA - false - RO - RU - SV - TR description: >- 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](/guide/enums-and-error-codes#language-codes). currencyCode: name: currencyCode in: query schema: type: string description: >- Currency code for displaying prices (e.g., `USD`, `EUR`, `GBP`). All price fields in the response will use this currency. See [Currency Codes](/guide/enums-and-error-codes#currency-codes). campaignName: name: campaignName in: query schema: type: string description: >- Partner-specific campaign identifier for tracking conversions and attributing bookings to marketing campaigns. schemas: V2Products: type: object properties: products: type: array items: $ref: '#/components/schemas/Product' description: The products in this page of results. nextUrl: type: - string - 'null' description: >- Full URL to fetch the next page of results. Null if on the last page. prevUrl: type: - string - 'null' description: >- Full URL to fetch the previous page of results. Null if on the first page. total: type: integer description: Total number of products matching the query across all pages. nextOffset: type: - integer - 'null' description: >- Offset value to use in the next request to retrieve the following page. Product: type: object properties: id: type: string description: >- Headout's unique product identifier. Use this to fetch full product details via the `getProductById` endpoint. name: type: string description: >- Display name of the experience (e.g., "Skip-the-Line Tickets to the Eiffel Tower"). canonicalUrl: type: string description: >- The canonical Headout URL for this product page. Use for linking and affiliate tracking. content: $ref: '#/components/schemas/ProductContent' description: >- Editorial content for the product including highlights, summary, inclusions, and exclusions. city: $ref: '#/components/schemas/City' description: The city where this experience takes place. media: type: array items: $ref: '#/components/schemas/MediaDetails' description: >- Product images and videos for display in listings and product detail pages. startLocation: $ref: '#/components/schemas/LocationDetails' description: >- Coordinates and address details of the meeting/departure point for this experience. endLocation: $ref: '#/components/schemas/LocationDetails' description: >- Coordinates and address details of the drop-off/end point for this experience. productType: type: string enum: - TOUR - ACTIVITY - EVENT - ATTRACTION - TRANSFER - AIRPORT_TRANSFER - ADD_ON description: Experience category. Useful for filtering and display logic. reviewsSummary: $ref: '#/components/schemas/ReviewDetails' description: Aggregated rating and review count from verified Headout customers. pricing: $ref: '#/components/schemas/ProductPricing' description: > 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. listingPrice: $ref: '#/components/schemas/ListingPrice' deprecated: true description: > 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. currency: $ref: '#/components/schemas/Currency' description: Currency in which all prices in this response are denominated. localeSpecificUrls: type: object additionalProperties: type: string description: >- Localized product page URLs keyed by language code (`EN`, `ES`, `FR`, etc.), for use in multilingual storefronts. hasInstantConfirmation: type: boolean description: >- Whether bookings for this product are confirmed immediately without manual review. hasMobileTicket: type: boolean description: >- Whether this product supports mobile/digital tickets (no print required). primaryCategory: type: object description: >- The main experience category this product belongs to (e.g., Tickets, Tours). properties: id: type: string description: Headout's identifier for this category. name: type: string description: Display name of the category. canonicalUrl: type: string description: >- The canonical Headout URL for this category page, suitable for linking and SEO. localeSpecificUrls: type: object additionalProperties: type: string description: Localized URLs for this category page, keyed by language code. secondaryCategories: type: array items: type: object properties: id: type: string description: Headout's identifier for this category. name: type: string description: Display name of the category. canonicalUrl: type: string description: The canonical Headout URL for this category page. localeSpecificUrls: type: object additionalProperties: type: string description: Localized URLs for this category page, keyed by language code. description: >- Additional categories this product belongs to beyond its primary category. Empty when the product belongs to only one category. primarySubCategory: $ref: '#/components/schemas/V2SubCategory' description: >- The subcategory within the primary category (e.g., Museums, Landmarks under Tickets). primaryCollection: $ref: '#/components/schemas/V2Collection' description: >- The primary themed collection grouping this product (e.g., Empire State Building, Broadway Shows). variants: type: array items: type: object description: >- A bookable option within the product (e.g., different seating tiers, admission levels, or time slots). properties: id: oneOf: - type: string - type: integer description: >- Variant identifier. Use as `variantId` when fetching inventory or creating a booking. name: type: - string - 'null' description: >- Display name of this variant option (e.g., "Rear Orchestra", "Standard Admission"). Null or empty when the product has only one variant — in that case the variant carries no special distinguishing label. description: type: - string - 'null' description: >- Additional details about what distinguishes this variant from others. duration: type: - number - 'null' format: double description: >- Duration of the experience in milliseconds. Null for `FIXED_START_FLEXIBLE_DURATION` and `FLEXIBLE_START_FLEXIBLE_DURATION` inventory types, where the duration is open-ended. inventoryType: type: string enum: - FIXED_START_FIXED_DURATION - FIXED_START_FLEXIBLE_DURATION - FLEXIBLE_START_FIXED_DURATION - FLEXIBLE_START_FLEXIBLE_DURATION description: >- How inventory slots are structured for this variant. Affects how `startDateTime` and `endDateTime` should be interpreted. See [Inventory Types](/guide/enums-and-error-codes#inventory-types). - `FIXED_START_FIXED_DURATION`: Fixed entry time and fixed duration (e.g., a Broadway show at 7 PM). - `FIXED_START_FLEXIBLE_DURATION`: Fixed entry time, customer stays as long as they wish (e.g., a timed-entry observation deck). - `FLEXIBLE_START_FIXED_DURATION`: Open-window entry, fixed duration once started (e.g., a 1-hour balloon ride during a morning window). - `FLEXIBLE_START_FLEXIBLE_DURATION`: Open entry, open-ended duration (e.g., a theme park day pass). pax: type: object description: Allowed booking party size for this variant. properties: min: type: integer description: >- Minimum number of people required per booking. 0 means no minimum. max: type: - integer - 'null' description: >- Maximum number of people allowed per booking. Null means no upper limit. cashback: type: object description: Cashback incentive offered on bookings of this variant. properties: value: type: number format: double description: >- Cashback amount or percentage, depending on the type field. type: type: string enum: - PERCENTAGE - ABSOLUTE description: How the cashback is calculated. ticketDeliveryInfoHtml: type: - string - 'null' description: >- HTML-formatted instructions on how tickets will be delivered (e.g., email, mobile app, on-site collection). cancellationPolicy: type: object description: Cancellation policy specific to this variant. properties: cancellable: type: boolean description: Whether this variant can be cancelled after booking. cancellableUpTo: type: - integer - 'null' description: >- How far in advance, in minutes, the booking can be cancelled. meetingPointInfo: type: - object - 'null' description: Meeting point information for this variant. properties: latitude: type: - string - 'null' description: Latitude coordinate as returned by the API. longitude: type: - string - 'null' description: Longitude coordinate as returned by the API. address: type: - string - 'null' description: Human-readable meeting point address. properties: type: object additionalProperties: type: string description: Additional variant properties keyed by arbitrary strings. propertiesV2: type: object additionalProperties: type: array items: type: string description: >- Additional variant properties in the newer format, keyed by arbitrary strings with string arrays as values. inputFields: type: array items: $ref: '#/components/schemas/VariantInputField' description: >- A field that must be collected from the customer when creating a booking for this variant. tags: type: array items: type: string description: >- Internal classification tags for this variant (e.g., `BROADWAY`, `BTTFA`). Used for eligibility programs and internal routing. inventorySelectionType: type: string enum: - NORMAL - SEATMAP description: >- Inventory selection flow for this product. Determines how date/time selection should be presented to users. cancellationPolicy: type: object description: >- Strictest cancellation policy applicable across all variants of this product. properties: cancellable: type: boolean description: Whether this product can be cancelled after booking. cancellableUpToInMinutes: type: - integer - 'null' description: > Cancellation cutoff in minutes before the experience start time. Cancellation requests submitted after this cutoff are not accepted. Null if the product is not cancellable. This field defines cancellation eligibility only. Refund handling is a separate concern — see [Cancellation & reschedule policies](/guide/key-concepts#cancellation-%26-reschedule-policies). reschedulePolicy: type: object description: >- Strictest reschedule policy applicable across all variants of this product. properties: reschedulable: type: boolean description: Whether this product can be rescheduled after booking. reschedulableUpToInMinutes: type: - integer - 'null' description: >- How far in advance (in minutes before start time) the booking can be rescheduled. Null if the product is not reschedulable. ProductContent: type: object properties: highlights: type: string description: >- Key selling points and notable features of the experience, typically displayed as a bullet list. highlightsHtml: type: - string - 'null' description: HTML-formatted version of `highlights`. Use for rich text rendering. shortSummary: type: string description: >- Brief overview of the experience, suitable for product cards and listing previews. summaryHtml: type: - string - 'null' description: >- HTML-formatted version of `shortSummary`. Use for rich text rendering. inclusions: type: string description: >- What is included in the price (e.g., "Skip-the-line access", "Guided tour", "Hotel pickup"). inclusionsHtml: type: - string - 'null' description: HTML-formatted version of `inclusions`. Use for rich text rendering. exclusions: type: string description: >- What is not included (e.g., "Gratuities", "Food and drinks", "Hotel transfers"). exclusionsHtml: type: - string - 'null' description: HTML-formatted version of `exclusions`. Use for rich text rendering. faqHtml: type: - string - 'null' description: >- HTML-formatted FAQ content for the experience. Null if no FAQ is available. ticketDeliveryInfoHtml: type: - string - 'null' description: >- HTML-formatted instructions on how tickets will be delivered (e.g., email, mobile app, on-site collection). City: type: object properties: code: type: string description: >- City code (e.g., `NEW_YORK`, `DUBAI`, `LONDON`). Use this as the `cityCode` parameter in other endpoints. See [Cities API](/api-partner/v2/cities). name: type: string description: Display name of the city. image: $ref: '#/components/schemas/Image' description: City image suitable for navigation or city selection UI. MediaDetails: type: object properties: url: type: string description: >- CDN URL for this media asset. Supports imgix query parameters for on-the-fly resizing and format conversion. type: type: string enum: - IMAGE - VIDEO - PDF description: Media asset type. LocationDetails: allOf: - $ref: '#/components/schemas/Geolocation' - type: object properties: address: type: - string - 'null' description: Street-level address of the location (e.g., "1 West 34th St"). city: type: - string - 'null' description: City name where this location resides. postalCode: type: - string - 'null' description: Postal or ZIP code of the location. country: type: - string - 'null' description: Country name where this location resides. ReviewDetails: type: object properties: ratingsCount: type: integer description: >- Total number of verified customer ratings submitted for this product. averageRating: type: number format: double description: >- Mean customer rating on a scale of 1-5, based on verified post-experience reviews. ProductPricing: allOf: - $ref: '#/components/schemas/ProductPricingApiPartner' description: >- Pricing information for API Partner accounts. Currency defaults to USD if `currencyCode` is not provided in the request query parameter. ListingPrice: type: object deprecated: true description: > Deprecated. Use `pricing` (product-level for the starting "from" price, variant-level for variant-specific values). Retained for backward compatibility. properties: type: type: string enum: - PER_PERSON - PER_GROUP description: >- Pricing model for this product. See [Listing Price Types](/guide/enums-and-error-codes#listing-price-types). - `PER_PERSON`: price per individual — inventory returns person types (Adult, Child, etc.) each with their own price. - `PER_GROUP`: single price for a group — inventory returns pricing tiers by group size. currencyCode: type: string description: >- Currency code for all price values in this object. See [Currency Codes](/guide/enums-and-error-codes#currency-codes). minimumPrice: $ref: '#/components/schemas/Price' description: >- Lowest available price across all variants and person types. Deprecated — use `pricing` for the starting "from" price. bestDiscount: type: number format: double description: >- Highest discount percentage available across all variants, for displaying promotional badges. Currency: type: object properties: code: type: string description: >- Currency code (e.g., `USD`, `EUR`, `AED`). See [Currency Codes](/guide/enums-and-error-codes#currency-codes). currency: type: string description: >- Currency code repeated in the payload for backward compatibility with the partner model. currencyName: type: string description: Full name of the currency (e.g., "United States Dollar", "Euro"). symbol: type: string description: International currency symbol (e.g., "US$", "EUR"). localSymbol: type: string description: >- Locally preferred symbol for this currency (e.g., "$" for USD in the US). precision: type: integer description: >- Number of decimal places used for this currency (e.g., 2 for USD, 0 for JPY). V2SubCategory: type: object properties: id: type: string description: >- Headout's identifier for this subcategory. Use as the `subCategoryId` filter in the [Products API](/api-partner/v2/products). name: type: string description: >- Display name of the subcategory (e.g., "Museums", "Landmarks", "Religious Sites"). categoryId: type: string description: Identifier of the parent category this subcategory belongs to. canonicalUrl: type: string description: >- The canonical Headout URL for this subcategory page, suitable for linking and SEO. localeSpecificUrls: type: object additionalProperties: type: string description: >- Localized subcategory page URLs keyed by language code (`EN`, `ES`, `FR`, etc.). V2Collection: type: object properties: id: type: string description: >- Headout's identifier for this collection. Use as the `collectionId` filter in the [Products API](/api-partner/v2/products). name: type: string description: >- Display name of the collection (e.g., "Broadway Shows", "Statue of Liberty"). cityCode: type: string description: The city this collection belongs to (e.g., `NEW_YORK`, `LONDON`). content: type: - object - 'null' description: Editorial content for this collection. properties: description: type: - string - 'null' description: Long-form description of the collection. subtext: type: - string - 'null' description: Short subtext or tagline for the collection. localeSpecificUrls: type: object additionalProperties: type: string description: >- Localized collection page URLs keyed by language code (`EN`, `ES`, `FR`, etc.). canonicalUrl: type: string description: >- The canonical Headout URL for this collection page, suitable for linking and SEO. heroImage: type: - object - 'null' description: Hero/banner image for the collection. properties: url: type: string description: CDN URL for the image. type: type: string description: Media type (e.g., `IMAGE`). cardImage: type: - object - 'null' description: Card/thumbnail image for the collection. properties: url: type: string description: CDN URL for the image. type: type: string description: Media type (e.g., `IMAGE`). VariantInputField: type: object description: >- A field that must be collected from the customer when creating a booking for this variant. properties: oldId: type: integer description: Legacy numeric field identifier for backwards compatibility. id: type: string description: >- Field identifier used in the booking request (e.g., `NAME`, `EMAIL`, `PHONE`, or `CUSTOM_*`). name: type: string description: Human-readable label to display to the customer for this field. description: type: string description: Optional helper text or instructions shown for this field. dataType: type: string enum: - STRING - ENUM - BOOL - INT - FLOAT - LOCATION description: >- Expected data type for this field's value. See [Input Field Data Types](/guide/enums-and-error-codes#input-field-data-types). - `STRING`: free-form text — apply `regex`, `minLength`, `maxLength` from `validation`. - `ENUM`: one of the values in `validation.values` — value must be an exact match. - `BOOL`: boolean — submit as the string `"true"` or `"false"`. - `INT`: whole number — apply `minValue`, `maxValue` from `validation`. - `FLOAT`: decimal number — apply `minValue`, `maxValue` from `validation`. - `LOCATION`: pickup/drop-off location. If `validation.values` is non-empty, items are **predefined location objects** (see `PredefinedLocation` schema) — render as a dropdown and submit either the selected `id` or its `displayName`. If `validation.values` is null, accept a free-form address string. Note: there is no dedicated `DATE` dataType. Date and date-time fields (e.g. `DATE_OF_BIRTH_*`) are submitted as `STRING`, with the expected format enforced by `validation.regex` on the field. validation: $ref: '#/components/schemas/FieldValidation' description: >- Constraints that must be satisfied when submitting a value for this field. level: type: string enum: - PRIMARY_CUSTOMER - ALL_CUSTOMER - BOOKING description: > Who this field should be collected from. See [Input Field Level](/guide/enums-and-error-codes#input-field-level). - `PRIMARY_CUSTOMER`: collect once from the lead guest only (e.g., name, email, phone). Submit inside the `isPrimary: true` customer's `inputFields`. - `ALL_CUSTOMER`: collect from every guest in the booking (e.g., weight, height, meal preference). Submit inside every customer's `inputFields`. - `BOOKING`: collect once for the whole booking, not per customer (e.g., language preference, group name on the reservation, special accessibility request). Submit in the booking-level `variantInputFields` array — **not** inside any customer object. `level` and `dataType` are independent — a `BOOKING`-level field can be any dataType, and a `LOCATION` dataType field can be at any level. Image: type: object properties: url: type: string description: >- Protocol-relative CDN URL for the image (e.g. `//cdn-imgix.headout.com/...`) — prepend a scheme (`https:`) before use. Can be used with imgix parameters for resizing and format conversion. Geolocation: type: object properties: latitude: type: number format: double description: Latitude coordinate of the location in decimal degrees. longitude: type: number format: double description: Longitude coordinate of the location in decimal degrees. ProductPricingApiPartner: title: API Partner Pricing allOf: - $ref: '#/components/schemas/ProductPricingBase' - type: object properties: netPrice: type: number format: double description: Minimum partner net price. Price: type: object properties: originalPrice: type: number format: double description: >- Full undiscounted price. Suitable for displaying as a strikethrough price alongside the final price. finalPrice: type: number format: double description: >- Actual price after applying any discounts or promotions. This is the amount charged to the customer. FieldValidation: type: object properties: regex: type: - string - 'null' description: >- Regular expression pattern the submitted value must match. Null when not applicable (e.g., for non-string fields). Validate on the client before submission to avoid booking errors. minLength: type: - integer - 'null' description: >- Minimum number of characters required. Null when not applicable (e.g., for `INT`, `FLOAT`, `BOOL` fields). maxLength: type: - integer - 'null' description: >- Maximum number of characters allowed. Null when not applicable (e.g., for `INT`, `FLOAT`, `BOOL` fields). minValue: type: - number - 'null' format: double description: >- Minimum numeric value allowed. Null when not applicable (e.g., for `STRING`, `BOOL` fields). maxValue: type: - number - 'null' format: double description: >- Maximum numeric value allowed. Null when not applicable (e.g., for `STRING`, `BOOL` fields). required: type: boolean description: >- Whether this field must be provided in the booking request. If true, omitting it will cause the booking to fail. values: description: >- Predefined allowed values for this field. The shape of items depends on `inputFields.dataType`: - **`ENUM`**: `string[]` — the submitted value must exactly match one of these strings. - **`LOCATION`** (predefined): array of location objects — render as a dropdown and submit either the selected `id` or its `displayName` as the field value. See `PredefinedLocation` schema. - **All other types**: `null`. oneOf: - title: Enum Values type: array items: type: string description: String enum values (for `ENUM` dataType fields). - title: Predefined Locations type: array items: $ref: '#/components/schemas/PredefinedLocation' description: >- Predefined pickup/drop-off locations (for `LOCATION` dataType fields with predefined options). - type: 'null' ProductPricingBase: type: object properties: currency: type: string description: >- Currency code (e.g., USD, EUR). Defaults to USD if `currencyCode` is not provided in the request. See [Currency Codes](/guide/enums-and-error-codes#currency-codes). profileType: type: string enum: - PER_PERSON - PER_GROUP description: >- Pricing model for this product. See [Listing Price Types](/guide/enums-and-error-codes#listing-price-types). - `PER_PERSON`: price per individual — inventory returns person types (Adult, Child, etc.) each with their own price. - `PER_GROUP`: single price for a group — inventory returns pricing tiers by group size. headoutSellingPrice: type: number format: double description: Minimum Headout selling price. PredefinedLocation: type: object description: >- A predefined pickup or drop-off location for a `LOCATION` dataType input field. When `validation.values` contains objects of this type, render them as a dropdown. Submit either the selected location's `id` or its `displayName` as the input field value when creating a booking. properties: id: type: integer description: >- Unique identifier for this location. Submit this value or the location's `displayName` as the input field value when creating a booking. latitude: type: number format: double description: Latitude of the pickup/drop-off point in decimal degrees. longitude: type: number format: double description: Longitude of the pickup/drop-off point in decimal degrees. address: type: string description: >- Full street address of the location (e.g., "3600 S Las Vegas Blvd, Las Vegas, NV 89109, USA"). displayName: type: string description: >- Short human-readable label for display in a dropdown or list (e.g., "Bellagio"). timingConfig: $ref: '#/components/schemas/LocationTimingConfig' description: Optional pickup timing constraints for this location. note: type: - object - 'null' description: >- Additional instructions for this pickup location. Null if no note exists. properties: content: type: - string - 'null' description: >- The note text (e.g., "Meet at the main entrance, not the side entrance."). language: type: string description: Language code for the note content (e.g., `EN`, `ES`). LocationTimingConfig: type: object description: >- Pickup timing constraints for a predefined location. All fields are nullable — null means no restriction applies. properties: startTime: type: - string - 'null' description: >- Earliest allowed pickup time in HH:mm format (e.g., `10:30`). Null if no earliest restriction. endTime: type: - string - 'null' description: >- Latest allowed pickup time in HH:mm format (e.g., `11:00`). Null if no latest restriction. minPeriod: type: - integer - 'null' description: >- Minimum advance notice required for this pickup, in minutes. Null if no minimum notice. maxPeriod: type: - integer - 'null' description: >- Maximum advance booking window for this pickup, in minutes. Null if no maximum window. securitySchemes: apiKeyAuth: type: apiKey in: header name: Headout-Auth ````