Skip to main content
POST
/
commerce
/
customer
/
authtickets
Error
A valid request URL is required to generate request examples
{
  "customerAccount": {
    "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"
  },
  "accessToken": "<string>",
  "accessTokenExpiration": "2023-11-07T05:31:56Z",
  "refreshToken": "<string>",
  "refreshTokenExpiration": "2023-11-07T05:31:56Z",
  "userId": "<string>",
  "jwtAccessToken": "<string>",
  "requires2FA": true
}

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

User's email address and password.

​
username
string | null
​
password
string | null
​
accountId
integer<int32> | null

Account Id specifies the account for which the user requests an authentication token.

​
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

​
customerAccount
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.

​
accessToken
string | null
​
accessTokenExpiration
string<date-time>
​
refreshToken
string | null
​
refreshTokenExpiration
string<date-time>
​
userId
string | null
​
jwtAccessToken
string | null
​
requires2FA
boolean