Skip to main content

CustomerSummary

Summary view of a customer account, returned in list endpoints.

idstring

Unique identifier for the customer.

Example: 4021
namestring

Display name of the customer.

Example: Sunrise Craft Beverages
codestring

Short alphanumeric code for quick reference (e.g., on printed documents or internal lookups).

Example: SUNRISE
companyNamestring

Legal company name, if different from the display name.

emailstring<email>

Primary email address for the customer account.

phonestring

Primary phone number for the customer account.

CustomerSummary
{
"id": "4021",
"name": "Sunrise Craft Beverages",
"code": "SUNRISE",
"companyName": "string",
"email": "user@example.com",
"phone": "string"
}