Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Query Parameters

page
integer
default:1

1-based page index to return. Defaults to 1.

Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:20

Rows per page, 1..100. Defaults to 20.

Required range: 1 <= x <= 100
family
enum<string>

One of the six families: restock, rebalance, markdown, pre_season_order, supplier_return, supplier_exchange. Omit to list every family.

Available options:
restock,
rebalance,
markdown,
pre_season_order,
supplier_return,
supplier_exchange
status
enum<string>

A status of THAT family's own lifecycle — the six do not share one. Omit for any status.

Available options:
DRAFT,
VALIDATED,
SENT,
RECEIVED,
PROPOSED,
AGREED,
IN_TRANSIT,
SETTLED,
CREDITED,
CLOSED,
CANCELLED
openOnly
enum<string>

true keeps only the plans that are still live (not CLOSED, not CANCELLED) — what the morning list asks for. Omit or false for the whole history.

Available options:
true,
false

Response

A page of plans, soonest deadline first, with the pagination totals.

A page of plans, soonest deadline first, with the pagination totals.

items
object[]
required

The rows on this page, in the query's sort order.

total
integer
required

Total rows matching the filter across ALL pages, not just this one.

Required range: 0 <= x <= 9007199254740991
page
integer
required

The 1-based page number served.

Required range: 0 < x <= 9007199254740991
pageSize
integer
required

Rows requested per page.

Required range: 0 < x <= 9007199254740991
pageCount
integer
required

Total number of pages; stop walking when page reaches it.

Required range: 0 <= x <= 9007199254740991