order_book

One account's book, style by style

One account's book, style by style: prebook, at-once and undated quantities, the booked quantity and value, last price, line count, ship window, cancel date, status, Commitments and a split block naming the prebook anchor.

trading_partner_id is required. Supply season_code for a seasonal book, or omit it with an explicit continuity commitment_id to read only lines stamped to that commitment. as_of and season_start narrow. Read it before writing a line.

Grouped by product; unmatched style references remain visible. Use get_order_book_style_lines for one style across all accounts.

booked_value_usd is summed over the same lines get_order_book_accounts sums, each at its own price, so the styles under one account add to its figure to the cent. A held unit has no price: it counts in booked_qty and adds nothing here. held_qty_from_account, held_by_name and held_at say how many of those units the account held by answering a showing, and who, and when it landed. Cancelled lines count toward nothing; has_cancelled is reported and booked_qty is null, not 0.

predicted_qty is what we expect this account's doors to sell of the style, beside what it has booked, so the difference is one subtraction on one row. Null where unsized, absent where the sizing could not be read, never 0.

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

Scope: order_book:read.

get/api/v1/order-book/account-styles

Request

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

Query parameters

trading_partner_idstring required

The account. An id, never a name. Duplicate account names are ordinary in this trade and a name here would show one retailer's book under another's.

season_codestring

The season, e.g. SS26. Normalised on read, so ss26 and SS26 are one season. An un-normalised code used to return an empty book, which reads as "this account has taken nothing".

commitment_idstring

Narrow the book to one Commitment. A narrowing that could only be PARTLY resolved says so in scope_reason rather than serving a shorter list silently.

as_ofstring date-time

Read the book as it stood at this instant, rather than now.

season_startstring date

DECLARE the day the season starts shipping, which is what each row's prebook / at-once split is measured against. Unstated, it is derived from the book's earliest ship window and the response labels it as derived.

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 account's book. Each styles[] row carries product_id, style_ref and product_title, booked_qty and booked_value_usd, last_booked_at and last_price, lines, has_cancelled, sources, the soft share (soft_qty, soft_lines, status, statuses), the row's dates (first_ship_window_start, next_cancel_date) and its commitment_ids, where its committed money stands (firmness: firm, walkable, unknown, mixed, or null with no committed line; firmness_bases; firm_value_usd, walkable_value_usd, unknown_value_usd, classified as /order-book/firmness sums them), plus this style's prebook / at-once quantities and, where the portal facts were readable, held_qty_from_account, held_by_name and held_at, and, where the sizing was readable, predicted_qty. The header carries season_code as actually read, as_of, the split block with its anchor and undated disclosure, and scope_reason.

messageobject

severity, service and desc.

Changes

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