Get customer details - customer context

Using this endpoint, a customer can view their details through the storefront UI.

Authorizations

Authorization

string

header

required

The access token.

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id

string

Unique request ID

Response

200 - application/json

createdAt

string

required

The time when the customer was added to the system, in UTC format.

emailAddress

string

required

The customer's email.

id

string

required

A 24-character system-generated ID of the customer.

isDeleted

boolean

required

A flag indicating whether the customer's record is deleted. true indicates, the customer's record is deleted and false indicates otherwise.

name

object

required

The full name of the customer.

Show child attributes

name.firstName

string

required

The customer's first name.

name.lastName

string

required

The customer's last name.

name.middleName

string

The customer's middle name.

name.suffix

string

The suffix for the customer's name, such as Jr., PhD, and more.

name.title

string

The customer's title, such as Mr., Mrs, and Dr.

updatedAt

string | null

required

The time when the customer data was last updated, in UTC format.

additionalAttributes

object

A placeholder for additional info, in key-value pairs.

defaultAddress

object[]

The default addresses of the customer.

Show child attributes

defaultAddress.address

object

required

The address details.

Show child attributes

defaultAddress.address.type

enum<string>

required

The address type.

Available options:

BILLING,

SHIPPING

defaultAddress.address.addressLine1

string

The first line of the address.

defaultAddress.address.addressLine2

string

The second line of the address.

defaultAddress.address.addressLine3

string

The third line of the address.

defaultAddress.address.addressLine4

string

The fourth line of the address.

defaultAddress.address.city

string

The city name in the address.

defaultAddress.address.country

string

The country code, which can be a full name, or an ISO 3166-1 alpha-2 or alpha-3 code.

defaultAddress.address.county

string

The administrative division or county within a country or state.

defaultAddress.address.latitude

number

The geographical latitude used with longitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

defaultAddress.address.longitude

number

The geographical longitude used with latitude to locate the exact address. The coordinates are provided in decimal degrees format, with negative values indicating locations to the west.

defaultAddress.address.postalCode

string

The postal or ZIP code of the address.

defaultAddress.address.region

string

The region or state name in the address.

defaultAddress.createdAt

string

required

The time when the address was created, in UTC format.

defaultAddress.id

string

required

A 24-character system-generated ID of the address.

defaultAddress.isDeleted

boolean

required

A flag indicating whether the address is deleted. true indicates the address is deleted and false indicates otherwise.

defaultAddress.updatedAt

string | null

required

The time when the address was the last updated, in UTC format.

defaultAddress.additionalAttributes

object

A placeholder for additional info, in key-value pairs.

defaultAddress.deletedAt

string | null

The time when the address was deleted, in UTC format.

defaultAddress.isDefault

boolean

A flag indicating whether the address is the default one.true indicates the given address is the default address and false indicates otherwise.

deletedAt

string | null

The time when the customer's record was deleted, in UTC format.

externalId

string

A UUID of the customer.

phone

object

Show child attributes

phone.number

string

The customer's phone number.

phone.type

enum<string> | null

The type of phone number.

Available options:

MOBILE,

HOME,

BUSINESS

status

enum<string>

The account status of the customer.

Available options:

ACTIVE,

INACTIVE,

BLOCKED