Get Account Attribute

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

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

Error

A valid request URL is required to generate request examples

200

{
  "attributeDefinitionId": 123,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "fullyQualifiedName": "<string>",
  "values": [
    "<unknown>"
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

accountId · integer<int32> · required

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

attributeFQN · string · required

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

Query Parameters

userId · string

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

attributeDefinitionId · integer<int32> | null

auditInfo · object

Show child attributes

fullyQualifiedName · string | null

values · any[] | null