Endpoints
Availability log
Fetch a variant’s availability with time-of-day precision, for hourly and time-slot booking
GET
Availability log
Returns a sparse change log of how many items are available for a variant, with time-of-day precision, from the earliest possible rental start through 12 months. Use it instead of the availability timeline when you need to build hourly or time-slot pickers.
The
Send the same destination to the Intent endpoint so the dates added to the cart match.
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.
Shipping destination
On stores using the new shipping settings, send where the order will ship to. Availability then uses only the shipping rates that reach that destination, including a sub-zone’s transit time for its postal code. Sendcountry_code, and optionally province_code and postal_code.
Availability shipping to a postal code
Path Parameters
Query Parameters
Two-letter country code the order will ship to. Optional. Only stores on the new shipping settings use it: availability then goes by the shipping rates that reach this country. Leave it out to use every rate. The province and postal code are ignored without it.
Example:
"CH"
Response
Successful response with the availability change log