Skip to main content
GET
/
commerce
/
admin
/
locations
/
{locationCode}
/
attributes
/
{fullyQualifiedName}
Error
A valid request URL is required to generate request examples
{
  "attributeDefinition": {
    "attributeCode": "<string>",
    "valueType": "<string>",
    "displayGroup": "<string>",
    "id": 123,
    "adminName": "<string>",
    "namespace": "<string>",
    "inputType": "<string>",
    "dataType": "<string>",
    "attributeMetadata": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "attributeFQN": "<string>",
    "content": {
      "localeCode": "<string>",
      "value": "<string>"
    },
    "validation": {
      "regularExpression": "<string>",
      "minStringLength": 123,
      "maxStringLength": 123,
      "minNumericValue": 123,
      "maxNumericValue": 123,
      "minDateTime": "2023-11-07T05:31:56Z",
      "maxDateTime": "2023-11-07T05:31:56Z"
    },
    "vocabularyValues": [
      {
        "value": "<string>",
        "sequence": 123,
        "isHidden": true,
        "content": {
          "localeCode": "<string>",
          "value": "<string>"
        }
      }
    ],
    "auditInfo": {
      "updateDate": "2023-11-07T05:31:56Z",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "createBy": "<string>"
    },
    "isActive": true,
    "isRequired": true,
    "isReadOnly": true,
    "isMultiValued": true,
    "isVisible": true,
    "order": 123,
    "availableForOrderRouting": true,
    "availableForDiscounts": true
  },
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "fullyQualifiedName": "<string>",
  "attributeDefinitionId": 123,
  "values": [
    "<unknown>"
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

locationCode
string
required

The unique code for a location

fullyQualifiedName
string
required

The fully qualified name of the attribute to retrieve

Query Parameters

responseFields
string

limits which fields are returned in the response body

Response

Success

attributeDefinition
object
auditInfo
object
fullyQualifiedName
string | null
attributeDefinitionId
integer<int32> | null
values
any[] | null