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

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
attributeFQN
string
required

Query Parameters

​
responseGroups
string
​
responseFields
string

limits which fields are returned in the response body

Response

Success

Attribute

​
adminName
string | null

Name of the product displayed in the admin, This field does not need to be unqiue, but is required. It can include spaces...and is limited to a length of 50.

​
namespace
string | null

NameSpace, each application creating attributes will have a uniqe namespace to avoid name (Code) collisions. The namespace provided must be a valid registered namespace. If no namespace is specified it is assumed to be the namespace of the Tenant.

​
attributeCode
string | null

Unique identifier of the Attribute. Must be unique within a namespace and cannot be changed once the attribute is created. This value will be generated and match the attribute sequence if not provided on create.

​
attributeFQN
string | null

Attribute fully qualified name, Read only value that combines namespace and attribute code as NameSpace~AttributeCode

​
isValueMappingAttribute
boolean | null

Specifies if this attribute can can be used to generalize values of another attribute

​
valueMappingAttributeFQN
string | null

Attribute fully qualified name of a corresponding value mapping atribuite

​
attributeSequence
integer<int32> | null

Read only System generated monotonically increasing unique sequence for each attribute created.

​
attributeDataTypeSequence
integer<int32> | null

Read only System generated monotonically increasing unique sequence for each attribute,DataType created (this is used to optimize indexed field names in search).

​
masterCatalogId
integer<int32> | null

Indentifier of the master that this attribute is a member of. System-supplied and read-only. Attributes will be created in the MasterCatalog of the supplied context.

​
inputType
string | null

The InputType type of the attribute. Must be a valid value for InputType defined in InputTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

Maximum string length: 20
​
valueType
string | null

The ValueType of the attribute. Must be a valid value for ValueType defined in ValueTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

Maximum string length: 20
​
dataType
string | null

The DataType of the attribute. Must be a valid value for DataType defined in DataTypeTypeConst and the combination of types set must match an entry in the AttributeTypeRules resource. This value cannot be changed after create

Maximum string length: 20
​
isOption
boolean | null

Specifies if this attribute can have a usage type of Option in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

​
isExtra
boolean | null

Specifies if this attribute can have a usage type of Extra in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

​
isProperty
boolean | null

Specifies if this attribute can have a usage type of Property in a ProductType. This value can only be true when when it matches an AttributeTypeRule in the AttributeTypeRules resource.

​
availableForOrderRouting
boolean

Specifies if this attribute is available for order routing

​
attributeMetadata
object[] | null

Attribute Metadata. This list can contain opaque data (key value pairs) that can be used as a property bag for UI concerns.

​
content
object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display an attribute in multiple languages yet manage it as a single attribute internally.

​
localizedContent
object[] | null

The Content of an attribute. This content is always in the default language of the MasterCatalog.

​
validation
object

Used to validate attributes.

​
vocabularyValues
object[] | null

The list of Values for this attribute. Only available for ValueType:PredefinedVocabulary

​
searchSettings
object

Attribute Search Settings. A container for all of the search and indexing settings of an Attribute

​
auditInfo
object