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
import requests

url = "https://api.example.com/{proxy_path_prefix}/availability_timelines"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/{proxy_path_prefix}/availability_timelines', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/{proxy_path_prefix}/availability_timelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/{proxy_path_prefix}/availability_timelines"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/{proxy_path_prefix}/availability_timelines")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/{proxy_path_prefix}/availability_timelines")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "occupancy": {
    "2025-01-01": 3,
    "2025-01-02": 3,
    "2025-01-03": 2,
    "2025-01-04": 0
  },
  "inventoryCount": 3,
  "futureAvailabilityInventoryCount": 3,
  "uncommitedInventoryCount": 1
}
{
"error": "Variant not found"
}
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.

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