FilterableCustomerProps

The filters to apply on the retrieved customer.

idstring | string[]

The IDs to filter the customer by.

emailstring | string[] | OperatorMap<string>

Filter by email.

groupsstring | string[] | FilterableCustomerGroupProps

Filter by associated customer group.

default_billing_address_idnull | string | string[]

Filter by the associated default billing address's ID.

default_shipping_address_idnull | string | string[]

Filter by the associated default shipping address's ID.

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

Filter by company name.

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

Filter by first name.

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

Filter by last name.

has_accountboolean | OperatorMap<boolean>

Filter by whether the customer has an account.

created_bynull | string | string[]

Filter by the created_by attribute.

created_atOperatorMap<string>

Filter by created date.

updated_atOperatorMap<string>

Filter by updated date.

$and(FilterableCustomerProps | BaseFilterable<FilterableCustomerProps>)[]

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

$or(FilterableCustomerProps | BaseFilterable<FilterableCustomerProps>)[]

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