order_book

Every account's book against its own prior season, read at the same days before start

One row per account: this season's booked quantity and value, and the same account's prior-season book read at the same number of days before the season started shipping, with each account's identity and reference. held_qty is the hold units already inside booked_qty, never beside it: a hold has no price, so it moves the booked quantity and not the value. booked_priced_qty is booked_qty's priced subset, what booked_value_usd is averaged over.

season_code is required; prior_season_code, season_start and prior_season_start state the anchors, commitment_id narrows to one Commitment, as_of reads the book at an instant, so a half-taken book is never compared with a finished one.

trading_partner_id is the identity and name only what to show, since account names repeat; account_reference is the account's own reference, with account_reference_reason where there is none.

prior is null where the prior season has no book at all; a zero inside it means the book exists and this account had nothing booked then. anchors.prior_reason says why there is none.

predicted_qty is what we expect this account's doors to sell, beside booked_qty: under ordered accounts are one subtraction away. Null where nothing is sized, absent where unreadable, never 0. doors_reporting of doors_on_file is how much of the estate the prediction stands on.

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

Scope: order_book:read.

get/api/v1/order-book/accounts

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/order-book/accounts
  • Auth: HTTP bearer

Query parameters

season_codestring required
Example:SS27

The season being read, e.g. SS27.

commitment_idstring

Narrow the book to one Commitment's scope.

as_ofstring date-time

Reconstruct the book as it stood at this instant (ISO-8601). Default is now.

prior_season_codestring

The season to compare against. Unstated, it is resolved from the declared season chain.

season_startstring date

Declare the date this season starts shipping. Omitted, it is derived and labelled derived.

prior_season_startstring date

Declare the prior season's start, so the T-minus-N cut is the same distance on both.

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

t_minus_days, the two season anchors with their sources, and one row per account holding a line in either season, each with booked_qty, booked_value_usd, prior, doors_reporting, doors_on_file, predicted_qty and, where the held share was readable, held_qty.

Each row also carries the season's demand from the account, as the Commitment's wholesale leg carries it: demand_units, demand_value_usd (at the account's own wholesale price, null where it has no priced line), demand_cost_usd, demand_value_basis, demand_source (sell_out where it stands on the account's own sell-out, sell_in where on what you ship them), demand_note, and gap, the demand the book has not yet taken. They are null where none is measured, with demand_unavailable_reason; demand_commitment_id names the Commitment read and demand_reason says why a page carries none. Beside them: shown_at, shown_state and showing_id (the latest showing), portal_seats (accepted, invited, last_opened_at) and waits_on_you, four counts (claims, asks, order_files at the needs_you stage, door_types), each null where that kind cannot be read.

messageobject

severity, service and desc.

Changes

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