orders

Every order file that has arrived, newest first

Every purchase order a retailer has sent you, whichever door it came through: a mail attachment, a followed link, an upload, a buyer's own send through their seat, or an 850 over EDI. Each row says what state the paper is in, what Tightly read off it, and which draft order it became.

Filter by state to find the papers waiting on somebody, by lane to find one door's, or by trading_partner_id for one account's. state also takes needs_you, ready and confirmed: who acts next, read from the paper and the draft order it made together.

Scope: orders:read.

get/api/v1/sales/orders/documents

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/sales/orders/documents
  • Auth: HTTP bearer

Query parameters

state'received' | 'parsed' | 'applied' | 'refused' | 'queued' | 'sent' | 'failed' | 'needs_you' | 'ready' | 'confirmed'

The paper's own state (received is not read yet; applied made a draft; refused created nothing and says why), or who acts next: needs_you (a line to match, a door not on file, or no draft), ready (one press of Confirm), confirmed (the draft was confirmed).

lane'upload' | 'email' | 'link' | 'portal' | 'sps_commerce'

The door the paper came through: an upload, a mail attachment, a link in a mail, the buyer's own seat, or the EDI network.

trading_partner_idstring

One account's papers only.

sincestring date

Papers received on or after this day.

limitinteger

Rows per page.

offsetinteger

Rows to skip, for the next page.

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 papers, and the counts a head ties to.

dataobject
messageobject

Changes

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