commerce/catalog/storefront/productsearch

Use the Product Search resource to provide dynamic search results to shoppers as they browse and search for products on the web storefront, and to suggest possible search terms as the shopper enters text.

JSON Example

ProductSearchResult Properties

Property Description
facets

type: list of facet

The facets applied to index products in the product search result.

facet.facetType

type: string

The type of facet. Valid values are "range" (enables creation of a range of values) or "value" (populates the facet values based on the associated attribute or category).

facet.field

type: string

A property that is a wrapper for additional properties pertaining to the schema such as the type, label, any associated data, an ID, and the order of the response.

facet.label

type: string

Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information.

facet.values

type: list of facetValue

List of value data for objects.

facet.facetValue.childrenFacetValues

type: list of Mozu.ProductRuntime.Contracts.FacetValue

If applicable, the values of any subcategory facets in a hierarchy. Hierarchical facets only apply for product categories.

facet.facetValue.count

type: int

The total number of associated items.

facet.facetValue.filterValue

type: string

Submits the selected facet value as a facet value filter.

facet.facetValue.isApplied

type: bool

If true, the facet value is applied as a filter in the storefront product search.

facet.facetValue.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.

facet.facetValue.label

type: string

Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information.

facet.facetValue.parentFacetValue

type: string

If applicable, the values of any parent category facets in a hierarchy. Hierarchical facets only apply for product categories.

facet.facetValue.rangeQueryValueEnd

type: string

The maximum value selected or entered for the facet range query.

facet.facetValue.rangeQueryValueStart

type: string

The minimum value selected or entered for the facet range query.

facet.facetValue.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.

items

type: list of product

A list of requested items. All returned data is provided in an items array.

For a failed request, the returned response may be success with an empty item array.

product.availableShippingDiscounts

type: list of discount

List of shipping discounts that can be applied to the configured product. These discounts are calculated and updated as shoppers add content to their cart and continue checkout steps to order submission.

product.discount.discountId

type: int

The unique identifier of the discount.

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

product.discount.friendlyDescription

type: string

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

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

product.discount.name

type: string

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

product.bundledProducts

type: list of bundledProduct

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.

product.bundledProduct.content

type: productContent

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.

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.productFullDescription

type: string

Lengthy full description for a product description, displayed on product detail pages within the storefront.

product.bundledProduct.productContent.productImages

type: list of productImage

List of image files associated with a product. This content may include the image file URL, name, and other information as available.

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.productImage.imageUrl

type: string

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

product.bundledProduct.productContent.productImage.mediaType

type: string

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

product.bundledProduct.productContent.productImage.sequence

type: int

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

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.productName

type: string

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

product.bundledProduct.productContent.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.

product.bundledProduct.productContent.seoFriendlyUrl

type: string

The search engine optimized, human-readable portion of the URL. The content is localized according to the product's `localeCode`.

product.bundledProduct.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.

product.bundledProduct.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.

product.bundledProduct.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.

product.bundledProduct.productInventoryInfo.manageStock

type: bool

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

product.bundledProduct.productInventoryInfo.onlineLocationCode

type: string

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

product.bundledProduct.productInventoryInfo.onlineSoftStockAvailable

type: int

Number of product items currently available for purchase.

product.bundledProduct.productInventoryInfo.onlineStockAvailable

type: int

The current number of products that are available for purchase.

product.bundledProduct.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.

product.bundledProduct.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.

product.bundledProduct.measurements

type: packageMeasurements

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

product.bundledProduct.packageMeasurements.packageHeight

type: measurement

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

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.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.

product.bundledProduct.packageMeasurements.packageLength

type: measurement

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

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.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.

product.bundledProduct.packageMeasurements.packageWeight

type: measurement

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

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.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.

product.bundledProduct.packageMeasurements.packageWidth

type: measurement

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

product.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.bundledProduct.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.

product.bundledProduct.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.

product.bundledProduct.optionValue

type: object

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

product.bundledProduct.productCode

type: string

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

product.bundledProduct.productType

type: string

A product type is like a product template.

product.bundledProduct.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.

product.catalogEndDate

type: DateTime

The date and time in UTC when the product is no longer active in the catalog.

product.catalogStartDate

type: DateTime

The date and time in UTC format when the product is active in the catalog.

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

product.category.categoryCode

type: string

External unique identifier of the category.

product.category.categoryId

type: int

ID of the relevant category.

product.category.childrenCategories

type: list of Mozu.ProductRuntime.Contracts.Category

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

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

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

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

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

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

product.category.categoryContent.categoryImage.imageUrl

type: string

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

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

product.category.categoryContent.categoryImage.sequence

type: int

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

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

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

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

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

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

product.category.categoryContent.name

type: string

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

product.category.categoryContent.pageTitle

type: string

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

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

product.category.count

type: int

The total number of associated items.

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

product.category.parentCategory

type: Mozu.ProductRuntime.Contracts.Category

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

product.category.sequence

type: int

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

product.content

type: productContent

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.

product.productContent.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.

product.productContent.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.

product.productContent.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.

product.productContent.productFullDescription

type: string

Lengthy full description for a product description, displayed on product detail pages within the storefront.

product.productContent.productImages

type: list of productImage

List of image files associated with a product. This content may include the image file URL, name, and other information as available.

product.productContent.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.

product.productContent.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.

product.productContent.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.

product.productContent.productImage.imageUrl

type: string

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

product.productContent.productImage.mediaType

type: string

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

product.productContent.productImage.sequence

type: int

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

product.productContent.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.

product.productContent.productName

type: string

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

product.productContent.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.

product.productContent.seoFriendlyUrl

type: string

The search engine optimized, human-readable portion of the URL. The content is localized according to the product's `localeCode`.

product.createDate

type: DateTime

The date and time in UTC format set when the object was created.

product.dateFirstAvailableInCatalog

type: DateTime

The date and time in UTC format when the product first became available in the catalog. This field is used to calculate the number of days the product has been available in the catalog for a dynamic expression.

product.daysAvailableInCatalog

type: int

The total number of days the product has been available in the catalog. This field is related to the DaysAvailableInCatalog field in a dynamic expression.

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

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

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

product.productInventoryInfo.manageStock

type: bool

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

product.productInventoryInfo.onlineLocationCode

type: string

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

product.productInventoryInfo.onlineSoftStockAvailable

type: int

Number of product items currently available for purchase.

product.productInventoryInfo.onlineStockAvailable

type: int

The current number of products that are available for purchase.

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

product.isActive

type: bool

Indicates if the object or feature is active.

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.

product.isRecurring

type: bool

Indicates if the product in a cart, order, or wish list is purchased on a recurring schedule. If true, the item can be purchased or fulfilled at regular intervals, such as a monthly billing cycle. For example, digital or physical product subscriptions are recurring cart items. This property is not used at this time and is reserved for future functionality.

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

product.locationsInStock

type: list of string

product.measurements

type: packageMeasurements

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

product.packageMeasurements.packageHeight

type: measurement

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

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

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

product.packageMeasurements.packageLength

type: measurement

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

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

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

product.packageMeasurements.packageWeight

type: measurement

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

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

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

product.packageMeasurements.packageWidth

type: measurement

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

product.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

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

product.mfgPartNumber

type: string

The manufacturer's part number for the product.

product.mfgPartNumbers

type: list of string

The list of manufacturer part numbers defined for the product.

product.options

type: list of productOption

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

product.productOption.attributeDetail

type: attributeDetail

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

product.productOption.attributeDetail.allowFilteringAndSortingInStorefront

type: bool

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

product.productOption.attributeDetail.customWeightInStorefrontSearch

type: bool

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

product.productOption.attributeDetail.dataType

type: string

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

product.productOption.attributeDetail.dataTypeSequence

type: int

Unique sequence of the attribute for its data type.

product.productOption.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.

product.productOption.attributeDetail.displayIntention

type: string

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

product.productOption.attributeDetail.indexValueWithCase

type: bool

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

product.productOption.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.

product.productOption.attributeDetail.name

type: string

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

product.productOption.attributeDetail.searchableInStorefront

type: bool

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

product.productOption.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.

product.productOption.attributeDetail.usageType

type: string

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

product.productOption.attributeDetail.validation

type: attributeValidation

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

product.productOption.attributeDetail.attributeValidation.maxDateValue

type: DateTime

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

product.productOption.attributeDetail.attributeValidation.maxNumericValue

type: double

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

product.productOption.attributeDetail.attributeValidation.maxStringLength

type: int

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

product.productOption.attributeDetail.attributeValidation.minDateValue

type: DateTime

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

product.productOption.attributeDetail.attributeValidation.minNumericValue

type: double

The minimum numeric value required to validate an extensible attribute.

product.productOption.attributeDetail.attributeValidation.minStringLength

type: int

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

product.productOption.attributeDetail.attributeValidation.regularExpression

type: string

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

product.productOption.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.

product.productOption.attributeFQN

type: string

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

product.productOption.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.

product.productOption.isRequired

type: bool

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

product.productOption.values

type: list of productOptionValue

List of value data for objects.

product.productOption.productOptionValue.attributeValueId

type: int

Unique identifier of the attribute's value.

product.productOption.productOptionValue.bundledProduct

type: bundledProduct

Properties of a component product in a product bundle. A product bundle can represent either a collection of multiple products sold as a single entity, or a collection of the same product sold as a package. For example, a 10-pack of socks.

product.productOption.productOptionValue.bundledProduct.content

type: productContent

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.

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.productFullDescription

type: string

Lengthy full description for a product description, displayed on product detail pages within the storefront.

product.productOption.productOptionValue.bundledProduct.productContent.productImages

type: list of productImage

List of image files associated with a product. This content may include the image file URL, name, and other information as available.

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.productImage.imageUrl

type: string

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

product.productOption.productOptionValue.bundledProduct.productContent.productImage.mediaType

type: string

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

product.productOption.productOptionValue.bundledProduct.productContent.productImage.sequence

type: int

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

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.productName

type: string

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

product.productOption.productOptionValue.bundledProduct.productContent.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.

product.productOption.productOptionValue.bundledProduct.productContent.seoFriendlyUrl

type: string

The search engine optimized, human-readable portion of the URL. The content is localized according to the product's `localeCode`.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.productInventoryInfo.manageStock

type: bool

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

product.productOption.productOptionValue.bundledProduct.productInventoryInfo.onlineLocationCode

type: string

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

product.productOption.productOptionValue.bundledProduct.productInventoryInfo.onlineSoftStockAvailable

type: int

Number of product items currently available for purchase.

product.productOption.productOptionValue.bundledProduct.productInventoryInfo.onlineStockAvailable

type: int

The current number of products that are available for purchase.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.measurements

type: packageMeasurements

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

product.productOption.productOptionValue.bundledProduct.packageMeasurements.packageHeight

type: measurement

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

product.productOption.productOptionValue.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.packageMeasurements.packageLength

type: measurement

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

product.productOption.productOptionValue.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.packageMeasurements.packageWeight

type: measurement

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

product.productOption.productOptionValue.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.packageMeasurements.packageWidth

type: measurement

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

product.productOption.productOptionValue.bundledProduct.packageMeasurements.measurement.unit

type: string

The unit of measurement, such as length or weight.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.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.

product.productOption.productOptionValue.bundledProduct.optionValue

type: object

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

product.productOption.productOptionValue.bundledProduct.productCode

type: string

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

product.productOption.productOptionValue.bundledProduct.productType

type: string

A product type is like a product template.

product.productOption.productOptionValue.bundledProduct.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.

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

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

product.productOption.productOptionValue.displayInfo

type: attributeVocabularyValueDisplayInfo

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

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

product.productOption.productOptionValue.attributeVocabularyValueDisplayInfo.colorValue

type: string

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

product.productOption.productOptionValue.attributeVocabularyValueDisplayInfo.imageUrl

type: string

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

product.productOption.productOptionValue.isDefault

type: bool

Indicates if the object is default. This indicator is used for product variations and site search settings. If true, the value/object is the default option.

product.productOption.productOptionValue.isEnabled

type: bool

Indicates if the object or process is enabled. This indicator is used on external payment workflows and product option values. For product options, if true, the product option value is available for a shopper to choose. During configuration, this property will be false if the option value is invalid with other selected options. For external payment workflows, if true, the workflow is enabled and available for routing payments for the submitted order.

product.productOption.productOptionValue.isSelected

type: bool

If true, the entity is selected. If false, the entity is not selected.

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

product.productOption.productOptionValue.stringValue

type: string

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

product.productOption.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.

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.

product.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

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

product.productPrice.discount

type: appliedDiscount

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

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

product.productPrice.appliedDiscount.discount

type: discount

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

product.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

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

product.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

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

product.productPrice.appliedDiscount.discount.name

type: string

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

product.productPrice.appliedDiscount.discounts

type: list of discount

product.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

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

product.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

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

product.productPrice.appliedDiscount.discount.name

type: string

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

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

product.productPrice.effectivePricelistCode

type: string

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

product.productPrice.msrp

type: decimal

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

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

product.productPrice.priceListEntryCode

type: string

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

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

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

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

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

product.priceRange

type: productPriceRange

For products with options that vary the cost of the product, the range between lowest and highest possible price of the product based on the current selection of options.

product.productPriceRange.lower

type: productPrice

The lowest possible price value for a product with options that vary the cost of the product.

product.productPriceRange.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productPriceRange.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

product.productPriceRange.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.

product.productPriceRange.productPrice.discount

type: appliedDiscount

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount

type: discount

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

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.productPrice.appliedDiscount.discounts

type: list of discount

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.effectivePricelistCode

type: string

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

product.productPriceRange.productPrice.msrp

type: decimal

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

product.productPriceRange.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.

product.productPriceRange.productPrice.priceListEntryCode

type: string

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

product.productPriceRange.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.

product.productPriceRange.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

product.productPriceRange.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.

product.productPriceRange.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

product.productPriceRange.upper

type: productPrice

The highest possible price value for a product with options that vary the cost of the product.

product.productPriceRange.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productPriceRange.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

product.productPriceRange.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.

product.productPriceRange.productPrice.discount

type: appliedDiscount

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount

type: discount

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

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.productPrice.appliedDiscount.discounts

type: list of discount

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.effectivePricelistCode

type: string

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

product.productPriceRange.productPrice.msrp

type: decimal

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

product.productPriceRange.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.

product.productPriceRange.productPrice.priceListEntryCode

type: string

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

product.productPriceRange.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.

product.productPriceRange.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

product.productPriceRange.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.

product.productPriceRange.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

product.pricingBehavior

type: productPricingBehaviorInfo

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

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

product.productPricingBehaviorInfo.discountsRestrictedEndDate

type: DateTime

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

product.productPricingBehaviorInfo.discountsRestrictedStartDate

type: DateTime

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

product.productCode

type: string

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

product.productSequence

type: int

Integer that represents the sequential order of the product.

product.productType

type: string

A product type is like a product template.

product.productTypeId

type: int

The unique identifier of the product type of the product.

product.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).

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

product.productProperty.attributeDetail

type: attributeDetail

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

product.productProperty.attributeDetail.allowFilteringAndSortingInStorefront

type: bool

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

product.productProperty.attributeDetail.customWeightInStorefrontSearch

type: bool

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

product.productProperty.attributeDetail.dataType

type: string

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

product.productProperty.attributeDetail.dataTypeSequence

type: int

Unique sequence of the attribute for its data type.

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

product.productProperty.attributeDetail.displayIntention

type: string

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

product.productProperty.attributeDetail.indexValueWithCase

type: bool

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

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

product.productProperty.attributeDetail.name

type: string

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

product.productProperty.attributeDetail.searchableInStorefront

type: bool

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

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

product.productProperty.attributeDetail.usageType

type: string

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

product.productProperty.attributeDetail.validation

type: attributeValidation

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

product.productProperty.attributeDetail.attributeValidation.maxDateValue

type: DateTime

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

product.productProperty.attributeDetail.attributeValidation.maxNumericValue

type: double

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

product.productProperty.attributeDetail.attributeValidation.maxStringLength

type: int

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

product.productProperty.attributeDetail.attributeValidation.minDateValue

type: DateTime

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

product.productProperty.attributeDetail.attributeValidation.minNumericValue

type: double

The minimum numeric value required to validate an extensible attribute.

product.productProperty.attributeDetail.attributeValidation.minStringLength

type: int

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

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

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

product.productProperty.attributeFQN

type: string

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

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

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

product.productProperty.values

type: list of productPropertyValue

List of value data for objects.

product.productProperty.productPropertyValue.displayInfo

type: attributeVocabularyValueDisplayInfo

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

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

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

product.productProperty.productPropertyValue.attributeVocabularyValueDisplayInfo.imageUrl

type: string

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

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

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

product.publishState

type: string

The current state of the document or product definition. States for documents include Active, Draft, or Latest. Active documents are published and cannot be deleted. Querying Latest returns the most recent version of the document, regardless of whether it is published or a draft. States for product include New, Draft, or Live.

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

product.productPurchasableState.isPurchasable

type: bool

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

product.productPurchasableState.messages

type: list of validationMessage

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

product.productPurchasableState.validationMessage.message

type: string

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

product.productPurchasableState.validationMessage.severity

type: string

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

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

product.productPurchasableState.validationMessage.sourceId

type: string

Unique identifier of the entity that triggered the validation.

product.productPurchasableState.validationMessage.validationType

type: string

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

product.purchaseLocation

type: string

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

product.upc

type: string

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

product.upCs

type: list of string

The list of universal product codes defined for the product.

product.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

product.validPriceLists

type: list of string

A list of price lists for which the product is valid.

product.variationProductCode

type: string

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

product.variations

type: list of variationSummary

A summary of all variations that exist for the product.

product.variationSummary.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.

product.variationSummary.productInventoryInfo.manageStock

type: bool

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

product.variationSummary.productInventoryInfo.onlineLocationCode

type: string

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

product.variationSummary.productInventoryInfo.onlineSoftStockAvailable

type: int

Number of product items currently available for purchase.

product.variationSummary.productInventoryInfo.onlineStockAvailable

type: int

The current number of products that are available for purchase.

product.variationSummary.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.

product.variationSummary.options

type: list of variationOption

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

product.variationSummary.variationOption.attributeFQN

type: string

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

product.variationSummary.variationOption.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.

product.variationSummary.variationOption.valueSequence

type: int

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

product.variationSummary.productCode

type: string

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

product.volumePriceBands

type: list of productVolumePrice

The details of any volume price bands associated with the product.

Refer to Volume Pricing for more information.

Note:  In a GetProducts call, the volume price bands are not returned in the response by default. To return the volume price bands in the GetProducts response, set the responseOptions parameter in the GetProducts call to VolumePriceBands.

product.productVolumePrice.isCurrent

type: bool

Specifies whether the volume pricing is current for the product.

product.productVolumePrice.maxQty

type: int

The maximum product quantity of the volume price band. A shopper must purchase a quantity equal to or less than down to the minQty in order to receive the pricing in the volume band.

product.productVolumePrice.minQty

type: int

The minimum product quantity of the volume price band. A shopper must purchase a quantity equal to or greater than up to the maxQty in order to receive the pricing in the volume band.

product.productVolumePrice.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.

product.productVolumePrice.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productVolumePrice.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

product.productVolumePrice.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.

product.productVolumePrice.productPrice.discount

type: appliedDiscount

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

product.productVolumePrice.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.

product.productVolumePrice.productPrice.appliedDiscount.discount

type: discount

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

product.productVolumePrice.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productVolumePrice.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.

product.productVolumePrice.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productVolumePrice.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.

product.productVolumePrice.productPrice.appliedDiscount.discount.name

type: string

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

product.productVolumePrice.productPrice.appliedDiscount.discounts

type: list of discount

product.productVolumePrice.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productVolumePrice.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.

product.productVolumePrice.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productVolumePrice.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.

product.productVolumePrice.productPrice.appliedDiscount.discount.name

type: string

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

product.productVolumePrice.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.

product.productVolumePrice.productPrice.effectivePricelistCode

type: string

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

product.productVolumePrice.productPrice.msrp

type: decimal

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

product.productVolumePrice.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.

product.productVolumePrice.productPrice.priceListEntryCode

type: string

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

product.productVolumePrice.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.

product.productVolumePrice.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

product.productVolumePrice.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.

product.productVolumePrice.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

product.productVolumePrice.priceRange

type: productPriceRange

For products with options that vary the cost of the product, the range between lowest and highest possible price of the product based on the current selection of options.

product.productVolumePrice.productPriceRange.lower

type: productPrice

The lowest possible price value for a product with options that vary the cost of the product.

product.productVolumePrice.productPriceRange.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productVolumePrice.productPriceRange.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.discount

type: appliedDiscount

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount

type: discount

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

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discounts

type: list of discount

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.effectivePricelistCode

type: string

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

product.productVolumePrice.productPriceRange.productPrice.msrp

type: decimal

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.priceListEntryCode

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.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

product.productVolumePrice.productPriceRange.upper

type: productPrice

The highest possible price value for a product with options that vary the cost of the product.

product.productVolumePrice.productPriceRange.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productVolumePrice.productPriceRange.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.discount

type: appliedDiscount

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount

type: discount

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

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discounts

type: list of discount

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.effectivePricelistCode

type: string

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

product.productVolumePrice.productPriceRange.productPrice.msrp

type: decimal

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.productPrice.priceListEntryCode

type: string

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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.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

product.productVolumePrice.productPriceRange.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.

product.productVolumePrice.productPriceRange.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

product.volumePriceRange

type: productPriceRange

The details of the volume price range associated with the product. Volume price ranges consist of a lower price and an upper price, and either lower or upper prices can be affected by discounts.

You can display the volume price range on product listing pages, such as category and search result pages, and product detail pages.

Refer to Volume Pricing Storefront Behavior for more information.

product.productPriceRange.lower

type: productPrice

The lowest possible price value for a product with options that vary the cost of the product.

product.productPriceRange.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productPriceRange.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

product.productPriceRange.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.

product.productPriceRange.productPrice.discount

type: appliedDiscount

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount

type: discount

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

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.productPrice.appliedDiscount.discounts

type: list of discount

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.effectivePricelistCode

type: string

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

product.productPriceRange.productPrice.msrp

type: decimal

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

product.productPriceRange.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.

product.productPriceRange.productPrice.priceListEntryCode

type: string

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

product.productPriceRange.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.

product.productPriceRange.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

product.productPriceRange.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.

product.productPriceRange.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

product.productPriceRange.upper

type: productPrice

The highest possible price value for a product with options that vary the cost of the product.

product.productPriceRange.productPrice.catalogListPrice

type: decimal

The list price of the product in the catalog.

product.productPriceRange.productPrice.catalogSalePrice

type: decimal

The sale price defined for the product in the catalog.

product.productPriceRange.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.

product.productPriceRange.productPrice.discount

type: appliedDiscount

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount

type: discount

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

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.productPrice.appliedDiscount.discounts

type: list of discount

product.productPriceRange.productPrice.appliedDiscount.discount.discountId

type: int

The unique identifier of the discount.

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.friendlyDescription

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.appliedDiscount.discount.name

type: string

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

product.productPriceRange.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.

product.productPriceRange.productPrice.effectivePricelistCode

type: string

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

product.productPriceRange.productPrice.msrp

type: decimal

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

product.productPriceRange.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.

product.productPriceRange.productPrice.priceListEntryCode

type: string

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

product.productPriceRange.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.

product.productPriceRange.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

product.productPriceRange.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.

product.productPriceRange.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

nextCursorMark

type: string

This parameter is associated with deep paging. If you started a deep paged request by specifying cursorMark=*, Kibo eCommerce returns an encoded value for the nextCursorMark. In your most immediate subsequent request, set cursorMark to the same value you received for nextCursorMark to continue paging. When nextCursorMark is null, you've reached the end of paged results.

pageCount

type: int

The total number of pages of the results divided per the `pageSize`.

pageSize

type: int

The number of results to display on each page when creating paged results from a query. The amount is divided and displayed on the `pageCount `amount of pages. The default is 20 and maximum value is 200 per page.

solrDebugInfo

type: solrDebugInfo

A container of debugging information from Solr.

solrDebugInfo.blockedProductCodes

type: list of string

A list of products that have been blocked in Solr by search tuning rules.

solrDebugInfo.boostedProductCodes

type: list of string

A list of products that have been boosted in Solr by search tuning rules.

solrDebugInfo.boostFunctions

type: list of string

A list of boost functions sent to Solr by search tuning rules.

solrDebugInfo.boostQueries

type: list of string

A list of boost queries sent to Solr by search tuning rules.

solrDebugInfo.searchTuningRuleCode

type: string

A list of search tuning rule codes sent to Solr.

startIndex

type: int

When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a `pageSize `of 25, to get the 51st through the 75th items, use `startIndex=50`.

totalCount

type: int

The total number of items in the list.

Operations

Operation Name Request URI Description
GetRandomAccessCursor GET randomAccessCursor%2f%3fquery%3d%7bquery%7d%26filter%3d%7bfilter%7d%26pageSize%3d%7bpageSize%7d%26responseFields%3d%7bresponseFields%7d Note:  This operation is associated with deep paging, which is an optimized search method for retrieving greater than 5,000 results at a time. More specifically, this operation is associated with random access deep paging (rather than serial deep paging, which is available using the cursorMark parameter of the Search operation in the commerce/catalog/storefront/productSearch resource or the GetProducts operation in the commerce/catalog/storefront/products resource). In general, Kibo eCommerce recommends that you use serial deep paging for retrieving large result quantities. However, if you are performing sitemap generation or require parallel access to different sets of search results, you should use random access deep paging,

Random access paging computes a set of cursorMarks, which can each then be provided to the Search operation in the commerce/catalog/storefront/productSearch resource or the GetProducts operation in the commerce/catalog/storefront/products resource. You can provide the computed groups in any order to the operations, and can therefore parallelize calls to retrieve products more quickly. To generate the set of cursorMarks, call this (GetRandomAccessCursor) operation, in which you can optionally provide query and/or filter parameters to limit the products matched by the cursor. After executing this operation, pass one of the returned cursorMarks to the cursorMark parameter of the Search or GetProducts operations.

Note:  When you pass a set of cursorMarks to the Search or GetProducts operations, do not provide query, sort, or filter parameters. Querying and filtering should only occur when generating the cursor, and sorting cannot execute at the later phase. In addition, if the cursorMarks contain special characters, you must apply URL encoding to them.
Search GET search%2f%3fquery%3d%7bquery%7d%26filter%3d%7bfilter%7d%26facetTemplate%3d%7bfacetTemplate%7d%26facetTemplateSubset%3d%7bfacetTemplateSubset%7d%26facet%3d%7bfacet%7d%26facetFieldRangeQuery%3d%7bfacetFieldRangeQuery%7d%26facetHierPrefix%3d%7bfacetHierPrefix%7d%26facetHierValue%3d%7bfacetHierValue%7d%26facetHierDepth%3d%7bfacetHierDepth%7d%26facetStartIndex%3d%7bfacetStartIndex%7d%26facetPageSize%3d%7bfacetPageSize%7d%26facetSettings%3d%7bfacetSettings%7d%26facetValueFilter%3d%7bfacetValueFilter%7d%26sortBy%3d%7bsortBy%7d%26pageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26searchSettings%3d%7bsearchSettings%7d%26enableSearchTuningRules%3d%7benableSearchTuningRules%7d%26searchTuningRuleContext%3d%7bsearchTuningRuleContext%7d%26searchTuningRuleCode%3d%7bsearchTuningRuleCode%7d%26facetTemplateExclude%3d%7bfacetTemplateExclude%7d%26facetPrefix%3d%7bfacetPrefix%7d%26responseOptions%3d%7bresponseOptions%7d%26cursorMark%3d%7bcursorMark%7d%26facetValueSort%3d%7bfacetValueSort%7d%26defaultSort%3d%7bdefaultSort%7d%26sortDefinitionName%3d%7bsortDefinitionName%7d%26defaultSortDefinitionName%3d%7bdefaultSortDefinitionName%7d%26responseFields%3d%7bresponseFields%7d

Searches the categories displayed on the web storefront for products or product options that the shopper types in a search query.

Suggest GET suggest%3fquery%3d%7bquery%7d%26groups%3d%7bgroups%7d%26pageSize%3d%7bpageSize%7d%26responseFields%3d%7bresponseFields%7d

Suggests possible search terms as the shopper enters search text.