Skip to main content
POST
Correct a posted 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.

Body

application/json
transaction_type
enum<string>
required

Type of transaction to correct.

Available options:
assembly_order,
disassembly_order
transaction_id
integer
required

ID of the transaction (assembly or disassembly order ID).

Required range: x >= 1
quantity
number
required

New finished-good quantity. Must be greater than zero.

Required range: x > 0
reason
string
required

Why the posted quantity is being corrected. Stored with the correction record.

Maximum string length: 500
balancing_entry
object | null
allow_shelf_change
boolean
default:false

true skips the balancing adjustment so today's on-hand moves by onhand_delta. Rejected (422) when a later shipment, transfer, count or adjustment already exists on the finished-good stock.

Response

Correction saved

message
string
Example:

"Posted quantity corrected. Rewritten quantity logs were rematerialized into Core where Core tables exist."

data
object

Result of a posted-quantity correction (or its preview).