---
title: "One account's stock position"
method: GET
path: "/api/v1/wholesale/retailers/{partner_id}/overview"
tags: ["wholesale"]
---

# One account's stock position

`GET /api/v1/wholesale/retailers/{partner_id}/overview`

## Request

- Base URL: `https://api.app.tightly.io`
- URL: `https://api.app.tightly.io/api/v1/wholesale/retailers/{partner_id}/overview`
- Auth: HTTP bearer

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`.

## Path parameters

- `partner_id` string, required

## Query parameters

- `variant_id` string
- `product_id` string

## Headers

- `Tightly-Version` string

## Response `200`

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.

- object
  - `data` object
    - `current_stock` object: start_date, end_date and estimated_stock_on_hand for the week being read.
    - `forecasted_stock_timeline` object[]
    - `last_delivery` object, nullable
    - `next_delivery` object, nullable
    - `replenishment_date` string, date, nullable
    - `replenishment_qty` integer, nullable
    - `stock_timeline` object[]
  - `message` object: severity, service and desc.

## Other responses

- `401`: No usable key: malformed, unknown, revoked, expired or stopped. One refusal covers all five, telling a caller which is which maps the surface for them. A request with no Authorization header at all is refused 400 before any key is looked for.
- `403`: The key may not reach this operation. `plan_excludes` when Accounts is sold with Essentials+ and this organisation's plan does not include it; `scope_missing` when the key does not hold Accounts; `organization_mismatch` when the path names an organisation that is not the key's; `ip_not_allowed` when the caller's address is outside the key's allowlist; `account_mismatch` when a key issued to one account names another in the path, and the sentence names both accounts.
- `429`: The key has spent its allowance for this minute. 600 reads and 120 writes a minute, counted per key, refused calls included. `Retry-After` says how long to wait.
- `503`: The database is briefly out of reach, which is what a failover or a full connection pool looks like from outside. Wait the seconds `Retry-After` names and send the request again. A read is safe to repeat. A write is not, because the connection was lost in the middle of it, so read the object back before sending it a second time. Branch on the status rather than on `code`, which is `POSTGRES_UNAVAILABLE` from one of the two seams that raise this and `SERVICE_UNAVAILABLE` from the other.

---

[API](https://skmtc.dev/tightly/apis/tightly-api.md) · [All operations](https://skmtc.dev/tightly/apis/tightly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tightly/apis/tightly-api/revisions/199f7eb35afb?raw)