Skip to main content
GET
/
commerce
/
customer
/
accounts
/
{accountId}
Error
A valid request URL is required to generate request examples
{
  "id": 123,
  "customerSet": "<string>",
  "commerceSummary": {
    "totalOrderAmount": {
      "currencyCode": "<string>",
      "amount": 123
    },
    "orderCount": 123,
    "lastOrderDate": "2023-11-07T05:31:56Z",
    "wishlistCount": 123,
    "visitsCount": 123
  },
  "contacts": [
    {
      "accountId": 123,
      "types": [
        {
          "name": "<string>",
          "isPrimary": true
        }
      ],
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "faxNumber": "<string>",
      "label": "<string>",
      "id": 123,
      "email": "<string>",
      "firstName": "<string>",
      "middleNameOrInitial": "<string>",
      "lastNameOrSurname": "<string>",
      "companyOrOrganization": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "cityOrTown": "<string>",
        "stateOrProvince": "<string>",
        "postalOrZipCode": "<string>",
        "countryCode": "<string>",
        "addressType": "<string>",
        "isValidated": true
      }
    }
  ],
  "companyOrOrganization": "<string>",
  "notes": [
    {
      "id": 123,
      "content": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "attributes": [
    {
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "fullyQualifiedName": "<string>",
      "attributeDefinitionId": 123,
      "values": [
        "<unknown>"
      ]
    }
  ],
  "segments": [
    {
      "id": 123,
      "code": "<string>",
      "name": "<string>",
      "description": "<string>",
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      }
    }
  ],
  "taxExempt": true,
  "taxId": "<string>",
  "externalId": "<string>",
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "customerSinceDate": "2023-11-07T05:31:56Z",
  "accountType": "<string>",
  "migrationRequired": true,
  "emailAddress": "<string>",
  "userName": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "localeCode": "<string>",
  "userId": "<string>",
  "isAnonymous": true,
  "isLocked": true,
  "isActive": true,
  "acceptsMarketing": true,
  "hasExternalPassword": true,
  "last2FaDate": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
accountId
integer<int32>
required

Unique identifier of the customer account whose details you want to retrieve.

Query Parameters

​
responseGroups
string
​
userId
string
​
responseFields
string

limits which fields are returned in the response body

Response

Success

Customer account. Customers provide contact information, view order history, and set email preferences on their account. Merchants can edit accounts to add internal notes or assign them to segments.

​
id
integer<int32>

Unique identifier of the account, also known as a customer number.

​
customerSet
string | null
​
commerceSummary
object

Commerce (orders and wishlists) on a customer account which lists all the orders the customer has made with the order date, order amount, and status. Includes cancellations and returns. Also includes wishlist information.

​
contacts
object[] | null

List of contacts for this account. A customer account can have multiple contacts for billing and shipping addresses.

​
companyOrOrganization
string | null

The company or organization name for an account.

​
notes
object[] | null

List of notes for the account. Merchants use these internal notes, for example, to make a note of a customer's interests or complaints. Notes are available only from the merchant's view, customers cannot view these notes.

​
attributes
object[] | null

List of attributes for the account.

​
segments
object[] | null

List of segments assigned to account. Merchants create segments, for example, to manage discounts or assign VIP status. Then they assign the account to the segment. An account can belong to several segments or none at all.

​
taxExempt
boolean
​
taxId
string | null
​
externalId
string | null
​
auditInfo
object
​
customerSinceDate
string<date-time> | null

Date when the customer account is created.

​
accountType
string | null

Type of account.

​
migrationRequired
boolean

Indicates Subscription migration is required or not.

​
emailAddress
string | null

"Email addresss of the customer.

​
userName
string | null

User name for the customer account.

​
firstName
string | null

First name of the customer.

​
lastName
string | null

Last name of the customer.

​
localeCode
string | null

Locale Code.

​
userId
string | null

Unique identifier of the user who is currently logged in. This is null if the user is anonymous (not logged in). Unicode data with a maximum length of 55 characters.

​
isAnonymous
boolean

Is the account Anonymous?

​
isLocked
boolean

Is the account locked?

​
isActive
boolean

Is the account active?

​
acceptsMarketing
boolean

If true, the customer prefers to receive marketing material such as newsletters or email offers.

​
hasExternalPassword
boolean

Indicates if an external password is set on this account

​
last2FaDate
string<date-time> | null