Skip to main content

supplyArchivePurchaseOrders

Archives one or more purchase orders.

This mutation processes archiving asynchronously in the background. The response includes a process ID that can be used to track the operation status.

Authentication​

Requires the supply:delete_po permission.

Asynchronous Processing​

Since this operation can affect multiple purchase orders, it runs in the background. If any purchase order fails to archive, you will receive a notification with details about which orders could not be archived and the reasons.

Business Rules​

  • Purchase orders must exist and belong to your brand.
  • Purchase orders cannot be archived if they were already archived previously.

Possible Errors​

  • **At least one Purchase Order must be specified**: The ids array cannot be empty.
  • **Purchase Order not found**: One or more specified purchase orders do not exist.
  • **Purchase Order does not belong to this brand**: One or more purchase orders belong to a different brand.
  • **Purchase Order was already archived**: One or more purchase orders were previously archived.
supplyArchivePurchaseOrders(
  input: ArchivePurchaseOrdersInput!
): AsynchronousActionResponse

Arguments​

supplyArchivePurchaseOrders.input ● ArchivePurchaseOrdersInput! non-null input​

Parameters for ArchivePurchaseOrders

Type​

AsynchronousActionResponse object​

Asynchronous action response type