Interface: CustomerSearchArguments

Defined in: type/CustomerSearchArguments.ts:8

Input object for CustomerSearchArguments

Properties

createdAt?

optional createdAt?: DateSearchInput

Defined in: type/CustomerSearchArguments.ts:30

Search by date created

---

customerIds?

optional customerIds?: number[]

Defined in: type/CustomerSearchArguments.ts:10

List of unique customer ids

---

email?

optional email?: string

Defined in: type/CustomerSearchArguments.ts:18

Customer's email

---

firstName?

optional firstName?: string

Defined in: type/CustomerSearchArguments.ts:12

Customer's first name

---

gender?

optional gender?: Gender

Defined in: type/CustomerSearchArguments.ts:20

Customer's gender

---

lastModifiedAt?

optional lastModifiedAt?: DateSearchInput

Defined in: type/CustomerSearchArguments.ts:28

Search by date changed

---

lastName?

optional lastName?: string

Defined in: type/CustomerSearchArguments.ts:16

Customer's last name

---

middleName?

optional middleName?: string

Defined in: type/CustomerSearchArguments.ts:14

Customer's middle name

---

offset?

optional offset?: number

Defined in: type/CustomerSearchArguments.ts:24

offset input field

---

page?

optional page?: number

Defined in: type/CustomerSearchArguments.ts:22

page input field

---

sort?

optional sort?: CustomerSortInput[]

Defined in: type/CustomerSearchArguments.ts:26

List of customer sort filters

---

term?

optional term?: string

Defined in: type/CustomerSearchArguments.ts:33

Free-text search term matched as a case-insensitive substring across the customer's own fields. The *_ID fields match by exact id (numeric terms only). Restrict the searched fields with termFields. Multi-word terms must all match (AND). Each token must be at least 3 characters, or a numeric id.

---

termFields?

optional termFields?: CustomerTermField[]

Defined in: type/CustomerSearchArguments.ts:35

Fields the term searches. Text fields match by case-insensitive substring; the *_ID fields match by exact id (numeric terms only). When omitted, the customer's own fields are searched.