returns

list returns

Every return, newest first, with what is expected back and what has arrived. state_numbers counts the WHOLE filtered book per state, not the page you were served, so a heading built on it ties to the rows underneath. Filter by state, origin, order or creation date.

Scope: returns:read.

get/api/v1/sales/returns

Request

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

Query parameters

state'expected' | 'received' | 'closed' | 'exception' | 'cancelled'

Returns in this state only.

origin'channel' | 'manual' | 'api' | 'csv' | 'portal'

Returns that came in by this door only.

order_idstring

Returns against this order only.

sincestring date

Returns created on or after it.

offsetinteger

Rows to skip before the page starts.

limitinteger

Rows on the 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 page, and the counts a heading has to tie to.

messageobject

severity, service and desc.

Changes

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