What is booked for a season, and the one envelope comparison that is like-for-like
The headline of a wholesale book for one season: booked quantity and value, lines, accounts, the split by status and by channel, the buy envelope the book runs against with open to buy, the prebook against at-once split, and the firm, walkable and unknown split of the committed value.
season_code is required, commitment_id narrows to one Commitment, as_of reads the book as it stood at an instant, and season_start overrides the season anchor the prebook split is measured against.
book is null when the scope has no lines at all, and so is envelope: a season nobody has booked into is not a season booked to zero. A hold adds its quantity to booked_qty and nothing to booked_value_usd, so soft_qty and committed_qty are served beside them, because an unpriced hold's value is unstated rather than zero.
Totals only. Use get_order_book_firmness for the per-account exposure and the cancellation ladder, get_order_book_accounts for the account-by-account comparison, and get_order_book_curve for how the book was taken over time. All four read the same book, so a figure from one cannot disagree with a figure from another.
The book stays in the organisation's functional currency: _usd in a key name is historical, so on a sterling book booked_value_usd carries pounds. Every order book read serves the same currency block.
Sold with Essentials+: without Tightly Connect the answer is 403 plan_excludes.
Scope: order_book:read.
Request
- Base URL: https://api.app.tightly.io
- URL: https://api.app.tightly.io/api/v1/order-book/summary
- Auth: HTTP bearer
Query parameters
The season being read, e.g. SS27.
Narrow the book to one Commitment's scope.
Reconstruct the book as it stood at this instant (ISO-8601). Default is now.
Declare the date the season starts shipping, what the prebook / at-once split is measured against. Omitted, the anchor is derived from the earliest ship window and labelled derived.
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 book, its envelope, the prebook / at-once split with the anchor it was measured against, and the firm / walkable / unknown split of the committed value.
Changes
No recorded changes to this operation across all 1 revision of this API.