v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CustomerAccount

Get Account Attribute

Retrieves the contents of a particular attribute attached to a specified account.

get/commerce/customer/accounts/{accountId}/attributes/{attributeFQN}

Path parameters

accountIdinteger required

Unique identifier of the account that contains the attribute to retrieve.

attributeFQNstring required

Fully qualified name of the attribute that you want to retrieve.

Query parameters

userIdstring
responseFieldsstring

limits which fields are returned in the response body

Response

OK

adminNamestring nullable
attributeCodestring required
attributeFQNstring nullable
availableForDiscountsboolean
availableForOrderRoutingboolean
dataTypestring nullable
displayGroupstring required
idinteger nullable
inputTypestring nullable
isActiveboolean nullable
isMultiValuedboolean nullable
isReadOnlyboolean
isRequiredboolean nullable
isVisibleboolean nullable
namespacestring nullable
orderinteger nullable
valueTypestring required