Availability log
Fetch a variant’s availability with time-of-day precision, for hourly and time-slot booking
occupancy array is a chronological list of change points. Each { at, available } entry means that from at onward, available items are free until the next entry. The first entry is the opening level, and a trailing entry with available of 0 marks the end of the bookable window. Availability only changes at a handful of instants, so the array stays small.
at is a shop-local timestamp with no offset (YYYY-MM-DDTHH:MM:SS). Interpret it in the shop’s time zone and don’t apply a UTC offset.
The counts already account for the selected delivery and return methods, including their preparation and restock times. Those buffers can be set in hours, so an item that comes back at 2 pm with a 6-hour restock isn’t available again until 8 pm, and a slot earlier that evening reports as unavailable.
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 instant after the opening entry bookable, however low the count runs. 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 the shop's default delivery method)
shipping, pick_up Return method type used to calculate logistics padding (defaults to the shop's default return method)
shipping, drop_off Response
Successful response with the availability change log
Chronological list of availability changes. Each entry sets the number of available items from its at instant until the next entry. The first entry is the opening level; a trailing entry with available 0 bounds the end of the window.
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