Skip to main content
GET
Preview an assembly order ledger 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.

Path Parameters

assemblyOrderId
integer
required

ID of a completed assembly or disassembly order.

Query Parameters

produced_quantity
number

New actual quantity of the order's own SKU. Greater than zero.

Required range: x > 0
lines
object[]

Component/output lines to change, as lines[0][order_line_id]=88&lines[0][quantity]=24.

balancing_entry[date]
string<date>

Optional balancing adjustment date. 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 each change. Rejected (422) when later inventory movements exist on an affected stock.

Response

Preview of the correction

message
string
data
object

Result of a ledger correction on a completed assembly or disassembly order. The preview omits correction_ids, adjustment_id, rematerialized_log_ids and balance_warnings.