GetAttributeVocabularyValues

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

Request

HTTP Request

GET
 api/commerce/customer/attributedefinition/attributes/%7battributeFQN%7d%2fVocabularyValues

Parameters

Parameter NameDescription
Parameters
attributeFQNtype: string 

Fully qualified name for an attribute.

Required Behaviors

  • Extensibility Read

Request Properties

No request body content

Response Properties

Properties of a vocabulary value defined for an extensible attribute.

PropertyDescription
content

type: attributeValueLocalizedContent

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.

attributeValueLocalizedContent.localeCode

type: string

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

attributeValueLocalizedContent.value

type: string

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.

isHidden

type: bool

Indicates if the object is hidden or breaks inheritance, primarily used by facets, products, and attribute vocabulary values. For example, if true, the attribute vocabulary value does not appear in the list when defining a value for an attribute.

sequence

type: int

The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories.

value

type: string

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.

Response Body