Skip to main content
GET
/
{proxy_path_prefix}
/
availability_log
Availability log
curl --request GET \
  --url https://api.example.com/{proxy_path_prefix}/availability_log
{
  "occupancy": [
    {
      "at": "2025-01-01T09:00:00",
      "available": 3
    },
    {
      "at": "2025-01-03T14:30:00",
      "available": 1
    },
    {
      "at": "2025-01-08T11:00:00",
      "available": 3
    },
    {
      "at": "2025-12-31T23:59:59",
      "available": 0
    }
  ],
  "inventoryCount": 3,
  "futureAvailabilityInventoryCount": 3,
  "uncommitedInventoryCount": 1
}
Returns a sparse, intra-day-precise change log of how many items are available for a variant, spanning from the earliest possible rental start through 12 months. Use this instead of the availability timeline when you need time-of-day precision, for example to build hourly or time-slot pickers. The 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. Because availability only changes at a handful of instants, the array stays small. at is a shop-local, offset-free timestamp (YYYY-MM-DDTHH:MM:SS). Interpret it in the shop’s timezone; do not apply a UTC offset. The counts already account for the selected delivery and return methods, including their preparation and restock times. These turnaround times can be configured in hours, so an item that comes back at 14:00 with a 6-hour restock will not become available again until 20:00, and a slot earlier that evening will report as unavailable.

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
enum<string>

Delivery method type used to calculate logistics padding (defaults to the shop's default delivery method)

Available options:
shipping,
pick_up
​
return_method_type
enum<string>

Return method type used to calculate logistics padding (defaults to the shop's default return method)

Available options:
shipping,
drop_off

Response

Successful response with the availability change log

​
occupancy
object[]
required

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.

​
inventoryCount
integer
required

Total number of available items for the variant

​
futureAvailabilityInventoryCount
integer
required

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

​
uncommitedInventoryCount
integer
required

Number of items not committed to any current or future rental