API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- POSTAdd Account And Login
- POSTAdd Accounts
- POSTAdd Login To Existing Customer
- POSTChange Password
- POSTChange Passwords
- GETGet Account
- PUTUpdate Account
- DELDelete Account
- GETGet Account Attribute
- PUTUpdate Account Attribute
- DELDelete Account Attribute
- GETGet Account Attributes
- POSTAdd Account Attribute
- GETGet Account Audit Log
- GETGet Account Card
- PUTUpdate Account Card
- DELDelete Account Card
- GETGet Account Cards
- POSTAdd Account Card
- GETGet Account Contact
- PUTUpdate Account Contact
- DELDelete Account Contact
- GETGet Account Contacts
- PUTAdd Account Contact List
- POSTAdd Account Contact
- GETGet Account Note
- PUTUpdate Account Note
- DELDelete Account Note
- GETGet Account Notes
- POSTAdd Account Note
- GETGet Account Segments
- GETGet Accounts
- POSTAdd Account
- GETGet Customer Purchase Order Account
- PUTUpdate Customer Purchase Order Account
- POSTCreate Customer Purchase Order Account
- GETGet Customer Purchase Order Transactions
- POSTCreate Purchase Order Transaction
- POSTGet Customers Purchase Order Accounts
- GETGet Login State
- POSTGet Login State By Email Address
- POSTGet Login State By UserName
- GETGet Transactions
- POSTAdd Transaction
- POSTRecompute Customer Lifetime Value
- DELRemove Transaction
- POSTReset Password
- GETRetrieve Current Account
- POSTSet Login Locked
- POSTSet Password Change Required
- POSTUpdate Forgotten Password
Error
A valid request URL is required to generate request examples{
"accessToken": "<string>",
"accessTokenExpiration": "2023-11-07T05:31:56Z",
"customerAccount": {
"accountType": "<string>",
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"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",
"externalId": "<string>",
"id": 123,
"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>",
"acceptsMarketing": true,
"emailAddress": "<string>",
"firstName": "<string>",
"hasExternalPassword": true,
"isActive": true,
"isAnonymous": true,
"isLocked": true,
"last2FaDate": "2023-11-07T05:31:56Z",
"lastName": "<string>",
"localeCode": "<string>",
"userId": "<string>",
"userName": "<string>"
},
"jwtAccessToken": "<string>",
"refreshToken": "<string>",
"refreshTokenExpiration": "2023-11-07T05:31:56Z",
"requires2FA": true,
"userId": "<string>"
}Add Login To Existing Customer
Creates a login for an existing customer and logs them in automatically.
POST
/
commerce
/
customer
/
accounts
/
{accountId}
/
Create-Login
Error
A valid request URL is required to generate request examples{
"accessToken": "<string>",
"accessTokenExpiration": "2023-11-07T05:31:56Z",
"customerAccount": {
"accountType": "<string>",
"attributes": [
{
"attributeDefinitionId": 123,
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"fullyQualifiedName": "<string>",
"values": [
"<unknown>"
]
}
],
"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",
"externalId": "<string>",
"id": 123,
"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>",
"acceptsMarketing": true,
"emailAddress": "<string>",
"firstName": "<string>",
"hasExternalPassword": true,
"isActive": true,
"isAnonymous": true,
"isLocked": true,
"last2FaDate": "2023-11-07T05:31:56Z",
"lastName": "<string>",
"localeCode": "<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.
Path Parameters
Query Parameters
limits which fields are returned in the response body
Body
application/json
Optional requested duration for the authentication ticket in minutes. Must not exceed tenant configuration or platform hard caps. Requires 'customer-auth:configure-token-durations' behavior.
Specifies the fingerprint of the user for two-factor authentication.
Optional requested duration for the refresh token in minutes. Must not exceed tenant configuration or platform hard caps. Requires 'customer-auth:configure-token-durations' behavior.
Specifies the region of the user for two-factor authentication.
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.
Show child attributes
Show child attributes
⌘I