Skip to main content
GET
/
commerce
/
catalog
/
admin
/
attributedefinition
/
producttypes
/
{productTypeId}
/
VariantProperties
/
{attributeFQN}
Error
A valid request URL is required to generate request examples
{
  "attributeDetail": {
    "adminName": "<string>",
    "attributeCode": "<string>",
    "attributeDataTypeSequence": 123,
    "attributeFQN": "<string>",
    "attributeMetadata": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "attributeSequence": 123,
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "availableForOrderRouting": true,
    "content": {
      "description": "<string>",
      "localeCode": "<string>",
      "name": "<string>"
    },
    "dataType": "<string>",
    "inputType": "<string>",
    "isExtra": true,
    "isOption": true,
    "isProperty": true,
    "isValueMappingAttribute": true,
    "localizedContent": [
      {
        "description": "<string>",
        "localeCode": "<string>",
        "name": "<string>"
      }
    ],
    "masterCatalogId": 123,
    "namespace": "<string>",
    "searchSettings": {
      "allowFilteringAndSortingInStorefront": true,
      "customWeightInStorefrontSearch": true,
      "indexValueWithCase": true,
      "searchDisplayValue": true,
      "searchableInAdmin": true,
      "searchableInStorefront": true
    },
    "validation": {
      "maxDateValue": "2023-11-07T05:31:56Z",
      "maxNumericValue": 123,
      "maxStringLength": 123,
      "minDateValue": "2023-11-07T05:31:56Z",
      "minNumericValue": 123,
      "minStringLength": 123,
      "regularExpression": "<string>"
    },
    "valueMappingAttributeFQN": "<string>",
    "valueType": "<string>",
    "vocabularyValues": [
      {
        "content": {
          "localeCode": "<string>",
          "stringValue": "<string>"
        },
        "displayOrder": 123,
        "localizedContent": [
          {
            "localeCode": "<string>",
            "stringValue": "<string>"
          }
        ],
        "mappedGenericValues": [
          "<unknown>"
        ],
        "productName": "<string>",
        "value": "<unknown>",
        "valueSequence": 123
      }
    ]
  },
  "attributeFQN": "<string>",
  "displayInfo": {
    "displayIntention": "<string>"
  },
  "isAdminOnlyProperty": true,
  "isHiddenProperty": true,
  "isInheritedFromBaseType": true,
  "isMultiValueProperty": true,
  "isProductDetailsOnlyProperty": true,
  "isRequiredByAdmin": true,
  "order": 123,
  "vocabularyValues": [
    {
      "displayInfo": {
        "cmsId": "<string>",
        "colorValue": "<string>",
        "imageUrl": "<string>"
      },
      "order": 123,
      "value": "<unknown>",
      "vocabularyValueDetail": {
        "content": {
          "localeCode": "<string>",
          "stringValue": "<string>"
        },
        "displayOrder": 123,
        "localizedContent": [
          {
            "localeCode": "<string>",
            "stringValue": "<string>"
          }
        ],
        "mappedGenericValues": [
          "<unknown>"
        ],
        "productName": "<string>",
        "value": "<unknown>",
        "valueSequence": 123
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
productTypeId
integer<int32>
required
​
attributeFQN
string
required

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Response

Success

​
attributeDetail
object

Attribute

​
attributeFQN
string | null

Unique identifier of the Attribute. Must be an attribute fully qualilfied name that already exists. If no namespace is specified Tenant is assumed

​
displayInfo
object
​
isAdminOnlyProperty
boolean | null

If true, this property is not available on the storefront. If false, this property will be available on storefront. The IsHiddenProperty hides the property from the customer, but is still available from the API.

​
isHiddenProperty
boolean | null

If True, the property is hidden in the storefront. This field only applies to properties.

​
isInheritedFromBaseType
boolean | null

If True, the attribute is part of the base product type and can only have order modified.

​
isMultiValueProperty
boolean | null

If True, the property can have multiple values selected on the product. Only applies to PredefinedVocabulary properties.

​
isProductDetailsOnlyProperty
boolean | null

If True this property will not be returned storefront product listings (Search,GetProduct) it will still be returned on GetProduct, ValidateProduct...)

​
isRequiredByAdmin
boolean | null

If True, the admin must include this attribute in products of this productType

​
order
integer<int32> | null

Used to order the display of the attributes within a section

​
vocabularyValues
object[] | null

The collection of vocabulary values included in this product type.