Skip to main content

archiveCustomer

Archive a customer. Archived customers are hidden from customer lists by default but stay reachable from their orders, prices, and mappings; they are never deleted.

Business Rules​

  • Archiving does not cascade: product identifiers, integration mappings and shipping accounts stay attached, so unarchiving restores the customer as it was.
  • A sales channel that carries this customer as its default keeps the assignment but stops stamping it onto new orders until the customer is unarchived.
  • A customer must be active to archive it again after restoring it.

Error Scenarios​

  • **NOT_FOUND**: the customer does not belong to this company.
  • **CONFLICT**: the customer is already archived.

Permissions Required​

  • customers:archive_customer permission.
archiveCustomer(
  input: ArchiveCustomerInput!
): ArchiveCustomerPayload

Arguments​

archiveCustomer.input ● ArchiveCustomerInput! non-null input common​

Parameters for ArchiveCustomer

Type​

ArchiveCustomerPayload object common​

Autogenerated return type of ArchiveCustomer.