Update Product Attribute

put https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}

Updates a product attribute by its FQN. This current version of the Attributes API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access attribute data that has not yet been rewritten to the new model by providing an x-api-version header set to "1".

Path Params

attributeFQN

string

required

Query Params

responseFields

string

limits which fields are returned in the response body

Body Params

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

int32 | null

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

attributeDataTypeSequence

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

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

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

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

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

array of objects | null

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

attributeMetadata

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

array of objects | null

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

localizedContent

validation

object

Used to validate attributes.

vocabularyValues

array of objects | null

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

vocabularyValues

searchSettings

object

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

auditInfo

object

Response

Response body

object

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

attributeCode

string | null

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

int32 | null

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

attributeDataTypeSequence

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

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

valueType

string | null

dataType

string | null

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

array of objects | null

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

attributeMetadata

object

key

string | null

The key

value

string | null

The value

content

object

localeCode

string | null

Language used for the attribute name and description. Currently, only en_US is supported.

name

string | null

Name of the attribute in the language specified by LocaleCode.

description

string | null

Description of the attribute in the language specified by LocaleCode.

localizedContent

array of objects | null

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

localizedContent

object

localeCode

string | null

Language used for the attribute name and description. Currently, only en_US is supported.

name

string | null

Name of the attribute in the language specified by LocaleCode.

description

string | null

Description of the attribute in the language specified by LocaleCode.

validation

object

Used to validate attributes.

regularExpression

string | null

Regular expression to run against the attribute value. This should follow JavaScript/EMCA's Regular Expression syntax.

minStringLength

int32 | null

For validating strings, minimum length allowed for a string.

maxStringLength

int32 | null

For validating strings, maximum length allowed for a string.

minNumericValue

double | null

For validating Number attribute value, minimum number allowed.

maxNumericValue

double | null

For validating Number attribute value, maximum number allowed.

minDateValue

date-time | null

For validating a DateTime attribute value, minimum datetime allowed.

maxDateValue

date-time | null

For validating a DateTime attribute value, maximum datetime allowed.

vocabularyValues

array of objects | null

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

vocabularyValues

object

valueSequence

int32 | null

Read only System generated monotonically increasing unique sequence.

value

string

The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute.
String data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content.
String values require content to be present.
Once this value is set it cannot be changed.

mappedGenericValues

array | null

The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist
within the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time.

mappedGenericValues

productName

string | null

The ProductName when the Attribute DataType is ProductCode.

content

object

Attribute Value Localized Resource

localizedContent

array of objects | null

The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType.

localizedContent

object

localeCode

string | null

Language used for the string attribute value. Currently, only en_US is supported.

stringValue

string | null

Localized Value in the language of the locale code

displayOrder

int32 | null

The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list.

searchSettings

object

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

searchableInStorefront

boolean

Indicates whether the attribute value should be searchable on the public storefront.

searchableInAdmin

boolean

Indicates whether the attribute value should be searchable in the merchant catalog admin.

searchDisplayValue

boolean

If true, the system will index the display value of string attributes instead of the canonical value for searching.
The canonical value will always be used for filtering. Does not apply for for non-string attributes.

allowFilteringAndSortingInStorefront

boolean | null

Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront.

indexValueWithCase

boolean | null

Indicates whether the attribute value is case sensative for filtering and faceting. This applies to Text Admin entered attributes.
A null value means it is not case sensative

customWeightInStorefrontSearch

boolean | null

Indicates whether the attribute is indevidually stored as a tokenized field in search for custom term search weight

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://t0-s0.sandbox.mozu.com/api/commerce/catalog/admin/attributedefinition/attributes/attributeFQN \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success