Suppliers

List orders

The date filter defaults to the last 12 months; the applied range is echoed back in date_filter. Scoped to the authenticated user's company and gated on the orders.read permission.

get/v1/orders

Request

  • Base URL: https://api.officina.it
  • URL: https://api.officina.it/v1/orders
  • Auth: HTTP bearer

Query parameters

qstring

Substring match on the supplier name.

status'pending' | 'delivery' | 'received'

Tab filter: pending, delivery or received. Omit for every status.

supplier_idstring

Restrict to one supplier.

sort'date' | 'number' | 'supplier' | 'invoice' | 'total'

Sort key (default date).

direction'asc' | 'desc'

Sort direction (default desc).

fromstring date

Inclusive lower bound on orders.created_at (YYYY-MM-DD).

tostring date

Inclusive upper bound on orders.created_at (YYYY-MM-DD).

preset'rel30' | 'rel90' | 'rel365' | 'year' | 'Q1' | 'Q2' | 'Q3' | 'Q4' | 'month' | 'custom' | 'all'

Date filter preset. Relative presets (rel30/rel90/rel365) are resolved server-side from "now" and ignore from/to. Absolute presets (year, Q1-Q4, month, custom) require both from and to. all returns everything (no time bound). Unknown values are rejected with 422.

Omitting from/to/preset gives the default window, the last 12 months. This tier is stateless: a selection applies to the request that carries it and is never stored, so the same request always covers the same range. The effective range is echoed back in date_filter.

limitinteger

Page size. Default 20, max 100.

starting_afterstring

Opaque cursor from a previous response's next_starting_after.

Response

  • date_filter success
object'list' required

Polymorphic discriminator.

has_moreboolean required

True if more results exist beyond this page. Use this for the "load more" UI — data.length alone is unreliable because a full page may still be the last page.

next_starting_afterstring

Opaque cursor for the next page. Present (and non-empty) when has_more is true; omitted otherwise. Pass the value verbatim as ?starting_after= on the follow-up request. Clients MUST NOT parse it — today it encodes an offset, tomorrow it may encode a (created_at, id) tuple without a wire-visible change.

urlstring required

The request path that produced this list.

Changes

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