Use the Customer Accounts resource to manage the components of shopper accounts, including attributes, contact information, company notes, and groups associated with the customer account.

JSON Example

CustomerAccount Properties

Property Description

type: bool

Indicates if the customer account is opted to receive marketing materials. If true, the customer account is opted in for receiving the content.


type: string

The type of the customer account.


type: list of customerAttribute

Collection of attributes that may be paged list or a list, depending on the usage per object and API type.


type: int

Unique identifier of the attribute definition.


type: string

Fully qualified name of the attribute for the order or customer.


type: list of object

List of value data for objects.


type: string

The company or organization name entered for a customer account.


type: string

The details of the customer set.


type: DateTime

This property tracks the customer account creation date. This date can be set manually via the API for customer accounts that are imported into Kibo eCommerce.


type: string

The email address for the customer account and contact. This email may be used for login to the storefront and for subscription mailing lists.


type: string

Unique identifier used by an external program to identify a Kibo eCommerce order, customer account, or wish list.


type: string

The full first name of a customer or contact name.


type: bool

Indicates if an external password is set on this account.


type: bool

Indicates if the object or feature is active.


type: bool

If true, this customer account represents an anonymous shopper.


type: bool

Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked.


type: string

The full last name of a customer or contact name.


type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.


type: bool

If true, this customer account has tax exempt status.


type: string

The tax identification number associated with the customer account.


type: string

The user name associated with the user profile. The customer uses the user name to access the account.


Operation Name Request URI Description
AddAccount POST %3fresponseFields%3d%7bresponseFields%7d

Creates a new customer account based on the information specified in the request.

AddAccountAndLogin POST Add-Account-And-Login%3fresponseFields%3d%7bresponseFields%7d

Creates a new customer account and logs the user associated with the customer account into the site.

AddAccounts POST Bulk%3fresponseFields%3d%7bresponseFields%7d

Creates multiple customer accounts based on the information specified in the request.

AddLoginToExistingCustomer POST %7baccountId%7d%2fCreate-Login%3fresponseFields%3d%7bresponseFields%7d

Adds a new user login to a defined customer account.

ChangePassword POST %7baccountId%7d%2fChange-Password%3funlockAccount%3d%7bunlockAccount%7d%26userId%3d%7buserId%7d

Modifies the password associated with a customer account.

ChangePasswords POST Change-Passwords%3fresponseFields%3d%7bresponseFields%7d

Changes a collection of customer account passwords.

DeleteAccount DELETE %7baccountId%7d

Deletes a customer account. A customer account cannot be deleted if any orders exist, past or present.

GetAccount GET %7baccountId%7d%3fuserId%3d%7buserId%7d%26responseFields%3d%7bresponseFields%7d

Retrieve details of a customer account.

GetAccounts GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26fields%3d%7bfields%7d%26q%3d%7bq%7d%26qLimit%3d%7bqLimit%7d%26isAnonymous%3d%7bisAnonymous%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of customer accounts.

GetCustomersPurchaseOrderAccounts POST purchaseOrderAccounts%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26accountType%3d%7baccountType%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of customer purchase order accounts according to according to any specified sort options.

GetLoginState GET %7baccountId%7d%2floginstate%3fuserId%3d%7buserId%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the current login state of the customer account specified in the request.

GetLoginStateByEmailAddress POST loginstatebyemailaddress%3femailAddress%3d%7bemailAddress%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the current login state of a customer account by providing the customer's email address.

GetLoginStateByUserName POST loginstatebyusername%3fuserName%3d%7buserName%7d%26customerSetCode%3d%7bcustomerSetCode%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the current login state of a customer account by providing the user name associated with the customer account.

RecomputeCustomerLifetimeValue POST %7baccountId%7d%2frecomputelifetimevalue

Updates the customer lifetime value of the specified customer account in the event of an order import or a lifetime value calculation error.

ResetPassword POST Reset-Password

Resets the password for a customer account.

SetLoginLocked POST %7baccountId%7d%2fSet-Login-Locked%3fuserId%3d%7buserId%7d

Lock or unlock a customer account.

SetPasswordChangeRequired POST %7baccountId%7d%2fSet-Password-Change-Required%3fuserId%3d%7buserId%7d

Requires the password for the customer account to be changed.

UpdateAccount PUT %7baccountId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates a customer account. Note that attempting to disable an account by using the below PUT call to change the isActive parameter is unsupported, and attempts to do so will be ignored by the API. Instead, make a POST call to api/commerce/customer/accounts/{accountId}/action and provide only { "actionName": "DisableAccount" } in the request body. This will successfully disable the account and the isActive flag will be automatically set as false.