Link Fulfillment Order to Provider Order
POST/api/fulfillment-orders/:fulfillmentOrder/duplicate-hold/link
Links a held fulfillment order to an order its provider already holds, instead of sending it again. The provider's shipment then closes the fulfillment order and records tracking and cost exactly as for an order SKU.io sent. The fulfillment order moves to submitted and its hold is cleared. Its order_reference then reports the provider's own order number (for example #5001), because that is the order the provider holds.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body: provider_order_index_id (integer, required) — must be one of the current candidates (see List Duplicate Candidates).
Errors: 422 when the id is missing or not a current candidate, when another fulfillment order linked that provider order first (links are serialized per provider order), when the fulfillment order was already sent or closed, or when it ships merged with other orders (unmerge first).
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.