Customer resource - Developer documentation

{
  "id": "7654321",
  "resource": "customer",
  "displayName": "Jane Smith",
  "email": "[email protected]",
  "phone": "+15550100"
}

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

Field	Description	Type
id	The customer identifier	string
displayName	The customer full name	string
email	The customer contact email	string
phone	The customer contact phone	string

Reference

string

required

Customer ID (numeric string).

Minimum string length: 1

Example:

"7654321"

resource

enum<string>

required

Available options:

customer

displayName

string

required

Customer's full name.

Minimum string length: 1

Example:

"Jane Smith"

null | string<email>

required

Customer's contact email.

Example:

"[email protected]"

phone

null | string

required

Customer's contact phone number in E.164 format.

Minimum string length: 1

Example:

"+15550100"

Introduction List customers

⌘I

​Search query fields

​Reference

Search query fields

Reference