Skip to main content

updateCustomerNumber

Changes the customer number of an existing customer, e.g. to the number the customer holds in a POS, accounting or legacy system. Fails with CONFLICT when another customer already holds the number. Returns the updated customer.

Required scopes​

The token needs the customers:write access scope.

updateCustomerNumber(
id: ID!
customerNumber: String!
): Customer!

Arguments​

updateCustomerNumber.id ● ID! non-null scalar​

ID of the customer to update.

updateCustomerNumber.customerNumber ● String! non-null scalar​

New customer number. Must not be held by another customer.

Type​

Customer object​

A customer of the shop. Carries identity and contact details, the assigned customer group and sales channel, and the customer's order history.