FilterableCustomerAddressProps

The filters to apply on the retrieved customer address.

idstring | string[]

The IDs to filter the customer address by.

address_namestring | OperatorMap<string>

Filter addresses by name.

is_default_shippingboolean | OperatorMap<boolean>

Filter addresses by whether they're the default for shipping.

is_default_billingboolean | OperatorMap<boolean>

Filter addresses by whether they're the default for billing.

customer_idstring | string[]

Filter addresses by the associated customer's ID.

customerstring | string[] | FilterableCustomerProps

Filter addresses by the associated customer.

companystring | OperatorMap<string>

Filter addresses by company.

first_namestring | OperatorMap<string>

Filter addresses by first name.

last_namestring | OperatorMap<string>

Filter addresses by last name.

address_1string | OperatorMap<string>

Filter addresses by first address line.

address_2string | OperatorMap<string>

Filter addresses by second address line.

citystring | OperatorMap<string>

Filter addresses by city.

country_codestring | OperatorMap<string>

Filter addresses by country code.

provincestring | OperatorMap<string>

Filter addresses by province.

postal_codestring | OperatorMap<string>

Filter addresses by postal code.

phonestring | OperatorMap<string>

Filter addresses by phone number.

metadataRecord<string, unknown> | OperatorMap<Record<string, unknown>>

Holds custom data in key-value pairs.

created_atOperatorMap<string>

Filter addresses by created date.

updated_atOperatorMap<string>

Filter addresses by updated date.

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

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

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

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