Skip to main content
POST
/
commerce
/
customer
/
accounts
/
Bulk
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

​
responseFields
string

limits which fields are returned in the response body

Body

application/json
​
account
object

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.

​
password
string | null
​
externalPassword
string | null
​
isImport
boolean
​
fingerprint
string | null

Specifies the fingerprint of the user for two-factor authentication.

​
region
string | null

Specifies the region of the user for two-factor authentication.

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