Skip to main content
Version: 3.x

customers

List of the shop's customers.

Requires one of the following permissions: MANAGE_ORDERSMANAGE_USERS
customers(
  filter: CustomerFilterInput
  sortBy: UserSortingInput
  before: String
  after: String
  first: Int
  last: Int
): UserCountableConnection

Arguments​

customers.filter ● CustomerFilterInput input​

Filtering options for customers.

customers.sortBy ● UserSortingInput input​

Sort customers.

customers.before ● String scalar​

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

customers.after ● String scalar​

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

customers.first ● Int scalar​

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

customers.last ● Int scalar​

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

Type​

UserCountableConnection object​

Was this page helpful?