Skip to main content
GET
/
api
/
public
/
v2
/
products
/
{productId}
/
variants
/
{variantId}
/
availabilities
curl --location 'https://www.headout.com/api/public/v2/products/2920/variants/4782/availabilities/?currencyCode=USD&startDate=2026-07-01&endDate=2026-07-31' \
--header 'Headout-Auth: <YOUR_API_KEY>'
{
  "productId": 2920,
  "variantId": 4782,
  "currencyCode": "USD",
  "availabilities": [
    {
      "date": "2026-07-14",
      "pricing": {
        "currency": "USD",
        "profileType": "PER_PERSON",
        "headoutSellingPrice": 220.33,
        "commissionAmount": 44.06
      },
      "availability": "LIMITED",
      "remaining": 5
    }
  ]
}
Retrieve date-level availability for a specific variant of a normal product within a date range.
curl --location 'https://www.headout.com/api/public/v2/products/2920/variants/4782/availabilities/?currencyCode=USD&startDate=2026-07-01&endDate=2026-07-31' \
--header 'Headout-Auth: <YOUR_API_KEY>'
{
  "productId": 2920,
  "variantId": 4782,
  "currencyCode": "USD",
  "availabilities": [
    {
      "date": "2026-07-14",
      "pricing": {
        "currency": "USD",
        "profileType": "PER_PERSON",
        "headoutSellingPrice": 220.33,
        "commissionAmount": 44.06
      },
      "availability": "LIMITED",
      "remaining": 5
    }
  ]
}

Authorizations

Headout-Auth
string
header
required

Path Parameters

productId
integer
required

Normal product ID.

variantId
integer
required

Variant ID belonging to the product.

Query Parameters

currencyCode
string

Currency code for displaying prices. Defaults to USD when omitted.

startDate
string<date>

Beginning of the availability window in yyyy-MM-dd format. Defaults to today in the tour city timezone.

endDate
string<date>

End of the availability window in yyyy-MM-dd format. Defaults to startDate + 60 days. The date range cannot exceed 90 days inclusive.

Response

Successful response

productId
integer

Product ID from the path parameter.

variantId
integer

Variant ID from the path parameter.

currencyCode
string

Resolved currency code used in this response.

availabilities
object[]

Date-level availability sorted ascending by date. Empty when no availability exists for the requested window.