Skip to main content

bulkArchiveOrders

Archives a batch of orders: each is hidden from lists and analytics, and integrations stop re-importing it. The orders are retained (not deleted). For each order, any live fulfillment (allocated, ready, in_progress, or failed_to_fulfill) is reverted to draft to release its local inventory reservation before the order is hidden.

Runs asynchronously: returns a process_id immediately and reports the outcome through the process_status_updates subscription. A background job archives each order independently — a not-found order counts as a skip, and a failed one is recorded without stopping the rest. See archiveOrder for the single-order behavior.

Requirements​

  • User must have orders:archive_order permission
bulkArchiveOrders(
input: BulkArchiveOrdersInput!
): AsynchronousActionResponse!

Arguments​

bulkArchiveOrders.input ● BulkArchiveOrdersInput! non-null input common​

Parameters for BulkArchiveOrders

Type​

AsynchronousActionResponse object common​

Asynchronous action response type