commerce/catalog/admin/products/properties

Use the Properties resource to configure a property attribute for an individual product associated with a product type that uses the property attribute, as well as set property values for the product.

JSON Example

ProductProperty Properties

Property Description
attributeFQN

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

values

type: list of productPropertyValue

List of value data for objects.

productPropertyValue.attributeVocabularyValueDetail

type: attributeVocabularyValue

Properties of an individual vocabulary value for an attribute. For example, a "color" attribute might have the following vocabulary values: Red, Blue, Green.

productPropertyValue.attributeVocabularyValue.content

type: attributeVocabularyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productPropertyValue.attributeVocabularyValue.displayOrder

type: int

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

productPropertyValue.attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productPropertyValue.attributeVocabularyValue.attributeVocabularyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productPropertyValue.attributeVocabularyValue.productName

type: string

The name of the product that represents a line item in a taxable order or product bundle.

productPropertyValue.attributeVocabularyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

productPropertyValue.attributeVocabularyValue.valueSequence

type: int

The number that denotes the order of the entity value within a list of entity values.

productPropertyValue.content

type: productPropertyValueLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

productPropertyValue.productPropertyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productPropertyValue.productPropertyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productPropertyValue.localizedContent

type: list of productPropertyValueLocalizedContent

The localized content associated with the object.

productPropertyValue.productPropertyValueLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

productPropertyValue.productPropertyValueLocalizedContent.stringValue

type: string

If the object value is a String, this value provides that string value, used by vocabulary property values, products, and options.

productPropertyValue.value

type: object

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

Operations

Operation Name Request URI Description
AddProperty POST %7bproductCode%7d%2fProperties%3fresponseFields%3d%7bresponseFields%7d

Configures a property attribute for the product specified in the request.

AddPropertyValueLocalizedContent POST %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%2fvalues%2f%7bvalue%7d%2fLocalizedContent%3fresponseFields%3d%7bresponseFields%7d

Adds a property value for localized content. This content is set by the locale code.

DeleteProperty DELETE %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d

Deletes the configuration of a property attribute for the product specified in the request.

DeletePropertyValueLocalizedContent DELETE %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%2fvalues%2f%7bvalue%7d%2fLocalizedContent%2f%7blocaleCode%7d

Deletes the property value for localized content. This content is set by the locale code.

GetProperties GET %7bproductCode%7d%2fProperties

Retrieves a list of the property attributes configured for the product specified in the request.

GetProperty GET %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a property attribute configuration for the product specified in the request.

GetPropertyValueLocalizedContent GET %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%2fvalues%2f%7bvalue%7d%2fLocalizedContent%2f%7blocaleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the property value for localized content. This content is set by the locale code.

GetPropertyValueLocalizedContents GET %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%2fvalues%2f%7bvalue%7d%2fLocalizedContent

Retrieves a collection of property values for localized content. This content is set by the locale code.

UpdateProperty PUT %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Update one or more details of a property attribute configuration for the product specified in the request.

UpdatePropertyValueLocalizedContent PUT %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%2fvalues%2f%7bvalue%7d%2fLocalizedContent%2f%7blocaleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the property value for localized content. This content is set by the locale code.

UpdatePropertyValueLocalizedContents PUT %7bproductCode%7d%2fProperties%2f%7battributeFQN%7d%2fvalues%2f%7bvalue%7d%2fLocalizedContent

Updates all property values for localized content. This content is set by the locale code.