Skip to main content

Check Line Move to Configured Product

GET 

/api/configurable-products/lines/:salesOrderLineId/move

Check whether one sales order line that is still on its base product can move to its configured SKU's product (the product the configured SKU is mapped to or was created as), and what it would move to. Uses the same rules as Re-link Open Lines.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token (scopes products:read and orders:read) and the permissions to create products and update sales orders. A token without orders:read gets 403.

Response data:

  • movable — true when Move Line to Configured Product would move it.
  • reason, code, fix — why not (all null when movable), also as blocked: {code, reason, fix}.
  • target — {id, sku} of the configured product, or null when the configured SKU has no product yet.

Blocked lines stay on the base product and carry relinkable: false, blocked: {code, reason, fix}, and the same values flat as blocked_code, blocked_reason and blocked_fix (blocked is null on a line that can move). reason is a plain sentence to show a person; code is stable for your own handling; fix is what can be offered: repair_totals (Resync Sales Order Totals can put the order's saved tax back in step, then retry), open_order (it has to be sorted out on the sales order itself) or null (nothing safe to offer).

Codes:

  • shipped — "Already picked or fulfilled"
  • manufacturing_order — "Has a manufacturing order"
  • stock_allocated — "Stock already allocated or moved"
  • split — "Is split across warehouses"
  • cancelled_or_returned — "Has cancelled, returned or externally fulfilled units"
  • shipped_on_channel — "Shipped by the channel before it was mapped"
  • credit — "Has a sales credit"
  • invoiced — "Billed on an issued or voided invoice"
  • decorations — "Has decoration details"
  • fulfillment_at_provider — "Order has a fulfillment waiting at its provider"
  • dropship — "Order has a dropship purchase order"
  • stale_tax — "Order totals are out of date"; fix is repair_totals when that repair is safe for the order, otherwise null.
  • move_refused — the move itself was refused, with the reason (for example it would change the order's total, discount or tax, or "This line changed while it was being moved."); fix is open_order.
  • move_failed — the move raised an error and was rolled back; reason starts "Could not be moved:" and fix is null. Run the re-link again to retry.

Checking a single line can also return (always with fix null): no_configured_sku ("This line carries no configured SKU."), not_mapped ("Map or create <configured SKU> first."), product_archived ("<SKU> is archived."), already_moved ("This line is already on <SKU>."), not_on_base ("This line is not on the base product."), order_closed ("The order is closed or cancelled."), fully_fulfilled ("This line is already fully shipped.") and uses_base ("This configured SKU uses the base product, so there's nothing to move.").

Returns 404 when the line does not exist or line options are switched off.

Request​

Responses​

OK

Response Headers
    Content-Type