Can these quantities be met, and by when
/v1/availability/checkFor each line: whether it can be met now, the shortfall, the earliest date incoming stock completes it, and which locations would supply it. Lines for the same variant share its stock. Nothing is reserved; supplier stock can change before you order.
- Called by
- Account client
- Scope
- stock:read
Request body · application/json
- linesarray of (ByVariantIdLine | BySupplierSkuLine | ByGtinLine | ByExternalRefLine)required
Each item is one of these shapes
ByVariantIdLine
A Presslane Suppliers variant ID.
- quantityintegerrequired
- variant_idstringrequired
BySupplierSkuLine
A supplier and that supplier's SKU.
- quantityintegerrequired
- supplierstringrequired
Supplier ID or slug.
- supplier_skustringrequired
ByGtinLine
A GTIN.
- gtinstringrequired
A GTIN (8–14 digits); leading zeros are matched loosely.
- quantityintegerrequired
ByExternalRefLine
The account's own variant reference.
- external_refstringrequired
The account's own variant reference, through its links.
- quantityintegerrequired
- locationstring
Responses
200The check result.Show
- can_fulfil_nowbooleanrequired
- fulfil_bystring (date) | nullrequired
The date by which every line can be met, or null.
- linesarray of objectrequired
Child attributes
- allocationobjectrequired
Child attributes
- incomingarray of objectrequired
Child attributes
- expected_onstring (date)required
- locationstringrequired
- quantityintegerrequired
- nowarray of objectrequired
Child attributes
- locationstringrequired
- quantityintegerrequired
- as_ofstring (date-time)required
- available_nowinteger | nullrequired
- can_fulfil_nowbooleanrequired
- candidatesintegerrequired
Supplier variants the identifier matched; the best is used.
- external_refstring | nullrequired
- fulfil_bystring (date) | nullrequired
Today if met now; else the date incoming stock completes the line; null if it cannot.
- quantityintegerrequired
- request_indexintegerrequired
- shortfallintegerrequired
Units not available now.
- stalebooleanrequired
- statusstringrequired
in_stockat or above the low-stock threshold;low_stockabove 0 and below it;out_of_stock0 with nothing incoming;backorder0 with incoming stock dated;discontinuedended by the supplier or feed;unknownno stock yet or data past the supplier's stale-after age (last numbers still returned,stale: true);supplier_archivedthe supplier left the directory;trade_account_requiredthe supplier shows stock only to businesses with a trade account number recorded for it.One of
in_stock,low_stock,out_of_stock,backorder,discontinued,unknown,supplier_archived,trade_account_required - variant_idstringrequired
- not_foundarray of map of anyrequired
- 400The request is not valid (
invalid_request). - 401Missing, expired or revoked token (
invalid_token). - 403The token lacks a scope (
insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this. - 429Too many requests (
rate_limited); seeRetry-After.
curl -sS -X POST 'https://suppliers.presslane.ai/v1/availability/check' \
-H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' \
--data '{"lines":[{"quantity":1,"variant_id":"string"}]}'{
"can_fulfil_now": false,
"fulfil_by": "2026-11-21",
"lines": [
{
"allocation": {
"incoming": [
{
"expected_on": "2026-11-21",
"location": "string",
"quantity": 1
}
],
"now": [
{
"location": "string",
"quantity": 1
}
]
},
"as_of": "2026-11-09T08:00:00Z",
"available_now": 1,
"can_fulfil_now": false,
"candidates": 1,
"external_ref": "string",
"fulfil_by": "2026-11-21",
"quantity": 1,
"request_index": 1,
"shortfall": 1,
"stale": false,
"status": "in_stock",
"variant_id": "string"
}
],
"not_found": [
{}
]
}