Bulk Archive Fulfillments

PUT 
/api/sales-order-fulfillments/archive

Archive multiple fulfillments at once. Archived fulfillments are hidden from default list results but remain retrievable.

Required scope: orders:write

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

Body — either:

• ids (array of integers) — explicit fulfillment IDs; or
• apply_to_all: true with an optional filters object — archives every fulfillment matching the filters. The filters object accepts the same keys as the fulfillment list filters, e.g. {"fulfillment_type": "manual", "voided": "exclude", "packing_slip_printed": "no", "integration_instance_ids": "1,2", "search": "SO-10412"}.

The response is always HTTP 200; check the JSON status field. Already-archived records are reported per ID under warnings and the overall status becomes warning.

Requires the orders:write token scope.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.