Skip to main content

archiveProducts

Archive Products​

Archives the provided products. This operation is asynchronous and returns immediately with a processing status while the archiving occurs in the background.

Process Notifications​

Use the response processId to get notifications via processStatusSubscription subscription.

Process Tracking​

Use the processStatus query with the response processId to retrieve process status and progress. The completion percentage of the process can be extracted through the metadata of ProcessStatusPayload.

Example:​

{
  ...
  metadata: {
    completion_percentage: 50.0,
    succeeded_count: 10,
    failed_count: 3,
    total_count: 26
  }
}

Authentication & Permissions​

Requires authentication and the products:delete permission for the product's brand.

Possible Errors​

  • **Authentication error**: User not logged in or lacks required permissions
  • **Validation Error**: Payload exceeds the maximum allowed products per request.
archiveProducts(
  input: ArchiveProductsInput!
): AsynchronousActionResponse!

Arguments​

archiveProducts.input ● ArchiveProductsInput! non-null input​

Parameters for ArchiveProducts

Type​

AsynchronousActionResponse object​

Asynchronous action response type