Preview a sales-order item remap
Dry-run a remap of a single posted line item to a different product. Reports
whether the remap is allowed, whether a force flag is required, and what
will happen to the fulfillment order — without mutating anything.
Purgatory mapping only covers pre-posting orders, so this (and the remap endpoint) are the posted-order counterpart: they let you correct an incorrect product mapping on an already-posted order and re-post that one line.
Always returns 200 — even when the remap is blocked — so the caller can
read blocked_reason. Shipped/cancelled/refunded orders and
already-shipped or invoiced line items are hard-blocked; a line item split
across multiple fulfillment orders is also blocked (the split block is
scoped to the target item, not the whole order); a pushed fulfillment
order sets requires_force.
Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
Sales order ID
Sales order line-item ID (must belong to the sales order)
Query Parameters
ID of the product to remap the line item to
x >= 1Evaluate the plan as if force were passed — i.e. treat a pushed
fulfillment order as something that will be unpushed, deleted, and
recreated rather than a block.
Response
Remap plan (the remap may still be blocked — check allowed)
Result of analysing a posted-order line-item remap. Returned by the
remap-preview endpoint and by the remap endpoint when dry_run is true.
Lets a caller decide whether to proceed before mutating — whether the remap is
allowed, whether a force flag is required, and what will happen to the
fulfillment order.