One account's stock position
One account's stock position: the estimated stock on hand for the current week, the timeline behind it, the forward projection, and the last and next delivery either side of today.
partner_id is the account. variant_id or product_id scopes the read to one variant or to one product's variants.
replenishment_date and replenishment_qty are served only when the read is variant-scoped and that variant is replenishment-recommended for this account. Otherwise they are null, which is the absence of a recommendation rather than a recommendation of nothing.
Sold with Essentials+: without Tightly Connect the answer is 403 plan_excludes.
Scope: accounts:read.
Request
- Base URL: https://api.app.tightly.io
- URL: https://api.app.tightly.io/api/v1/wholesale/retailers/{partner_id}/overview
- Auth: HTTP bearer
Path parameters
The account. An id, never a name. Duplicate account names are ordinary in apparel.
Query parameters
Scope the overview to one variant.
Scope the overview to every variant of one product.
Headers
The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.
Response
The current stock estimate with the week it covers, the stock timeline, the forecast, the last and next deliveries, and, variant-scoped only, the replenishment recommendation.
Changes
No recorded changes to this operation across all 1 revision of this API.