GET
/
customers
/
{customerId}
curl --request GET \
  --url https://api.fabric.inc/v3/customers/{customerId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "61df41892bf06d00092d0d8a",
  "name": {
    "title": "Dr.",
    "firstName": "Pat",
    "middleName": "E",
    "lastName": "Doe",
    "suffix": "Jr."
  },
  "status": "ACTIVE",
  "emailAddress": "test@example.com",
  "phone": {
    "number": 15555551234,
    "type": "MOBILE"
  },
  "externalId": "1231012312-312-31231asda",
  "additionalAttributes": {
    "middleName": "user"
  },
  "isDeleted": true,
  "deletedAt": "2023-08-30T23:20:42.822Z",
  "createdAt": "2023-08-30T23:20:42.822Z",
  "updatedAt": "2023-08-30T23:20:42.822Z",
  "defaultAddress": [
    {
      "id": "61604a30fdfacd0009816e44",
      "address": {
        "addressLine1": "123 Main St.",
        "addressLine2": "Suite 100",
        "addressLine3": "Seventh floor",
        "addressLine4": "Attention: Pat E. Doe",
        "city": "Seattle",
        "region": "WA",
        "postalCode": 98121,
        "county": "King County",
        "country": "US",
        "type": "BILLING",
        "latitude": 47.6205,
        "longitude": -122.3493
      },
      "additionalAttributes": {
        "landmark": "Beach"
      },
      "isDeleted": true,
      "isDefault": true,
      "deletedAt": "2023-08-30T23:20:42.822Z",
      "createdAt": "2023-08-30T23:20:42.822Z",
      "updatedAt": "2023-08-30T23:20:42.822Z"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

The access token.

Headers

x-fabric-tenant-id
string

The merchant's 24-character tenant ID.

x-fabric-request-id
string

A unique UUID of the request.

Path Parameters

customerId
string
required

A 24-character system-generated ID of the customer. This is returned in the response of the POST /customers endpoint.

Response

200 - application/json
id
string
required

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

name
object
required

The full name of the customer.

status
enum<string>

The account status of the customer.

Available options:
ACTIVE,
INACTIVE,
BLOCKED
emailAddress
string
required

The customer's email.

phone
object
externalId
string

A unique UUID of the customer. Using this ID, merchants using fabric’s Shopper Identity service can offer self-serve APIs to their customers. Using these APIs, customers can manage their own data through the Copilot UI.

additionalAttributes
object

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

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.

deletedAt
string | null

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

createdAt
string
required

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

updatedAt
string | null
required

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

defaultAddress
object[]

The default addresses of the customer.

Was this page helpful?

Checkout FAQ(s)Search for customer