v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CustomerAccount

Get Account

Retrieves the details of a customer account specified by its unique identifier.

get/commerce/customer/accounts/{accountId}

Path parameters

accountIdinteger required

Unique identifier of the customer account whose details you want to retrieve.

Query parameters

responseGroupsstring
userIdstring
responseFieldsstring

limits which fields are returned in the response body

Response

OK

acceptsMarketingboolean

If true, the customer prefers to receive marketing material such as newsletters or email offers.

accountTypestring nullable

Type of account.

companyOrOrganizationstring nullable

The company or organization name for an account.

customerSetstring nullable
customerSinceDatestring date-time nullable

Date when the customer account is created.

emailAddressstring nullable

"Email addresss of the customer.

externalIdstring nullable
firstNamestring nullable

First name of the customer.

hasExternalPasswordboolean

Indicates if an external password is set on this account

idinteger

Unique identifier of the account, also known as a customer number.

isActiveboolean

Is the account active?

isAnonymousboolean

Is the account Anonymous?

isLockedboolean

Is the account locked?

last2FaDatestring date-time nullable
lastNamestring nullable

Last name of the customer.

localeCodestring nullable

Locale Code.

migrationRequiredboolean

Indicates Subscription migration is required or not.

taxExemptboolean
taxIdstring nullable
userIdstring nullable

Unique identifier of the user who is currently logged in. This is null if the user is anonymous (not logged in). Unicode data with a maximum length of 55 characters.

userNamestring nullable

User name for the customer account.