Skip to main content
GET
Preview a posted quantity correction

Authorizations

Authorization
string
header
required

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

Query Parameters

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
balancing_entry[date]
string<date>

Date of the balancing adjustment. Not in the future. When omitted (and allow_shelf_change is not true) the balancing entry is dated today.

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

Preview of the correction

message
string
Example:

"Posted quantity correction preview."

data
object

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