Availability timeline
Fetch a day-by-day count of available items for a variant across a 12-month window
occupancy object maps each date to the number of available items on that day. A value of 0 means the day is fully booked.
oversellable is true when the variant is set to sell past the items in stock. Treat inventoryCount as a count rather than a cap and keep every day bookable, including the days that report 0. See Overselling items.Path Parameters
The Shopify proxy path prefix configured for the app (e.g., 'customer_portal')
Query Parameters
Shopify ID of the variant to check availability for
Optional Shopify location ID to filter items by location
Delivery method type used to calculate logistics padding (defaults to 'shipping')
Response
Successful response with availability timeline
Map of date (YYYY-MM-DD) to number of available items on that day. A value of 0 means fully booked.
Total number of available items for the variant
True when the variant is set to sell past the items in stock. Read inventoryCount as a count rather than a cap: the variant stays bookable on dates where every item is already out.
Number of items not on an unbounded (open-ended) current rental — i.e. items that will eventually become available
Number of items not committed to any current or future rental