RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Merchant API

customer

A customer in the shop directory.

Returned by Merchant API customer endpoints. Used by POS customer attach and Admin → Customers.

Exposure

Returned by Merchant API list/detail routes for this resource.

What

The customer object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

9 fields on customer. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Unique customer id.

Type
id: string

email

string | null

Customer email.

Type
email: string | null

firstName

string | null

First name.

Type
firstName: string | null

lastName

string | null

Last name.

Type
lastName: string | null

phone

string | null

Phone number.

Type
phone: string | null

storeCreditBalance

number

Store credit balance (detail response).

Type
storeCreditBalance: number

_count

object

Aggregates such as `{ orders: number }` on detail responses.

Type
_count: object

createdAt

string

ISO-8601 created timestamp.

Type
createdAt: string

updatedAt

string

ISO-8601 updated timestamp.

Type
updatedAt: string

Related