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

1-based page number (default 1).

Required range: 0 < x <= 9007199254740991
pageSize
integer

Rows per page, max 100 (default 20).

Required range: 0 < x <= 100
status
enum<string>

Filter by status: open (partiellement ou non reçue) or received (soldée).

Available options:
open,
received
supplierId
string

Filter to orders placed with one supplier (fournisseur).

Minimum string length: 1
shopId
string

Filter to orders for one store (magasin).

Minimum string length: 1
sortField
enum<string>

Sort key: order id or number of lines (default id).

Available options:
id,
lineCount
sortDirection
enum<string>

Sort direction (default asc).

Available options:
asc,
desc

Response

A page of purchase orders with the pagination totals.

A page of purchase orders with the pagination totals.

items
object[]
required

This page's purchase orders.

total
integer
required

Total orders matching the filter, across all pages.

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

This page's 1-based number.

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

Rows requested per page.

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

Total number of pages.

Required range: -9007199254740991 <= x <= 9007199254740991