Skip to main content

Split Fulfillment Order

POST 
/api/fulfillment-orders/:fulfillmentOrder/split

Manually carve an unsubmitted (proforma) FulfillmentOrder into a NEW open/unsubmitted FO sized to the supplied per-line quantities. The original FO keeps the remainder. This is pure FulfillmentOrderLine budget redistribution — neither FO is submitted as a result (split and submit are separate concerns). To dispatch part of an order, split it then submit/hold each piece.

Required scope: orders:write

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

Only valid while the FO is open + unsubmitted, or open + rejected (a provider rejection leaves no carrier order behind, so removing a line to re-submit the rest is still a pre-dispatch edit). Allocations are SOL-linked, so no allocation moves on a split.

Request body

  • lines (required, array, min 1): the quantities to carve into the new FO.
    • lines[].sales_order_line_id (required, integer, exists) — a SOL present on this FO.
    • lines[].quantity (required, integer, min 1) — must not exceed the FOL's remaining_quantity, and must not carve the FO's entire remaining budget (that would leave nothing behind — submit/fulfill the whole FO instead).

Responses

  • 201 — the NEW carved FO (open/unsubmitted).
  • 422 — a quantity exceeds the FOL remaining budget, or validation failed.
  • 409 — the FO is not open + unsubmitted/rejected, or the request would carve the entire FO (nothing left to split).

Required permission: fulfillment_orders.update (Fulfillment Orders → Edit) and fulfillment_orders.index (Fulfillment Orders → View). A token also needs its orders scope; the owner needs these role permissions.

Request​

Responses​

Created

Response Headers
    Content-Type