customers Query

List of the shop's customers. This list includes all users who registered through the accountRegister mutation. Additionally, staff users who have placed an order using their account will also appear in this list.

Requires one of the following permissions: MANAGE_ORDERSMANAGE_USERS

customers(
  filter: CustomerFilterInput
  where: CustomerWhereInput
  sortBy: UserSortingInput
  search: String
  before: String
  after: String
  first: Int
  last: Int
): UserCountableConnection

Details

type UserCountableConnection {
  pageInfo: PageInfo!
  edges: [UserCountableEdge!]!
  totalCount: Int
}

Arguments

where ● CustomerWhereInput

Where filtering options for customers.

Added in Saleor 3.22

sortBy ● UserSortingInput

Sort customers.

search ● String

Search customers.

Added in Saleor 3.22

before ● String

Return the elements in the list that come before the specified cursor.

after ● String

Return the elements in the list that come after the specified cursor.

first ● Int

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last ● Int

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

Show deprecatedHide deprecated

filter ● CustomerFilterInput

DEPRECATED

Use where filter instead.

Filtering options for customers.

Type

UserCountableConnection