ValidateProduct

Validate the final state of shopper-selected options.

Request

HTTP Request

POST
 api/commerce/catalog/storefront/products/%7bproductCode%7d%2fvalidate%3fskipInventoryCheck%3d%7bskipInventoryCheck%7d%26quantity%3d%7bquantity%7d%26skipDefaults%3d%7bskipDefaults%7d%26purchaseLocation%3d%7bpurchaseLocation%7d%26responseFields%3d%7bresponseFields%7d

Parameters

Parameter NameDescription
Parameters
productCodetype: string 

The unique, user-defined product code of a product, used throughout to reference and associate to a product.

skipInventoryChecktype: bool 

If true, skip the process to validate inventory when creating this product reservation.

quantitytype: int 

The number of cart items in the shopper's active cart.

skipDefaultstype: bool 

Normally, product validation applies default extras to products that do not have options specified. If true, product validation does not apply default extras to products.

Note:  When a replacement order is created for an RMA'd product, the system automatically enables this property to prevent adding default extras when shoppers choose to return the parent product but not the extras.
purchaseLocationtype: string 

The location where the order item(s) was purchased.

responseFieldstype: string 

Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.

Request Properties

For a product with shopper-configurable options, the properties of the product options selected by the shopper.

PropertyDescription
options

type: list of productOptionSelection

List of option attributes configured for an object. These values are associated and used by products, product bundles, and product types.

productOptionSelection.attributeFQN

type: string

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

productOptionSelection.attributeValueId

type: int

Unique identifier of the attribute's value.

productOptionSelection.shopperEnteredValue

type: object

The value a shopper entered for an attribute that requires additional input for the product on a storefront. This entered value is a selected option or entered content for an extra, such as selecting a color or entering content for a monogram.

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

variationProductCode

type: string

Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code.

Request Body

Response Properties

Summary list of the product validation in a storefront, including options selected by the shopper.

PropertyDescription
bundledProducts

type: list of bundledProductSummary

Properties of a collection of component products that make up a single product bundle with its own product code. Tenants can define product bundles for any product type that supports the Bundle product usage.

bundledProductSummary.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

bundledProductSummary.goodsType

type: string

The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit.

bundledProductSummary.inventoryInfo

type: productInventoryInfo

Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior.

bundledProductSummary.productInventoryInfo.manageStock

type: bool

Indicates is the item's stock is managed. If true, Kibo eCommerce manages inventory levels for this product.

bundledProductSummary.productInventoryInfo.onlineLocationCode

type: string

The location code for the direct ship location associated with the available online stock.

bundledProductSummary.productInventoryInfo.onlineSoftStockAvailable

type: int

Number of product items currently available for purchase.

bundledProductSummary.productInventoryInfo.onlineStockAvailable

type: int

The current number of products that are available for purchase.

bundledProductSummary.productInventoryInfo.outOfStockBehavior

type: string

Determines the method this product uses when active stock is depeleted. Options include "DisplayMessage" to display an out of stock message to the shopper, "HideProduct" to disable the product on the storefront, or "AllowBackOrder" to allow the shopper to back order the product. This property is required only if Kibo eCommerce manages inventory for this product.

bundledProductSummary.isPackagedStandAlone

type: bool

Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself.

bundledProductSummary.measurements

type: packageMeasurements

Dimensional properties (height, length, and width) of packages, products and bundles.

bundledProductSummary.packageMeasurements.packageHeight

type: measurement

Height of a package or bundle package in imperial units of feet and inches.

bundledProductSummary.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProductSummary.packageMeasurements.measurement.value

type: decimal

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.

bundledProductSummary.packageMeasurements.packageLength

type: measurement

Length of a package or bundle package in imperial units of feet and inches.

bundledProductSummary.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProductSummary.packageMeasurements.measurement.value

type: decimal

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.

bundledProductSummary.packageMeasurements.packageWeight

type: measurement

Weight of a package or bundle package in imperial units of pounds and ounces.

bundledProductSummary.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProductSummary.packageMeasurements.measurement.value

type: decimal

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.

bundledProductSummary.packageMeasurements.packageWidth

type: measurement

Width of a package or bundle package in imperial units of feet and inches.

bundledProductSummary.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

bundledProductSummary.packageMeasurements.measurement.value

type: decimal

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.

bundledProductSummary.optionAttributeFQN

type: string

Fully qualified name of the selected option's attribute. Bundledproducts result from a static bundle or are dynamically added as a result of the shopper selecting products as extras. When the bundled item is dynamic, it includes the attribute's fully qualified name of the extra that it came from. When `optionAttributeFQN `is null, the bundled item was statically defined. When not null, the item came from an extra selection.

bundledProductSummary.optionValue

type: object

The value of the option attribute. These values are associated and used by product bundles and options.

bundledProductSummary.productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

bundledProductSummary.productName

type: string

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

bundledProductSummary.productShortDescription

type: string

Brief text description of the product or component in a product bundle, typically used when the product is displayed in a list or in search results.

bundledProductSummary.productType

type: string

A product type is like a product template.

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

categories

type: list of category

The list of all categories associated with the product. These categories contain products, can have discounts associated, and define the grouping of products to display on the storefront.

category.categoryCode

type: string

External unique identifier of the category.

category.categoryId

type: int

ID of the relevant category.

category.childrenCategories

type: list of Mozu.ProductRuntime.Contracts.Category

List of the subcategories in the hierarchy for the specified categories.

category.content

type: categoryContent

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.

category.categoryContent.categoryImages

type: list of categoryImage

Array list of media images associated to a product category. These images may be localized in the language specified by the LocaleCode. Images display with the category on the storefront according to the code and formatting of your site theme. Each image includes the name, alt text, and URL location.

category.categoryContent.categoryImage.altText

type: string

Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding.

category.categoryContent.categoryImage.cmsId

type: string

The identifier of the image in the Kibo eCommerce CMS. Supply a value for either the CMS ID or Image URL parameter.

category.categoryContent.categoryImage.imageLabel

type: string

The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site.

category.categoryContent.categoryImage.imageUrl

type: string

The URL link for the image file associated with a product or category.

category.categoryContent.categoryImage.mediaType

type: string

Type of media specification required to successfully render the image, video, or other media content for products and categories.

category.categoryContent.categoryImage.sequence

type: int

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

category.categoryContent.categoryImage.videoUrl

type: string

The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode.

category.categoryContent.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

category.categoryContent.metaTagDescription

type: string

Description defined for metadata, used to interally manage data, in the language specified by the `localeCode`. This content is used by categories, products, localized content, and SEO content.

category.categoryContent.metaTagKeywords

type: string

Keywords defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Keywords are used by content for categories, products, localized content, and SEO content.

category.categoryContent.metaTagTitle

type: string

Title defined for metadata, used to internally manage data, in the language specified by the `localeCode`. Titles are used by content for categories, products, localized content, and SEO content.

category.categoryContent.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

category.categoryContent.pageTitle

type: string

Title that appears on new product category pages, in the language specified by the `localeCode`.

category.categoryContent.slug

type: string

Slug is used in place of a name, code, or ID to give an SEO, human-friendly URL link for an object, used by categories.

category.count

type: int

The total number of associated items.

category.isDisplayed

type: bool

Indicates if the object is displayed on the storefront. If true, the admin product category is displayed in the store. If false, the category is not displayed.

category.parentCategory

type: Mozu.ProductRuntime.Contracts.Category

If applicable, the parent category in the hierarchy for the specified category.

category.sequence

type: int

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

fulfillmentTypesSupported

type: list of string

List of supported types of fulfillment for the product or variation. The types include direct ship, in-store pickup, or both.

goodsType

type: string

The type of goods in a bundled product. A bundled product is composed of products associated to sell together. Possible values include “Physical” and “DigitalCredit”. This comes from the `productType `of the product. Products are defaulted to a Physical `goodsType`. Gift cards have a `goodsType `of DigitalCredit.

image

type: productImage

The image configured for the product on the storefront.

productImage.altText

type: string

Descriptive text associated with the image or video that appears on the web storefront. This text displays on a hover-over in the browser, providing further information on the content displayed. The alternate text should be plain alphanumeric text without special characters or HTML coding.

productImage.cmsId

type: string

The identifier of the image in the Kibo eCommerce CMS. Supply a value for either the CMS ID or Image URL parameter.

productImage.imageLabel

type: string

The localized title for an image that displays on the storefront. If localized, the displayed content is set per the locale code for the site.

productImage.imageUrl

type: string

The URL link for the image file associated with a product or category.

productImage.mediaType

type: string

Type of media specification required to successfully render the image, video, or other media content for products and categories.

productImage.productImageGroupId

type: string

A unique identifier for the product image group.

productImage.sequence

type: int

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

productImage.videoUrl

type: string

The URL of a video files for a product or category. The path name is set in the language specified by the LocaleCode.

inventoryInfo

type: productInventoryInfo

Properties and data of inventory information for configured and bundled products. If product stock is managed, the data specifies out of stock behavior.

productInventoryInfo.manageStock

type: bool

Indicates is the item's stock is managed. If true, Kibo eCommerce manages inventory levels for this product.

productInventoryInfo.onlineLocationCode

type: string

The location code for the direct ship location associated with the available online stock.

productInventoryInfo.onlineSoftStockAvailable

type: int

Number of product items currently available for purchase.

productInventoryInfo.onlineStockAvailable

type: int

The current number of products that are available for purchase.

productInventoryInfo.outOfStockBehavior

type: string

Determines the method this product uses when active stock is depeleted. Options include "DisplayMessage" to display an out of stock message to the shopper, "HideProduct" to disable the product on the storefront, or "AllowBackOrder" to allow the shopper to back order the product. This property is required only if Kibo eCommerce manages inventory for this product.

isPackagedStandAlone

type: bool

Indicates if the product must be shipped alone in a container. This is used for products and products within a bundle. If true, this product cannot be shipped in a package with other items and must ship in a package by itself.

isTaxable

type: bool

Indicates if the item is subject to taxation, used by products, options, extras, cart and order items, line items, and wish lists. If true, the entity is subject to tax based on the relevant tax rate and rules.

measurements

type: packageMeasurements

Dimensional properties (height, length, and width) of packages, products and bundles.

packageMeasurements.packageHeight

type: measurement

Height of a package or bundle package in imperial units of feet and inches.

packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

packageMeasurements.measurement.value

type: decimal

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.

packageMeasurements.packageLength

type: measurement

Length of a package or bundle package in imperial units of feet and inches.

packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

packageMeasurements.measurement.value

type: decimal

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.

packageMeasurements.packageWeight

type: measurement

Weight of a package or bundle package in imperial units of pounds and ounces.

packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

packageMeasurements.measurement.value

type: decimal

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.

packageMeasurements.packageWidth

type: measurement

Width of a package or bundle package in imperial units of feet and inches.

packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

packageMeasurements.measurement.value

type: decimal

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.

mfgPartNumber

type: string

The manufacturer's part number for the product.

price

type: productPrice

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

productPrice.creditValue

type: decimal

The credit value of the product or bundled product. When the `goodsType `is `DigitalCredit`, this value is populated to indicate the value of the credit. This is used to create store credit in the fulfillment of gift cards.

productPrice.discount

type: appliedDiscount

Name of the discount added and applied to a shopping cart and order for a shopper's purchase.

productPrice.appliedDiscount.couponCode

type: string

The coupon code that a shopper uses to redeem an associated discount on a purchase. This is also the unique identifier of the coupon itself.

productPrice.appliedDiscount.discount

type: discount

Name of the discount added and applied to a shopping cart and order for a shopper's purchase.

productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

productPrice.appliedDiscount.discount.expirationDate

type: DateTime

Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only.

productPrice.appliedDiscount.discount.friendlyDescription

type: string

The localizable, shopper-facing description defined for a discount or a storefront message.

productPrice.appliedDiscount.discount.impact

type: decimal

The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price.

productPrice.appliedDiscount.discount.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

productPrice.appliedDiscount.discounts

type: list of discount

productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

productPrice.appliedDiscount.discount.expirationDate

type: DateTime

Date and time in UTC format when a discount, credit, wish list, or cart expires. An expired discount no longer can be redeemed. An expired wish list is no longer available. An expired credit can no longer be redeemed for a purchase. Acart becomes inactive and expired based on a system-calculated interval. For example, if an anonymous shopper has 14 days of inactivity, the cart is considered abandoned after that period of inactivity. System-supplied and read-only.

productPrice.appliedDiscount.discount.friendlyDescription

type: string

The localizable, shopper-facing description defined for a discount or a storefront message.

productPrice.appliedDiscount.discount.impact

type: decimal

The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price.

productPrice.appliedDiscount.discount.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

productPrice.appliedDiscount.impact

type: decimal

The value of the discount applied to the cart or order, represented as a negative currency amount to apply to the original price.

productPrice.effectivePricelistCode

type: string

The price list code if a price list is applield to the product's pricing.

productPrice.msrp

type: decimal

The manufacturer's suggested retail price (MSRP) for the product. This content may be defined by the supplier.

productPrice.price

type: decimal

The price of either the product or shipping.

This amount can be affected by discounts and/or fees. For products, this amount can also be affected by price lists.

productPrice.priceListEntryCode

type: string

The price list entry code that controls the product pricing, if a price list is applied to the product pricing.

productPrice.priceListEntryMode

type: string

The pricing mode of the price list entry, if a price list is applied to the product pricing.

The valid values are:

  • Simple
  • Bulk

A value of Bulk indicates the product has volume pricing.

productPrice.priceType

type: string

The price type that displays in the price field on product listing pages and product detail pages on the storefront.

The valid values are:

  • List
  • MAP
  • CatalogSalePrice

productPrice.salePrice

type: decimal

The set sale price for a product consisting of a price with a discount already applied.

For price list entries, this property is the product's sale price if the priceListEntryPrice.salePriceMode is set to Overridden.

productPrice.salePriceType

type: string

The sale price type that displays in the sale price field on product listing pages and product detail pages on the storefront.

The valid values are:

  • CatalogSalePrice
  • DiscountedList
  • DiscountedCatalogSalePrice

pricingBehavior

type: productPricingBehaviorInfo

Properties that describe the behavior the system uses when determining the price of products.

productPricingBehaviorInfo.discountsRestricted

type: bool

Indicates if the discount is restricted. If true, the system cannot apply any discounts to this product. Discount restrictions are defined at the master catalog level. Client administrators cannot override discount restrictions at the catalog level, but they can limit the restriction to a defined time interval.

For price list entries, specifies whether discounts are restricted for the specific entry if discountRestrictedMode is set to Overridden.

Refer to Discount Restriction in the Price Lists guides topic for more information.

productPricingBehaviorInfo.discountsRestrictedEndDate

type: DateTime

The date and time on which the discount restriction period ends.

productPricingBehaviorInfo.discountsRestrictedStartDate

type: DateTime

The date and time on which the discount restriction period starts.

productCode

type: string

The unique, user-defined product code of a product, used throughout Kibo eCommerce to reference and associate to a product.

productName

type: string

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

productShortDescription

type: string

Brief text description of the product or component in a product bundle, typically used when the product is displayed in a list or in search results.

productType

type: string

A product type is like a product template.

productUsage

type: string

The usage type that applies to this product, which is Standard (a single product without configurable options), Configurable (a product that includes configurable option attributes), Bundle (a collection of products sold as a single entity), or Component (an invididual product that represents a component in a bundle).

properties

type: list of productProperty

Collection of property attributes defined for the object. Properties are associated to all objects within Kibo eCommerce, including documents, products, and product types.

productProperty.attributeDetail

type: attributeDetail

The product attribute details common between all attribute types - properties, options, and extras.

productProperty.attributeDetail.allowFilteringAndSortingInStorefront

type: bool

Indicates whether the attribute should be able to be used in filters, facets, and sorting on the public storefront.

productProperty.attributeDetail.customWeightInStorefrontSearch

type: bool

When set to true, enables you to set a custom search weight for a product attribute in search-settings.

productProperty.attributeDetail.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

productProperty.attributeDetail.dataTypeSequence

type: int

Unique sequence of the attribute for its data type.

productProperty.attributeDetail.description

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

productProperty.attributeDetail.displayIntention

type: string

Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons.

productProperty.attributeDetail.indexValueWithCase

type: bool

Specifies whether to create a case-sensitive Solr search index. The default is false.

productProperty.attributeDetail.inputType

type: string

The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea.

productProperty.attributeDetail.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

productProperty.attributeDetail.searchableInStorefront

type: bool

Indicates if the attribute value is searchable on the public storefront.

productProperty.attributeDetail.searchDisplayValue

type: bool

Indicates what kind of values search queries and returns. If true, the system indexes the display value of string attributes instead of the canonical value for searching. Always use the canonical value for filtering. This does not apply for non-string attributes.

productProperty.attributeDetail.usageType

type: string

The usage type of the product attribute, which is property, option, or extra.

productProperty.attributeDetail.validation

type: attributeValidation

Properties used when validating a value entered for an object, including extensible attributes, products attributes, and database entries.

productProperty.attributeDetail.attributeValidation.maxDateValue

type: DateTime

The maximum date allowed including month, day, and year. System-supplied and read-only.

productProperty.attributeDetail.attributeValidation.maxNumericValue

type: double

The maximum number that can be entered as a value for an extensible attribute.

productProperty.attributeDetail.attributeValidation.maxStringLength

type: int

The maximum character length possible for a string value entered for an extensible attribute.

productProperty.attributeDetail.attributeValidation.minDateValue

type: DateTime

The minimum date allowed including month, day, and year. System-supplied and read-only.

productProperty.attributeDetail.attributeValidation.minNumericValue

type: double

The minimum numeric value required to validate an extensible attribute.

productProperty.attributeDetail.attributeValidation.minStringLength

type: int

The minimum character length possible for a string value entered for an extensible attribute.

productProperty.attributeDetail.attributeValidation.regularExpression

type: string

Regular expression used to process and validate an extensible attribute value that require special formatting, such as phone numbers.

productProperty.attributeDetail.valueType

type: string

An attribute value type is either predefined vocabulary set by the admin during attribute set up, or user-defined with an appropriate type (AdminEntered or ShopperEntered, depending on the user). These types are used by products and attributes. To use a predefined value, you can set this parameter as "predefined" and whatever the admin entered in the Product Attributes > Create New Attribute interface menu will become the predefined value on the attribute. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order.

productProperty.attributeFQN

type: string

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

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

productProperty.isMultiValue

type: bool

Indicates if the object has or can have multiple properties or values. If true, the object can have more than one value, selectable by shoppers through the storefront or configurable through the catalogs.

productProperty.values

type: list of productPropertyValue

List of value data for objects.

productProperty.productPropertyValue.displayInfo

type: attributeVocabularyValueDisplayInfo

Defines the intended display of this attribute in the storefront. Options include Drop Down, Image Picker, and Radio Buttons.

productProperty.productPropertyValue.attributeVocabularyValueDisplayInfo.cmsId

type: string

The identifier of the image in the Kibo eCommerce CMS. Supply a value for either the CMS ID or Image URL parameter.

productProperty.productPropertyValue.attributeVocabularyValueDisplayInfo.colorValue

type: string

Hex value for a color to display in a color picker. This is an HTML supported code for color.

productProperty.productPropertyValue.attributeVocabularyValueDisplayInfo.imageUrl

type: string

The URL link for the image file associated with a product or category.

productProperty.productPropertyValue.stringValue

type: string

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

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

purchasableState

type: productPurchasableState

The current state of the configured product determines whether or not the product is eligible for purchase. Products with options are only purchasable if the shopper has selected all required options. If the product is not ready for purchase, a message lists missing options that are required.

productPurchasableState.isPurchasable

type: bool

If true, the entity has met all requirements and considered a purchasable entity.

productPurchasableState.messages

type: list of validationMessage

Array list of validation and status messages associated with shipping rates, orders, and product purchasable state.

productPurchasableState.validationMessage.message

type: string

The text of the change message, such as "This product is no longer available." System-supplied and read-only.

productPurchasableState.validationMessage.severity

type: string

The severity level of validation failures for shipping rates and products.

productPurchasableState.validationMessage.source

type: string

Source for an action or container for originating content. Source is used as an origin for validation and notification messages based on successful or failed actions. For originating content, source is used for the facet source information, including the category, price, or attribute properties.

productPurchasableState.validationMessage.sourceId

type: string

Unique identifier of the entity that triggered the validation.

productPurchasableState.validationMessage.validationType

type: string

Type of validation error that occurred. This can be checked programatically. Must be one of the values in ValidationTypeConst.

purchaseLocation

type: string

The location where the order item(s) was purchased.

upc

type: string

The universal product code (UPC) is the barcode defined for the product. The UPC is unique across all sales channels.

variationProductCode

type: string

Merchant-created code associated with a specific product variation. Variation product codes maintain an association with the base product code.

Response Body