Error
A valid request URL is required to generate request examples{
"accessToken": "<string>",
"accessTokenExpiration": "2023-11-07T05:31:56Z",
"customerAccount": {
"acceptsMarketing": true,
"accountType": "<string>",
"attributes": [
{
"attributeCode": "<string>",
"displayGroup": "<string>",
"valueType": "<string>",
"adminName": "<string>",
"attributeFQN": "<string>",
"attributeMetadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableForDiscounts": true,
"availableForOrderRouting": true,
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"dataType": "<string>",
"id": 123,
"inputType": "<string>",
"isActive": true,
"isMultiValued": true,
"isReadOnly": true,
"isRequired": true,
"isVisible": true,
"namespace": "<string>",
"order": 123,
"validation": {
"maxDateTime": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateTime": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"vocabularyValues": [
{
"value": "<string>",
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"isHidden": true,
"sequence": 123
}
]
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"commerceSummary": {
"lastOrderDate": "2023-11-07T05:31:56Z",
"orderCount": 123,
"totalOrderAmount": {
"amount": 123,
"currencyCode": "<string>"
},
"visitsCount": 123,
"wishlistCount": 123
},
"companyOrOrganization": "<string>",
"contacts": [
{
"accountId": 123,
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"faxNumber": "<string>",
"firstName": "<string>",
"id": 123,
"label": "<string>",
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"types": [
{
"isPrimary": true,
"name": "<string>"
}
]
}
],
"customerSet": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"externalId": "<string>",
"firstName": "<string>",
"hasExternalPassword": true,
"id": 123,
"isActive": true,
"isAnonymous": true,
"isLocked": true,
"last2FaDate": "2023-11-07T05:31:56Z",
"lastName": "<string>",
"localeCode": "<string>",
"migrationRequired": true,
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"content": "<string>",
"id": 123
}
],
"segments": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"code": "<string>",
"description": "<string>",
"id": 123,
"name": "<string>"
}
],
"taxExempt": true,
"taxId": "<string>",
"userId": "<string>",
"userName": "<string>"
},
"jwtAccessToken": "<string>",
"refreshToken": "<string>",
"refreshTokenExpiration": "2023-11-07T05:31:56Z",
"requires2FA": true,
"userId": "<string>"
}Create Auth Ticket
Validates the 2FA details provided by the user and creates an authentication ticket
POST
/
commerce
/
customer
/
authtickets
/
2fa
/
auth
Error
A valid request URL is required to generate request examples{
"accessToken": "<string>",
"accessTokenExpiration": "2023-11-07T05:31:56Z",
"customerAccount": {
"acceptsMarketing": true,
"accountType": "<string>",
"attributes": [
{
"attributeCode": "<string>",
"displayGroup": "<string>",
"valueType": "<string>",
"adminName": "<string>",
"attributeFQN": "<string>",
"attributeMetadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"availableForDiscounts": true,
"availableForOrderRouting": true,
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"dataType": "<string>",
"id": 123,
"inputType": "<string>",
"isActive": true,
"isMultiValued": true,
"isReadOnly": true,
"isRequired": true,
"isVisible": true,
"namespace": "<string>",
"order": 123,
"validation": {
"maxDateTime": "2023-11-07T05:31:56Z",
"maxNumericValue": 123,
"maxStringLength": 123,
"minDateTime": "2023-11-07T05:31:56Z",
"minNumericValue": 123,
"minStringLength": 123,
"regularExpression": "<string>"
},
"vocabularyValues": [
{
"value": "<string>",
"content": {
"localeCode": "<string>",
"value": "<string>"
},
"isHidden": true,
"sequence": 123
}
]
}
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"commerceSummary": {
"lastOrderDate": "2023-11-07T05:31:56Z",
"orderCount": 123,
"totalOrderAmount": {
"amount": 123,
"currencyCode": "<string>"
},
"visitsCount": 123,
"wishlistCount": 123
},
"companyOrOrganization": "<string>",
"contacts": [
{
"accountId": 123,
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"faxNumber": "<string>",
"firstName": "<string>",
"id": 123,
"label": "<string>",
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"types": [
{
"isPrimary": true,
"name": "<string>"
}
]
}
],
"customerSet": "<string>",
"customerSinceDate": "2023-11-07T05:31:56Z",
"emailAddress": "<string>",
"externalId": "<string>",
"firstName": "<string>",
"hasExternalPassword": true,
"id": 123,
"isActive": true,
"isAnonymous": true,
"isLocked": true,
"last2FaDate": "2023-11-07T05:31:56Z",
"lastName": "<string>",
"localeCode": "<string>",
"migrationRequired": true,
"notes": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"content": "<string>",
"id": 123
}
],
"segments": [
{
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"code": "<string>",
"description": "<string>",
"id": 123,
"name": "<string>"
}
],
"taxExempt": true,
"taxId": "<string>",
"userId": "<string>",
"userName": "<string>"
},
"jwtAccessToken": "<string>",
"refreshToken": "<string>",
"refreshTokenExpiration": "2023-11-07T05:31:56Z",
"requires2FA": true,
"userId": "<string>"
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Response
OK
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.
Show child attributes
Show child attributes
⌘I

