FilterableCustomerProps

The filters to apply on the retrieved customer.

qstringOptional

Searches for customers by properties such as name and email using this search term.

idstring | string[]Optional

The IDs to filter the customer by.

emailstring | string[] | OperatorMap<string>Optional

Filter by email.

groupsstring | string[] | FilterableCustomerGroupPropsOptional

Filter by associated customer group.

default_billing_address_idnull | string | string[]Optional

Filter by the associated default billing address's ID.

default_shipping_address_idnull | string | string[]Optional

Filter by the associated default shipping address's ID.

company_namenull | string | string[] | OperatorMap<string>Optional

Filter by company name.

first_namenull | string | string[] | OperatorMap<string>Optional

Filter by first name.

last_namenull | string | string[] | OperatorMap<string>Optional

Filter by last name.

has_accountboolean | OperatorMap<boolean>Optional

Filter by whether the customer has an account.

created_bynull | string | string[]Optional

Filter by the created_by attribute.

created_atOperatorMap<string>Optional

Filter by created date.

updated_atOperatorMap<string>Optional

Filter by updated date.

An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.

An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.

Was this page helpful?