Skip to main content

CustomerFilterInput

Filtering options for customers.

input CustomerFilterInput {
  brandIds: [ID!] @deprecated
  keyword: String
  retailer: Boolean
  sortField: CustomerSortFieldEnum
  sortType: SortTypeEnum
}

Fields​

CustomerFilterInput.brandIds ● [ID!] deprecated list scalar common​

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Use company context instead.

Filter customers by brand ID.

CustomerFilterInput.keyword ● String scalar common​

Search customers by keyword. You can use | to search by multiple keywords.

CustomerFilterInput.retailer ● Boolean scalar common​

Filter customers by retailer status.

CustomerFilterInput.sortField ● CustomerSortFieldEnum enum people​

Field to sort the customers by.

CustomerFilterInput.sortType ● SortTypeEnum enum common​

Type of sort (ASC or DESC).

Member Of​

customers query