Skip to main content

archiveOrder

Archives an order: it is hidden from lists and analytics, and integrations recognize it and stop re-importing it. Unlike deletion, the order is retained and its identity is preserved.

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 synchronously. See bulkArchiveOrders for the bulk, asynchronous behavior.

Business Rules​

  • The order must exist within the current company.
  • The order must not already be archived.
  • Rejected if the order has a fulfillment in progress at an integration/WMS; resolve it upstream first.

Error Scenarios​

  • **NOT_FOUND**: when the order does not exist.
  • **BAD_REQUEST**: when the order is already archived or has an in-progress integration fulfillment.

Permissions Required​

  • orders:archive_order permission
archiveOrder(
  input: ArchiveOrderInput!
): StatusResponse

Arguments​

archiveOrder.input ● ArchiveOrderInput! non-null input common​

Parameters for ArchiveOrder

Type​

StatusResponse object common​

The response of a mutation that only returns a status