commerce/catalog/admin/products/options

Use the Options resource to configure the option attributes and vocabulary values for an individual product associated with the product type that uses the option attribute. Options are used to generate variations of a product.

JSON Example

ProductOption 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 productOptionValue

List of value data for objects.

productOptionValue.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.

productOptionValue.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.

productOptionValue.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.

productOptionValue.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.

productOptionValue.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.

productOptionValue.attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

productOptionValue.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.

productOptionValue.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.

productOptionValue.attributeVocabularyValue.productName

type: string

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

productOptionValue.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.

productOptionValue.attributeVocabularyValue.valueSequence

type: int

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

productOptionValue.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
AddOption POST %7bproductCode%7d%2fOptions%3fresponseFields%3d%7bresponseFields%7d

Configures an option attribute for the product specified in the request.

DeleteOption DELETE %7bproductCode%7d%2fOptions%2f%7battributeFQN%7d

Deletes the configuration of an option attribute for the product specified in the request.

GetOption GET %7bproductCode%7d%2fOptions%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of an option attribute configuration for the specified product.

GetOptions GET %7bproductCode%7d%2fOptions

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

UpdateOption PUT %7bproductCode%7d%2fOptions%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Updates one or more properties of an option attribute configured for a product.