Skip to main content
GET
Preview a sales-order item remap

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

salesOrderId
integer
required

Sales order ID

salesOrderItemId
integer
required

Sales order line-item ID (must belong to the sales order)

Query Parameters

product_id
integer
required

ID of the product to remap the line item to

Required range: x >= 1
force
boolean
default:false

Evaluate 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)

data
object

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.