Customer

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

type Customer implements Node {
  id: ID!
  groupId: ID!
  salesChannelId: ID!
  customerNumber: String!
  firstName: String!
  lastName: String!
  company: String
  email: String!
  title: String
  active: Boolean
  guest: Boolean
  createdAt: DateTime!
  updatedAt: DateTime
  accountType: CustomerAccountType!
  vatIds: JSON
  group: CustomerGroup
  salesChannel: SalesChannel
  lastPaymentMethod: PaymentMethod
  salutation: Salutation
  tags(
    first: Int = 10
    after: String
    filter: TagFilterInput
  ): TagConnection
  requestedGroup: CustomerGroup
  boundSalesChannel: SalesChannel
  defaultPaymentMethod: PaymentMethod
  orders(
    first: Int = 10
    after: String
  ): OrderConnection
}

Fields

Customer.id ● ID! non-null scalar

Global identifier for this entity.

Customer.groupId ● ID! non-null scalar

ID of the customer group the customer is assigned to.

Customer.salesChannelId ● ID! non-null scalar

ID of the sales channel the customer registered in.

Customer.customerNumber ● String! non-null scalar

Human-readable customer number assigned at registration.

Customer.firstName ● String! non-null scalar

Customer's first name.

Customer.lastName ● String! non-null scalar

Customer's last name.

Customer.company ● String scalar

Company name. Set for business customers.

Customer.email ● String! non-null scalar

Customer's email address. Unique per sales channel and bound-sales-channel scope.

Customer.title ● String scalar

Optional academic or honorific title (e.g. Dr.).

Customer.active ● Boolean scalar

Whether the customer account is active.

Customer.guest ● Boolean scalar

Whether this is a guest account (created during guest checkout, no login).

Customer.createdAt ● DateTime! non-null scalar

Timestamp the customer was created.

Customer.updatedAt ● DateTime scalar

Timestamp of the last update to the customer.

Customer.accountType ● CustomerAccountType! non-null enum

Customer type. Either Private or Business.

Customer.vatIds ● JSON scalar

List of VAT registration IDs of the customer, as a JSON array of strings.

Customer.group ● CustomerGroup object

Customer.salesChannel ● SalesChannel object

Customer.lastPaymentMethod ● PaymentMethod object

Customer.salutation ● Salutation object

Customer.tags ● TagConnection object

Customer.tags.first ● Int scalar

Customer.tags.after ● String scalar

Customer.tags.filter ● TagFilterInput input

Customer.requestedGroup ● CustomerGroup object

Customer.boundSalesChannel ● SalesChannel object

Customer.defaultPaymentMethod ● PaymentMethod object

Customer.orders ● OrderConnection object

Customer.orders.first ● Int scalar

Customer.orders.after ● String scalar

Interfaces

Node interface

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By

createCustomer mutation ● customer query

Member Of

CustomerEdge object ● GoodsReceipt object