Skip to content
Changelog

Report a bug

Headout integration: operations for AI agents

Headout connects to Type.com as an integration. This page lists the 30 operations documented for Claude and Codex in Type.com: 20 read, 5 write, 5 destructive.

About Headout

Headout is a travel experiences and activities booking platform offering tours, attractions, and entertainment bookings worldwide.

Categories: Communication & Meetings

How to connect Headout to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

30 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

30 operations listed.

Booking

  • Read

    Fetch all bookings

    GET /booking Retrieve a list of all Bookings.

    GET /api/public/v1/booking

  • Read

    Fetch a booking by ID

    GET /booking/{id} Retrieve details of a specific Booking by its ID. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |------|-----|--------|----------|-----------------| | PATH | id | string | no | The booking id. | Response

    GET /api/public/v1/booking/{id}

  • Read

    List all bookings (v2)

    Overview Returns a paginated list of bookings for the authenticated partner account. Request API Parameters | Parameter | Required / Optional | Description | Default Value | |-----------|---------------------|----------------------------------------------------------|---------------| | offset | Optional | Number of bookings to skip. Start at 0 for the first page. | 0 | | limit | Optional | Number of bookings per page. Maximum value is 20. | 20 | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response Response Fields | Field | Type | Description | |--------------|-----------------|----------------------------------------------------------------------| | items | Array of Object | Bookings for the current page. | | nextUrl | String / null | URL to fetch the next page. null if this is the last page. | | prevUrl | String / null | URL to fetch the previous page. null if this is the first page. | | total | Integer | Total number of bookings across all pages. | | nextOffset | Integer / null | Offset value for the next request. null if this is the last page. | Error Responses | Status | Condition | |--------|--------------------------------------| | 400 | offset is negative | | 400 | limit is zero or negative | Notes - Maximum page size is 20. Any limit value above 20 is capped to 20. - Use offset and limit to paginate through results.

    GET /api/public/v2/bookings/

  • Read

    Get a booking by ID (v2)

    Overview Retrieve details of a specific booking by its ID. The booking must belong to the authenticated partner account. Request Path Parameters | Parameter | Required / Optional | Description | |-------------|---------------------|-------------------| | bookingId | Required | The booking ID. | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response Error Responses | Status | Condition | |--------|--------------------------------------------------------| | 400 | bookingId is not a valid numeric ID | | 403 | Booking does not belong to the authenticated partner |

    GET /api/public/v2/bookings/{bookingId}/

  • Write

    Create a new booking

    POST /booking Create a new booking object in UNCAPTURED state. The booking creation and acceptance flow is a 2 step flow. Calling this API creates the initial booking in UNCAPTURED state and returns back the same booking along with the new booking id. You should call this API before fulfilling the booking flow on your end. Once you get a response, you can then fulfill the booking flow on your end and then call PUT /booking to capture the booking and start the fulfillment process of the booking on our end. If the booking capturing doesn't happen within an hour then the booking status is automatically changed to CAPTURE_TIMEOUT. Request Response Notes - All bookings start in UNCAPTURED status and must be captured within 1 hour via PUT /booking/{id} - The price.amount and price.currencyCode in the response may differ from the request if currency conversion occurs - tickets array is typically empty/null for new bookings and populated after fulfillment - voucherUrl provides immediate access to booking information even before tickets are generated - seatInfo is only populated for seatmap-enabled bookings - bookingId represents the itinerary identifier in the system - variantId represents the variant (tour) identifier that was booked

    POST /api/public/v1/booking

  • Write

    Create a new booking (v2)

    Overview Create a new booking in UNCAPTURED state. Booking creation follows a 2-step flow: 1. Call this endpoint to create the booking — it returns the booking in UNCAPTURED state with a new bookingId. 2. Call PUT /bookings/{bookingId}/ to capture the booking by setting the status to PENDING and assigning a partnerReferenceId. This starts fulfillment on the Headout side. If the booking is not captured within 1 hour, the status automatically changes to CAPTURE_TIMEOUT. Request API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Request Body | Field | Type | Required / Optional | Description | |---------------------|---------|---------------------|--------------------------------------------------------------| | productId | String | Required | ID of the product. | | variantId | String | Required | ID of the variant to book. | | inventoryId | String | Required | ID of the inventory slot to book. | | inventorySeatIds | Array | Optional | List of seat IDs for seatmap-enabled products. | | customersDetails | Object | Required | Customer information (see below). | | variantInputFields| Array | Optional | Additional input fields specific to the variant. | | price | Object | Required | Expected price for the booking. | Response Notes - All bookings start in UNCAPTURED status and must be captured within 1 hour via PUT /bookings/{bookingId}/. - The price in the response may differ from the request if currency conversion occurs. - tickets array is empty for new bookings and populated after fulfillment. - seatInfo is only populated for seatmap-enabled bookings. - variantInputFields is only populated when the variant requires additional input fields.

    POST /api/public/v2/bookings/

  • Write

    Reschedule a booking

    Submit a reschedule request for a bookingId owned by your partner account. This validates input and ownership, creates a request log with status SUBMITTED, and enqueues an asynchronous job for downstream processing. The immediate response acknowledges submission and does not represent the final booking outcome. Base path: /api/public/v2/bookings

    POST /api/public/v2/bookings/{bookingId}/reschedule/

  • Write

    Reschedule a booking (Deprecated) (deprecated)

    > ⚠️ Deprecated — This endpoint will be removed in a future release. > Use POST /api/public/v2/bookings/{bookingId}/reschedule/ instead. Submit a reschedule request for a bookingId owned by your partner account. This validates input and ownership, creates a request log with status SUBMITTED, and enqueues an asynchronous job for downstream processing. The immediate response acknowledges submission and does not represent the final booking outcome. Base path: /api/public/v2/partner/booking

    POST /api/public/v2/partner/booking/{bookingId}/reschedule

  • Destructive

    Update a booking

    PUT /booking/{id} Used to modify a booking. Currently this is only used for capturing the booking and assigning a partnerReferenceId. Use this method to capture the booking by specifying the status as PENDING. The booking will be fulfilled on our end only once you capture it. Request Response

    PUT /api/public/v1/booking/{id}

  • Destructive

    Capture a booking (v2)

    Capture an existing UNCAPTURED booking owned by the authenticated partner by sending status=PENDING and partnerReferenceId to PUT /api/public/v2/bookings/{bookingId}/. This starts Headout fulfillment; it does not create a booking. Capture within one hour of creation, before automatic CAPTURE_TIMEOUT. Only PENDING is accepted; other statuses or an invalid booking ID return 400, another partner's booking returns 403, and a missing/invalid Headout-Auth token returns 401. Successful capture returns 200 with the booking. Tickets and vouchers become available after fulfillment (COMPLETED).

    PUT /api/public/v2/bookings/{bookingId}/

  • Destructive

    Cancel a booking

    Submit a cancellation request for a bookingId owned by your partner account. This validates input and ownership, creates a request log with status SUBMITTED, and enqueues an asynchronous job for downstream processing. The immediate response acknowledges submission and does not represent the final booking outcome. Base path: /api/public/v2/bookings

    POST /api/public/v2/bookings/{bookingId}/cancel/

  • Destructive

    Cancel a booking (Deprecated) (deprecated)

    > ⚠️ Deprecated — This endpoint will be removed in a future release. > Use POST /api/public/v2/bookings/{bookingId}/cancel/ instead. Submit a cancellation request for a bookingId owned by your partner account. This validates input and ownership, creates a request log with status SUBMITTED, and enqueues an asynchronous job for downstream processing. The immediate response acknowledges submission and does not represent the final booking outcome. Base path: /api/public/v2/partner/booking

    POST /api/public/v2/partner/booking/{bookingId}/cancel

Collection

  • Read

    List all categories by city

    GET /category/list-by/city Retrieve a list of all categories for a specific city. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|----------|--------|----------|--------------------------------------------------------------------------------------------------------------------| | QUERY | cityCode | string | no | The city code. Eg: NEW_YORK, DUBAI | | QUERY | offset | string | yes | The offset for pagination. *Ref: Pagination - Request Params* | | QUERY | limit | int | yes | The limit for pagination. *Ref: Pagination - Request Params* | Response

    GET /api/public/v1/category/list-by/city

  • Read

    List all collections

    GET /collections Overview The Partner Collections API v2 provides endpoints for accessing the collections. This API is designed to facilitate partners in fetching relevant data for different cities and languages. Request API Parameters | Parameter | Required / Optional | Description | Default Value | |----------------|---------------------|-----------------------------------------|---------------| | cityCode | Required | The city code to fetch collections for. | | | languageCode | Optional | Language code. | EN | | offset | Optional | Offset for pagination. | 0 | | limit | Optional | Limit for pagination. | 10 | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response --- Notes - Ensure that all required parameters are included in your requests. - Use appropriate city and language codes as per your application requirements. - Pagination parameters (offset and limit) help in managing large datasets.

    GET /api/public/v2/collections

City

  • Read

    List all active cities (legacy)

    GET /city List all the active cities. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|--------|--------|----------|--------------------------------------------------------------------------------------------------------------------| | QUERY | offset | string | yes | The offset for pagination. *Ref: Pagination - Request Params* | | QUERY | limit | int | yes | The limit for pagination. *Ref: Pagination - Request Params* | Response

    GET /api/public/v1/city

  • Read

    List all cities

    GET /cities/ Overview Returns a paginated list of all cities available on Headout, sorted alphabetically by name. Each city includes a code, a display name, and an image. Use the city code as the cityCode parameter in other v2 endpoints. Page size is fixed at 20. Request API Parameters | Parameter | Required / Optional | Description | Default Value | |-----------|---------------------|---------------------------------------------------------------------------------------------------------|---------------| | offset | Optional | Number of cities to skip. Start at 0 for the first page. Increment by 20 to fetch subsequent pages. | 0 | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response Response Fields | Field | Type | Description | |-------------|-----------------|----------------------------------------------------------------------------| | cities | Array of Object | Cities for the current page, sorted alphabetically by name. | | nextUrl | String / null | URL to fetch the next page. null if this is the last page. | | prevUrl | String / null | URL to fetch the previous page. null if this is the first page. | | total | Integer | Total number of cities across all pages. | | nextOffset| Integer / null | Offset value for the next request. null if this is the last page. | City Object | Field | Type | Description | |---------|--------|------------------------------------------------------------------------------------------------| | code | String | City code (e.g., NEW_YORK, DUBAI). Pass this as the cityCode parameter in other endpoints. | | name | String | Display name of the city (e.g., "New York", "Dubai"). | | image | Object | City image that can be used in your UI. Contains a url field with the CDN URL. | Error Responses | Status | Condition | |--------|------------------------| | 400 | offset is negative | --- Notes - Cities are sorted alphabetically by name. - Page size is fixed at 20. There is no limit parameter — use offset to paginate. - Use the code field from this response as the cityCode parameter in other v2 endpoints (products, categories, collections, etc.).

    GET /api/public/v2/cities/

Variant

  • Read

    List available inventory for a variant

    GET /inventory/list-by/variant Get the available inventory for a variant. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|---------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | QUERY | variantId | string | no | The ID of the variant for which the inventory needs to be fetched. | | QUERY | startDateTime | string | yes | The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. *Format: fm-date-time*. *Ref: inventory.startDateTime* | | QUERY | endDateTime | string | yes | The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. *Format: fm-date-time*. *Ref: inventory.startDateTime* | | QUERY | offset | string | yes | The offset for pagination. *Ref: Pagination - Request Params* | | QUERY | limit | int | yes | The limit for pagination. *Ref: Pagination - Request Params* | | QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: USD, AED. *Ref: https://en.wikipedia.org/wiki/ISO_4217* | Response

    GET /api/public/v1/inventory/list-by/variant

Product

  • Read

    Get product by ID

    GET /product/get/{product_id} Gets a product by productId. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|----------------|---------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | PATH | productId | string | no | Product id | | QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: USD, AED. *Ref: https://en.wikipedia.org/wiki/ISO_4217* | | QUERY | fetch-variants | boolean | yes (Default: true) | Flag to toggle the option of fetching variants. | | QUERY | language | string | yes (Default: EN) | The language in which the product details will be returned. Eg: EN, ES, FR, IT, DE, PT, NL, etc. | Response

    GET /api/public/v1/product/get/{productId}

  • Read

    List product listing by city

    GET /product/listing/list-by/city List product listing using city. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|--------------|--------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | QUERY | cityCode | string | no | The city code. Eg: NEW_YORK, DUBAI | | QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: USD, AED. *Ref: https://en.wikipedia.org/wiki/ISO_4217* | | QUERY | language | string | yes (Default: EN) | The language in which the product details will be returned. Eg: EN, ES, FR, IT, DE, PT, NL | | QUERY | offset | string | yes | The offset for pagination. *Ref: Pagination - Request Params* | | QUERY | limit | int | yes | The limit for pagination. *Ref: Pagination - Request Params* | Response

    GET /api/public/v1/product/listing/list-by/city

  • Read

    List product listing by category

    GET /product/listing/list-by/category List product listing using category. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|--------------|--------|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | QUERY | categoryId | string | no | The id of the category. | | QUERY | language | string | yes (Default: EN) | The language in which the product details will be returned. Eg: EN, ES, FR, IT, DE, PT, NL | | QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: USD, AED. *Ref: https://en.wikipedia.org/wiki/ISO_4217* | | QUERY | limit | int | yes | The limit for pagination. *Ref: Pagination - Request Params* | | QUERY | offset | string | yes | The offset for pagination. *Ref: Pagination - Request Params* | Response

    GET /api/public/v1/product/listing/list-by/category

  • Read

    List all products

    GET /products Overview The Partner Products API v2 provides endpoints for accessing the products. This API is designed to facilitate partners in fetching relevant product information for different cities and languages. Request API Parameters | Parameter | Required / Optional | Description | Default Value | |-----------------|---------------------|--------------------------------------|---------------| | cityCode | Required | The city code to fetch products for. | | | collectionId | Optional | Collection ID to filter products. | | | categoryId | Optional | Category ID to filter products. | | | subCategoryId | Optional | Subcategory ID to filter products. | | | languageCode | Optional | Language code. | EN | | currencyCode | Optional | Currency code. | | | campaignName | Optional | Campaign name for filtering. | | | offset | Optional | Offset for pagination. | 0 | | limit | Optional | Limit for pagination. | 20 | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response > Note: The pricing object fields vary by partner type. Both fields are shown in the response example below for reference. Pricing for API Partners and Agent Partners: Pricing for Affiliates: Notes - Ensure that all required parameters are included in your requests. - Use appropriate city and language codes as per your application requirements. - Pagination parameters (offset and limit) help in managing large datasets.

    GET /api/public/v2/products

  • Read

    Fetch product by ID

    GET /products/{productId} Overview The Partner Products API v2 provides endpoints for accessing the products. This API is designed to facilitate partners in fetching relevant product information for different cities and languages. Request API Parameters | Mode | Parameter | Required / Optional | Description | Default Value | |----------|-----------------|---------------------|--------------------------------------|---------------| | PATH | productId | Required | Product ID to fetch the details for. | | | QUERY | languageCode | Optional | Language code. | EN | | QUERY | currencyCode | Optional | Currency code. | | | QUERY | campaignName | Optional | Campaign name for filtering. | | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response > Note: The pricing object fields vary by partner type. Both fields are shown in the response example below for reference. Pricing for API Partners and Agent Partners: Pricing for Affiliates: Notes - Ensure that all required parameters are included in your requests. - Use appropriate language codes as per your application requirements.

    GET /api/public/v2/products/{productId}

Category

  • Read

    List all categories

    GET /categories Overview The Partner Categories API v2 provides endpoints for accessing the categories. This API is designed to facilitate partners in fetching relevant data for different cities and languages. Request API Parameters | Parameter | Required / Optional | Description | Default Value | |----------------|---------------------|----------------------------------------|---------------| | cityCode | Required | The city code to fetch categories for. | | | languageCode | Optional | Language code. | EN | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response --- Notes - Ensure that all required parameters are included in your requests. - Use appropriate city and language codes as per your application requirements.

    GET /api/public/v2/categories

Subcategory

  • Read

    List all subcategories

    GET /subcategories Overview The Partner Subcategories API v2 provides endpoints for accessing the subcategories. This API is designed to facilitate partners in fetching relevant data for different cities and languages. Request API Parameters | Parameter | Required / Optional | Description | Default Value | |----------------|---------------------|----------------------------------------|---------------| | cityCode | Required | The city code to fetch categories for. | | | languageCode | Optional | Language code. | EN | API Headers | Header | Required / Optional | Description | |----------------|---------------------|--------------------------| | Headout-Auth | Required | The Authorization Token. | Response Object: SubCategory --- Error Handling Refer to this document for handling errors in the APIs. Notes - Ensure that all required parameters are included in your requests. - Use appropriate city and language codes as per your application requirements.

    GET /api/public/v2/subcategories

Availabilities

  • Read

    List availabilities - Normal

    GET /products/{productId}/variants/{variantId}/availabilities/ Get date-level availability and pricing for a specific variant of a normal (non-seatmap) product. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|--------------|---------------|----------|-------------| | PATH | productId | integer | no | Product ID. inventorySelectionType must be NORMAL. | | PATH | variantId | integer | no | Variant ID. Must belong to the given product. | | QUERY | currencyCode | currency enum | yes | Currency for returned pricing. Defaults to USD when omitted. | | QUERY | startDate | string | yes | Start date in yyyy-MM-dd format. Defaults to today. | | QUERY | endDate | string | yes | End date in yyyy-MM-dd format. Defaults to startDate + 60 days. Max range is 90 days. | Request rules - The date range cannot exceed 90 days inclusive. - endDate must not be before startDate. - variantId must belong to the given productId. - Invalid enum values, invalid date values, or type mismatches return 400. - Missing partner context returns 403. Error response Errors use the shared envelope: | HTTP | Code | When | |---|---|---| | 400 | E_INVALID_ARGUMENT | Invalid enum, invalid date format, or type mismatch | | 400 | E_INVALID_REQUEST | Domain validation failure | | 403 | E_FORBIDDEN | Missing partner profile | | 404 | E_PRODUCT_NOT_FOUND | Unknown product, seatmap product, or variantId does not belong to the product | | 500 | E_ERROR_PROCESSING_REQUEST | Unexpected exception | Response | FIELD | TYPE | DESCRIPTION | |-------|------|-------------| | productId | integer | Original path product ID. | | variantId | integer | Original path variant ID. | | currencyCode | string | Resolved currency code. | | availabilities | array | Availability grouped by date, sorted ascending. | Each availabilities[] item contains: | FIELD | TYPE | DESCRIPTION | |-------|------|-------------| | date | string | Availability date in yyyy-MM-dd format. | | pricing | object | Partner pricing payload for this date. Reflects the minimum price across all inventory slots on that date. | | availability | string | Availability status: LIMITED, UNLIMITED, or CLOSED. | | remaining | integer | Remaining inventory. 1000 is a sentinel value indicating unlimited availability. | The pricing object: - currency - profileType — e.g. PER_PERSON - headoutSellingPrice - netPrice for API Partner and Agent Partner accounts - commissionAmount for Affiliate accounts

    GET /api/public/v2/products/{productId}/variants/{variantId}/availabilities/

  • Read

    List availabilities - Seatmap

    GET /seatmap/products/{productId}/variants/{variantId}/availabilities/ Get seatmap availabilities for a product variant over a date range. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|--------------|-----------------|----------|-------------| | PATH | productId | integer | no | Seatmap product ID. | | PATH | variantId | integer | no | Primary tour ID. Must match the product's primary tour ID. | | QUERY | currencyCode | currency enum | yes | Currency for returned pricing. Defaults to USD when omitted. | | QUERY | startDate | string | yes | Start date in yyyy-MM-dd format. Defaults to today in the tour city timezone. | | QUERY | endDate | string | yes | End date in yyyy-MM-dd format. Defaults to startDate + 60 days. | Request rules - The date range cannot exceed 90 days inclusive. - endDate must not be before startDate. - A past startDate is rejected. - variantId must match the product's primary tour ID. - Invalid enum values, invalid date values, or type mismatches return 400. - Missing partner context returns 403. Error response Errors use the shared envelope: | HTTP | Code | When | |---|---|---| | 400 | E_INVALID_ARGUMENT | Invalid enum, invalid date format, or type mismatch | | 400 | E_INVALID_REQUEST | Domain validation failure | | 403 | E_FORBIDDEN | Missing partner profile | | 404 | E_PRODUCT_NOT_FOUND | Unknown product, non-seatmap product, missing primary tour, or variantId mismatch | | 503 | E_PRICING_UNAVAILABLE | Primary tour pricing cache is missing | | 500 | E_ERROR_PROCESSING_REQUEST | Unexpected exception | Response | FIELD | TYPE | DESCRIPTION | |-------|------|-------------| | productId | integer | Original path product ID. | | variantId | integer | Primary tour ID. | | currencyCode | string | Resolved currency code. | | availabilities | array | Availability grouped by date, sorted ascending. | Each availabilities[] item contains: | FIELD | TYPE | DESCRIPTION | |-------|------|-------------| | date | string | Availability date in yyyy-MM-dd format. | | slots | array | Slots for that date, sorted by startTime. | Each slots[] item contains: | FIELD | TYPE | DESCRIPTION | |-------|------|-------------| | startTime | string | Slot start time in HH:mm format. | | pricing | object | Partner pricing payload. | | remaining | integer | Remaining inventory for the slot. | The pricing object uses a seatmap-specific pricing schema: - currency - profileType is always PER_PERSON on this route - headoutSellingPrice - netPrice for API Partner and Agent Partner accounts - commissionAmount for Affiliate accounts

    GET /api/public/v2/seatmap/products/{productId}/variants/{variantId}/availabilities/

Inventory

  • Read

    List inventory by tour

    GET /inventory/list-by/tour Get the available inventory for a tour within a specified date range. Request | MODE | KEY | TYPE | OPTIONAL | DESCRIPTION | |-------|---------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | QUERY | tourId | string | no | The unique identifier of the tour for which the inventory needs to be fetched. | | QUERY | startDateTime | string | no | The start date time from which the inventory needs to be fetched. *Format: fm-date-time*. *Ref: inventory.startDateTime* | | QUERY | endDateTime | string | no | The end date time till which the inventory needs to be fetched. *Format: fm-date-time*. *Ref: inventory.startDateTime* | | QUERY | currencyCode | string | no | The currency in which pricing information will be returned. Eg: EUR, USD, GBP. *Ref: https://en.wikipedia.org/wiki/ISO_4217* | | QUERY | offset | string | yes | The offset for pagination. | | QUERY | limit | int | yes | The limit for pagination. | Response

    GET /api/public/v2/inventory/list-by/tour

Webhooks

  • Read

    Get webhook configuration

    Retrieve your current webhook configuration

    GET /api/public/v2/webhooks

  • Write

    Create webhook configuration

    Booking Status Webhooks Overview Booking status webhooks provide real-time notifications when booking statuses change in the Headout system. Receive instant updates for booking confirmations, cancellations, and completions. Booking Status Lifecycle Status Definitions | Status | Description | Webhook Trigger | |--------|-------------|-----------------| | PENDING | Booking is pending fulfillment | ✅ On capture | | COMPLETED | Booking completed successfully | ✅ On completion | | CANCELLED | Booking has been cancelled | ✅ On cancellation | | FAILED | Booking failed due to payment or system errors | ✅ On failure | Webhook Payload Structure Payload Fields | Field | Type | Required | Description | |-------|------|----------|-------------| | bookingId | number | ✅ | Unique booking identifier (corresponds to itinerary ID) | | status | string | ✅ | Current booking status from ItineraryStatus enum | | eventTimestamp | string | ✅ | ISO 8601 timestamp when status change occurred (local time) | Implementation Guide Webhook Configuration - Configure your webhook endpoint URL through the Headout Partner API - Ensure your endpoint accepts POST requests with JSON payload - Return HTTP 2xx status codes for successful processing - Return HTTP 5xx for temporary failures (will trigger retries) - Return HTTP 4xx for permanent failures (no retries) Endpoint Requirements - HTTPS Only: All webhook URLs must use HTTPS protocol - Response Time: Respond within 30 seconds to avoid timeouts - Idempotency: Handle potential duplicate deliveries gracefully - Error Handling: Implement proper error responses Booking Captured Booking Completed Booking Cancelled Booking Failed Best Practices Performance - Respond to webhooks within 30 seconds - Process webhooks asynchronously when possible - Use appropriate HTTP status codes Notes - Webhooks are retried up to 4 times with exponential backoff - Use the Partner API to manage webhook configurations - Contact support for webhook delivery troubleshooting

    POST /api/public/v2/webhooks

  • Destructive

    Update webhook configuration

    Update your existing webhook configuration

    PUT /api/public/v2/webhooks

See How connections work for access and permissions, or browse all integrations.