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.

Path Parameters

orderId
string
required

The purchase order (bon de commande) id.

Minimum string length: 1

Response

The per-line received-vs-ordered variance with the valued shortfall/over-receipt totals.

The per-line received-vs-ordered variance with the valued shortfall/over-receipt totals.

lines
object[]
required

Per-SKU received-vs-ordered variance (every ordered line appears).

totalOrderedQuantity
integer
required

Total units ordered across lines.

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

Total units received across lines.

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

Lines still short of their ordered quantity (received < ordered).

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

Lines that received strictly more than ordered (received > ordered).

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

Net valued variance across all lines, in cents.

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

Sum of the negative (shortfall) variances, in cents.

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

Sum of the positive (over-receipt) variances, in cents.

Required range: -9007199254740991 <= x <= 9007199254740991