Skip to main content

Get Product Availability Date

GET 

/api/products/:product/availability-date

Returns when quantity units of a product, bundle or kit can ship — the availability (back-in-stock) date — with the supply it draws on and, for a bundle, the bottleneck component.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

How it is computed: supply is a FIFO queue — free stock on hand today (all warehouses), then the unallocated remainder of every open purchase order line in ETA order. A line's ETA is the earliest open inbound shipment's expected_arrival_date, else the PO's estimated_delivery_date (Available ETA); lines with no ETA queue last. Units already promised to backorders are netted out first. The date is the ETA of the supply that reaches quantity; a late PO never yields a date in the past.

Bundles have no stock of their own: the date is the latest of their components' dates for quantity × quantity_per_unit each, and bottleneck_product_id / bottleneck_sku name the component that decides it. Kits use pre-built stock and their own POs first, then the better of that and building the shortfall from components.

status: in_stock (free stock covers it today), inbound (open POs with ETAs cover it), eta_unknown (covered only with a PO that has no ETA — availability_date is null), no_supply (stock + open POs cannot cover it — null date), not_stocked (a matrix parent, or a bundle with no components).

availability_date is a date-only value (YYYY-MM-DD, account timezone). sources lists the supply consumed to reach the quantity; components holds the same object per component. Read-only: nothing is allocated.

To improve the dates, keep PO and inbound-shipment ETAs current — see Update Purchase Order and Update Inbound Shipment.

Authentication: Requires Bearer token (scope products:read, permission products.show).

Request​

Responses​

OK

Response Headers
    Content-Type