Skip to main content
POST
Correct a posted receiving-report line quantity

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

receivingReportItemId
integer
required

Receiving report item (line) ID

Body

application/json
correct_qty
number
required

The corrected quantity for the line, expressed in the same basis (base units) as the line's received_qty. Must differ from the currently posted quantity.

Required range: x >= 0
preview
boolean
default:false

When true, measure the correction and its impact only — do not post the adjustment.

reason
string | null

Optional remarks stored on the adjustment.

Maximum string length: 1000
confirm_shelf_only
boolean
default:false

Required (true) to apply an increase via adjustment, acknowledging that only on-hand is corrected — PO received quantity, pegs, and receipt cost are not advanced. Ignored for decreases.

unit_cost
number | null

Override unit cost for the adjustment. Defaults to the receipt line's unit_price when omitted. Chiefly relevant to positive (increase) adjustments, which may open a new cost layer.

Required range: x >= 0

Response

Correction preview (preview=true) or the posted adjustment result. The data object reports the computed delta and the peg / fulfillment-order over-release impact; when applied it also includes the posted adjustment id and correction linkage.

success
string

Result message (e.g. "Quantity correction preview." or "Quantity correction adjustment posted.").

data
object