sell_out

What one account has confirmed about its own sell-out reports

The four answers one account has confirmed about its own sell-out reports, or null when nobody has answered yet: which day its week ends on, whether the figures cover stores, distribution centres or the whole account, the currency and whether prices include tax, and whether a product missing from a file means it sold none or means the retailer did not report it. account_id is required.

Null is the meaningful case. The declaration is a precondition of an import rather than a setting, so an account with none has its files refused until a person answers.

The four exist because every default is wrong for about half of all accounts. One retailer writes an explicit zero for a product that did not sell; another omits the row. Guess wrong and half the book shows healthy products as dead, with the row count looking correct either way.

Every machine value is served beside the sentence a person reads for it (covers, prices_are, missing_row_means, week_ends_on), so no surface has to keep its own translation table. confirmed_by is the author's id and confirmed_by_name the name resolved for it, with the name null rather than the id where there is none.

Sold with Essentials+: without Tightly Connect the answer is 403 plan_excludes.

Scope: sell_out:read.

get/api/v1/sell-out/declaration

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/sell-out/declaration
  • Auth: HTTP bearer

Query parameters

account_idstring required

The account. An id, never a name. "Intersport" is a dozen buying groups, and a name here would apply one retailer's week anchor to another retailer's file with every screen afterwards looking normal.

Headers

Tightly-Versionstring
Example:2026-11

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 confirmed declaration, week_ends_on / week_anchor_dow, covers / location_grain, currency, prices_are / price_tax_basis, missing_row_means / absence_convention, confirmed_by, confirmed_by_name, confirmed_at, or data: null when nobody has confirmed for this account yet.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.