Skip to main content
GET
/
commerce
/
customer
/
accounts
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "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.

Query Parameters

​
startIndex
integer<int32>
default:0

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.

For example, applications can filter on UserId to get the single record of the current customer.
​
pageSize
integer<int32>
default:0

We added this test to demo new publishing @test@. Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.

​
sortBy
string

The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

​
filter
string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

​
fields
string
​
q
string

a quick filter which will search a predefined set of fields for a match

​
qLimit
integer<int32>
​
isAnonymous
boolean
​
responseGroups
string

Used to refine the default information returned from a request. To reduce amount of customer account information returned, use the valid response groups: Contacts, CustomerAccountNotes, and OrderSummary. Optional.

​
responseFields
string

limits which fields are returned in the response body

Response

Success

Collection of all the merchant's customers returned as a whole. A collection is not paged.

​
startIndex
integer<int32>
​
pageSize
integer<int32>
​
pageCount
integer<int32>
​
totalCount
integer<int32>
​
items
object[] | null