commerce/catalog/admin/products/extras

Use the Extras resource to configure an extra product attribute for products associated with the product type that uses the extra attribute.

JSON Example

ProductExtra Properties

Property Description
attributeFQN

type: string

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

isMultiSelect

type: bool

If true, the shopper can select more than one value from a predefined list for this extra.

isRequired

type: bool

Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value.

values

type: list of productExtraValue

List of value data for objects.

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

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

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

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

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

productExtraValue.attributeVocabularyValue.localizedContent

type: list of attributeVocabularyValueLocalizedContent

The localized content associated with the object.

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

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

productExtraValue.attributeVocabularyValue.productName

type: string

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

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

productExtraValue.attributeVocabularyValue.valueSequence

type: int

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

productExtraValue.deltaPrice

type: productExtraValueDeltaPrice

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productExtraValue.productExtraValueDeltaPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productExtraValue.productExtraValueDeltaPrice.deltaPrice

type: decimal

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productExtraValue.deltaWeight

type: decimal

The difference between the weight associated with this product, variation option, or extra and the base product. For example, if a product with a monogram weighs an extra 1/4 lb, the DeltaWeight value is "0.25". The amount of the delta is set by the weight type for the storefront.

productExtraValue.isDefaulted

type: bool

If true, the value for the product extra is selected by default. Shopper entered extras cannot be defaulted.

productExtraValue.localizedDeltaPrice

type: list of productExtraValueDeltaPrice

The difference between associated prices for a product, variation option, or extra that is localized per the `localeCode`. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. Depending on the localeCode, the price may be converted such as from USD (US Dollar) to EUR (euro).

productExtraValue.productExtraValueDeltaPrice.currencyCode

type: string

The localized currency code for the monetary amount.

productExtraValue.productExtraValueDeltaPrice.deltaPrice

type: decimal

If the product is in relative pricing mode, this is the difference between associated prices for a product, variation option, or extra. The difference is calculated by subtracting the base price from the associated price with this product, option, and/or extra. For example, if a product with a defined monogram extra costs an additional $10, the `deltaPrice `value is "10". Between options, a price for a medium may be $10 and a large $12 giving a `deltaPrice `value of "2".

Refer to Product Variant Pricing and Weight in the Products guides topic for more information.

productExtraValue.quantity

type: int

The specified quantity of objects and items. This property is used for numerous object types including products, options, components within a product bundle, cart and order items, returned items, shipping line items, items in a digital product. and items associated with types and reservations.

productExtraValue.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
AddExtra POST %7bproductCode%7d%2fExtras%3fresponseFields%3d%7bresponseFields%7d

Configure an extra attribute for the product specified in the request.

AddExtraValueLocalizedDeltaPrice POST %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%2fValues%2f%7bvalue%7d%2flocalizedDeltaPrice%3fresponseFields%3d%7bresponseFields%7d

Adds a localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

DeleteExtra DELETE %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d

Delete a product extra configuration for the product specified in the request.

DeleteExtraValueLocalizedDeltaPrice DELETE %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%2fValues%2f%7bvalue%7d%2flocalizedDeltaPrice%2f%7bcurrencyCode%7d

Deletes the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

GetExtra GET %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of an extra attribute configuration for the product specified in the request.

GetExtras GET %7bproductCode%7d%2fExtras

Retrieves a list of extras configured for the product according to any defined filter and sort criteria.

GetExtraValueLocalizedDeltaPrice GET %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%2fValues%2f%7bvalue%7d%2flocalizedDeltaPrice%2f%7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

GetExtraValueLocalizedDeltaPrices GET %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%2fValues%2f%7bvalue%7d%2flocalizedDeltaPrice

Retrieves a collection of all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

UpdateExtra PUT %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the configuration of an extra attribute for the product specified in the request.

UpdateExtraValueLocalizedDeltaPrice PUT %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%2fValues%2f%7bvalue%7d%2flocalizedDeltaPrice%2f%7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.

UpdateExtraValueLocalizedDeltaPrices PUT %7bproductCode%7d%2fExtras%2f%7battributeFQN%7d%2fValues%2f%7bvalue%7d%2flocalizedDeltaPrice

Updates all localized delta price values for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.