Skip to content
arch-lab
View
Demo
Syntax
Validate
MCP
Beta
Editor
Customer API
Every field the customer endpoints return, what it means, and where it comes from
Open in the playground
Customer API
Customer
REST payload
FIELD
TYPE
RULES
MEANING
SOURCE
id
uuid
required
unique
Stable identifier. Never
reused, so a deleted
customer's id stays dead.
accounts.customer.id
Values: RFC 4122
e.g. 9f2a1c3e-1c2f-4b6a-9c1e-0f2a1c3e4b5a
email
string
required
unique
pii
Lowercased on write, which
is what lets it be a unique
key. Verified before an
order may be placed.
accounts.customer.email
Values: RFC 5322
display_name
string
What the customer asked to
be called. Free text — do
not parse it into first and
last.
accounts.customer.display_name
lifetime_value
decimal(10,2)
derived
Sum of settled orders.
Recomputed nightly, so it
lags a same-day order by up
to 24 hours.
warehouse.customer_ltv
e.g. 1284.50
legacy_crm_ref
string
deprecated
The pre-2024 identifier.
Still written for the
reporting export; read
nothing new from it.
crm.contact_ref
Order summary
REST payload
FIELD
TYPE
RULES
MEANING
SOURCE
id
uuid
required
unique
The order's own identifier.
orders.order.id
status
string
required
Where the order is in its
lifecycle.
Values: one of draft | sent | paid | refunded
e.g. paid
placed_at
timestamptz
required
When the customer confirmed,
not when the payment
settled.
orders.order.placed_at
Fit