commerce/customer/accounts/attributes

Use the Attributes subresource to manage the attributes used to uniquely identify shopper accounts, such as gender or age.

JSON Example

CustomerAttribute Properties

Property Description
attributeDefinitionId

type: int

Unique identifier of the attribute definition.

fullyQualifiedName

type: string

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

values

type: list of object

List of value data for objects.

Operations

Operation Name Request URI Description
AddAccountAttribute POST %7baccountId%7d%2fattributes%3fresponseFields%3d%7bresponseFields%7d

Applies a defined attribute to the customer account specified in the request and assigns a value to the customer attribute.

DeleteAccountAttribute DELETE %7baccountId%7d%2fattributes%2f%7battributeFQN%7d

Removes the attribute specified in the request from the customer account.

GetAccountAttribute GET %7baccountId%7d%2fattributes%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the contents of an attribute associated with the specified customer account.

GetAccountAttributes GET %7baccountId%7d%2fattributes%3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves the list of customer account attributes.

UpdateAccountAttribute PUT %7baccountId%7d%2fattributes%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Updates one or more details of a customer account attribute.