commerce/catalog/admin/attributedefinition/attributes/vocabularyvalues

Vocabulary values are predefined for an attribute.

JSON Example

AttributeVocabularyValue Properties

Property Description
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.

attributeVocabularyValueLocalizedContent.localeCode

type: string

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

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.

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.

localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

attributeVocabularyValueLocalizedContent.localeCode

type: string

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

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.

productName

type: string

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

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.

valueSequence

type: int

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

Operations

Operation Name Request URI Description
AddAttributeVocabularyValue POST %7battributeFQN%7d%2fVocabularyValues%3fresponseFields%3d%7bresponseFields%7d

Creates a vocabulary value for a defined product attribute.

AddAttributeVocabularyValueLocalizedContent POST %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%2flocalizedContent%3fresponseFields%3d%7bresponseFields%7d

Creates and saves localized vocabulary value content for an attribute, based on the `localeCode`.

DeleteAttributeVocabularyValue DELETE %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d

Deletes an attribute's vocabulary value.

DeleteAttributeVocabularyValueLocalizedContent DELETE %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%2fLocalizedContent%2f%7blocaleCode%7d

Removes localized content for a vocabulary value attribute.

GetAttributeVocabularyValue GET %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of a vocabulary value defined for an attribute by providing the attribute's fully qualified name and the value to retrieve.

GetAttributeVocabularyValueLocalizedContent GET %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%2fLocalizedContent%2f%7blocaleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the localized content for a vocabulary value attribute based on a `localeCode`.

GetAttributeVocabularyValueLocalizedContents GET %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%2fLocalizedContent

Retrieves a collection of localized content for vocabulary value attributes based on a `localeCode`.

GetAttributeVocabularyValues GET %7battributeFQN%7d%2fVocabularyValues

Retrieves a list of vocabulary values defined for the attribute specified in the request.

UpdateAttributeVocabularyValue PUT %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%3fresponseFields%3d%7bresponseFields%7d

Updates existing attribute vocabulary values.

UpdateAttributeVocabularyValueLocalizedContent PUT %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%2fLocalizedContent%2f%7blocaleCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates localized vocabulary value content for an existing attribute, based on the `localeCode`.

UpdateAttributeVocabularyValueLocalizedContents PUT %7battributeFQN%7d%2fVocabularyValues%2f%7bvalue%7d%2fLocalizedContent

Updates a collection of localized vocabulary value content for existing attributes, based on the `localeCode`.

UpdateAttributeVocabularyValues PUT %7battributeFQN%7d%2fVocabularyValues

Update existing vocabulary values for an attribute.