Skip to main content
The Customer object serves multiple purposes, including storing billing and shipping information, creating order schedules, applying discounts, and authenticating customers in Customer Portal.

Search query fields

FieldDescriptionType
idThe customer identifierstring
displayNameThe customer full namestring
emailThe customer contact emailstring
phoneThe customer contact phonestring

Reference

id
string
required
Minimum string length: 1
resource
enum<string>
required
Available options:
customer
displayName
string
required

Customer's full name.

Minimum string length: 1
email
null | string<email>
required

Customer's contact email.

phone
null | string
required

Customer's contact phone.

Minimum string length: 1