Skip to main content

unarchiveCustomer

Restore an archived customer to active customer lists.

Business Rules​

  • Only archived customers can be restored.
  • Attached orders, prices, identifiers, mappings and shipping accounts remain unchanged.
  • Preserved sales channel default assignments resume applying to new orders.

Error Scenarios​

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

Permissions Required​

  • customers:archive_customer permission, matching customer archiving.
unarchiveCustomer(
  input: UnarchiveCustomerInput!
): UnarchiveCustomerPayload

Arguments​

unarchiveCustomer.input ● UnarchiveCustomerInput! non-null input common​

Parameters for UnarchiveCustomer

Type​

UnarchiveCustomerPayload object common​

Autogenerated return type of UnarchiveCustomer.