Bulk Unarchive Sales Orders

PUT 
/api/sales-orders/unarchive

Restores multiple archived sales orders at once (clears each order's archived timestamp so it reappears in active lists).

Required scope: orders:write

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

Authentication: Requires Bearer token.

Request body (one of ids or filters is required):

• ids (array of integers, required without filters, min 1): Sales order IDs; each must exist.
• filters (required without ids): Filter payload resolved against the sales-orders list — accepts the grouped filter_groups shape (base64-encoded JSON, same as the V2 sales-orders list) as well as the legacy JSON-string filter set.

When targeting by filters, only currently archived matching orders are processed.

Behavior:

• Orders that are not archived are skipped and reported under warnings, keyed by ids.{id}.id.
• The message reports {unarchived}/{total} counts. If every targeted order was already active, the message is "The sales orders are already un archived".

Requires permission: sales_orders.update

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.