Skip to main content
POST
Product availability

Path Parameters

proxy_path_prefix
string
required

The Shopify proxy path prefix configured for the app (e.g., 'customer_portal')

Body

application/json
product_ids
integer[]
required

Array of Shopify product IDs to check

rental_start
string<date-time>
required

Start date of the rental period

rental_end
string<date-time>

End date of the rental period

location_id
integer

Optional Shopify location ID. When the shop has locations enabled, only items at this location count toward a variant's availability. Ignored when locations are disabled. Oversellable variants are always returned as available.

Response

Successful response with product availability

products
object[]
required