Send Held Fulfillment Order Anyway
POST/api/fulfillment-orders/:fulfillmentOrder/duplicate-hold/override
Sends a fulfillment order that is held as a possible duplicate (or held by a provider cutover) to its provider anyway, e.g. a deliberate replacement shipment. Records who overrode the hold, when and why, adds a sales order note, releases the hold and submits the fulfillment order. The duplicate check never re-trips on the provider order this override waives; a different matching provider order still holds it.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body:
reason(string, required, 10–500 characters)acknowledge_open_channel_fulfillment(boolean, optional) — dispatch even though an open sales-channel fulfillment still covers the lines
Errors: 422 for a missing/short reason or a fulfillment order that is not held or already sent; 409 when open sales-channel coverage needs acknowledging (requires_acknowledgement: true) or the order cannot be submitted.
Hold payload on every fulfillment order: duplicate_hold is null when the order is not held, else { at, strength (strong|possible), provider_order_index_id, candidate } where candidate has the shape returned by List Duplicate Candidates. cutover_hold is null or { hold: pre_boundary|awaiting_native_order, at }. duplicate_override is null or { at, by (user id), reason, provider_order_index_id }.
Required permission: fulfillment_orders.submit and fulfillment_orders.index. A token also needs its orders scope.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.