Skip to main content
GET
/
{proxy_path_prefix}
/
availability_timelines
Availability timeline
curl --request GET \
  --url https://api.example.com/{proxy_path_prefix}/availability_timelines
{
  "occupancy": {
    "2025-01-01": 3,
    "2025-01-02": 3,
    "2025-01-03": 2,
    "2025-01-04": 0
  },
  "inventory_count": 3,
  "future_availability_inventory_count": 3,
  "uncommited_inventory_count": 1
}
Returns a day-by-day count of available items for a variant, spanning from the earliest possible rental start date through 12 months. Use this to build a date picker that disables fully booked days. The occupancy object maps each date to the number of available items on that day. A value of 0 means fully booked.

Path Parameters

​
proxy_path_prefix
string
required

The Shopify proxy path prefix configured for the app (e.g., 'customer_portal')

Query Parameters

​
variant_shopify_id
integer
required

Shopify ID of the variant to check availability for

​
location_id
integer

Optional Shopify location ID to filter items by location

​
delivery_method_type
string

Delivery method type used to calculate logistics padding (defaults to 'shipping')

Response

Successful response with availability timeline

​
occupancy
object
required

Map of date (YYYY-MM-DD) to number of available items on that day. A value of 0 means fully booked.

​
inventory_count
integer
required

Total number of available items for the variant

​
future_availability_inventory_count
integer
required

Number of items not on an unbounded (open-ended) current rental — i.e. items that will eventually become available

​
uncommited_inventory_count
integer
required

Number of items not committed to any current or future rental