CustomerFilterInput

Filtering options for customers.

input CustomerFilterInput {
  archiveStatus: CustomerArchiveStatusEnum
  brandIds: [ID!] @deprecated
  customerType: CustomerTypeEnum
  keyword: String
  parentCandidates: Boolean
  parentId: ID
  retailer: Boolean @deprecated
  salesChannelIds: [ID!]
  sortField: CustomerSortFieldEnum
  sortType: SortTypeEnum
}

Fields

CustomerFilterInput.archiveStatus ● CustomerArchiveStatusEnum enum common

Filter by whether the customer is active, archived, or both. Defaults to active.

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.customerType ● CustomerTypeEnum enum people

Filter customers by the kind of buying entity.

CustomerFilterInput.keyword ● String scalar common

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

CustomerFilterInput.parentCandidates ● Boolean scalar common

When true, return only active top-level customers eligible to be parents.

CustomerFilterInput.parentId ● ID scalar common

Filter customers to the direct children of the given parent customer.

CustomerFilterInput.retailer ● Boolean deprecated scalar common

DEPRECATED

Use customerType instead. Maps to customerType BUSINESS (true) or INDIVIDUAL (false).

Filter customers by retailer status.

CustomerFilterInput.salesChannelIds ● [ID!] list scalar common

Filter customers by their home sales channels.

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