Search Products

get https://t{tenantId}-s{siteId}.{env}.usc1.kibocommerce.com/api/commerce/catalog/storefront/productsearch/search

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

Query Params

query

string

The terms to search on.

collapse

boolean

Defaults to true

filter

string

A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.

facetTemplate

string

facetTemplateSubset

string

facet

string

facetFieldRangeQuery

string

facetHierPrefix

string

facetHierValue

string

facetHierDepth

string

facetStartIndex

string

facetPageSize

string

facetSettings

string

facetValueFilter

string

sortBy

string

The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.

pageSize

int32

Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 12 and the maximum value is 200. Optional.

startIndex

int32

Defaults to 0

Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. The default value is 0. Optional.

searchSettings

string

enableSearchTuningRules

boolean

Defaults to true

searchTuningRuleContext

string

searchTuningRuleCode

string

responseGroups

string

facetTemplateExclude

string

facetPrefix

string

responseOptions

string

cursorMark

string

Pass in * to begin a deep page operation. The response will include a nextCursorMark value. Pass this into the next call. Continue with this pattern until nextCursorMark is null.

facetValueSort

string

defaultSort

string

shouldSlice

boolean

mid

string

omitNamespace

boolean

includeAllImages

boolean

Defaults to false

Optional. If true return all images instead of default images.

spellcorrectOverride

string

Defaults to Default

useSubscriptionPricing

boolean

Defaults to false

merchandizingRuleCode

string

Optional. Use a specific search-merchandizing-rule code if provided.

customerSegments

string

responseFields

string

limits which fields are returned in the response body

Response

Response body

object

facets

array of objects | null

facets

object

label

string | null

facetType

string | null

Value, RangeQuery, Hierarchy

field

string | null

values

array of objects | null

values

object

label

string | null

isApplied

boolean | null

True if this FacetValue was supplied as a facet value filter in the current search

count

int32

Number of occurrences of FacetValue in result set.

value

string | null

String representation of Facet Value

filterValue

string | null

Submit this as a facet value filter

rangeQueryValueStart

string | null

When range query Facet

rangeQueryValueEnd

string | null

When range query Facet

parentFacetValue

string | null

When hierarchical Facet

isDisplayed

boolean

Indicates whether the FacetValue should be displayed

childrenFacetValues

array of objects | null

When hierarchical Facet

childrenFacetValues

object

solrDebugInfo

object

searchTuningRuleCode

string | null

boostedProductCodes

array of strings | null

boostedProductCodes

blockedProductCodes

array of strings | null

blockedProductCodes

boostQueries

array of strings | null

boostQueries

boostFunctions

array of strings | null

boostFunctions

solrUrl

string | null

searchRedirect

string | null

searchEngine

string | null

nextCursorMark

string | null

spellcheck

object

Spellcheck related results

candidateCorrections

array of objects | null

candidateCorrections

object

query

string | null

Collation query from search engine

autoCorrected

boolean | null

originalQuery

string | null

correctedQuery

string | null

startIndex

int32

pageSize

int32

pageCount

int32

totalCount

int32

items

array of objects | null

items

object

productCode

string | null

Merchant-created code associated with the product, for example, a SKU.

purchaseLocation

string | null

The location where the product is being purchased.. default is null. Products can have different prices
by purchaseLocation via custom priceListResolution....

productSequence

int32 | null

System generated monotonically increasing sequence

productUsage

string | null

The UsageType of this product (Standard, Configurable, Bundle, Component, Collection)

fulfillmentTypesSupported

array of strings | null

Indicates the fulfillment types the product supports.

fulfillmentTypesSupported

goodsType

string | null

The GoodsType of the product (Physical, Digital, DigitalCredit....)

bundledProducts

array of objects | null

The list of Bundled products included in this product. This is only populated when ProductUsage=Bundle

bundledProducts

object

content

object

Name of the product and, if supplied, description, metatags, friendly URL, and associated images.

productCode

string | null

Merchant-created code associated with the product, for example, a SKU.

goodsType

string | null

The GoodsType of this product (Physical, Digital, DigitalCredit)

quantity

int32

The quantity of the bundled product

measurements

object

Physical dimensions of the package required to ship the product and its weight.

isPackagedStandAlone

boolean | null

Is this product shipped in its own package

inventoryInfo

object

Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.

optionAttributeFQN

string | null

Fully Qualified Name of the selected option's attribute (only applies to Products as extras)

optionValue

string

Value of the selected option (only applies to Products as extras)

creditValue

double | null

Credit Value applicable to this product. Should only be present on DigitalCredit goodsType....

productType

string | null

content

object

Name of the product and, if supplied, description, metatags, friendly URL, and associated images.

purchasableState

object

Current state of the product purchase, that is, whether it is ready to be purchased. For products with configurable options, /// the product is purchaseable if the shopper has selected all required options. If not, a message lists which required options are missing.

isActive

boolean | null

If true, the product exists. If not, the product should not appear in search results.

publishState

string | null

Represents the published state of the product returned. Valid values for ValueType are defined in PublishStateConst.

price

object

Price of the product with any sale and discounts applied.

priceRange

object

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.

volumePriceBands

array of objects | null

For products with bulk pricing... this will be populated with pricebands, depending on what options have been selected...

volumePriceBands

object

isCurrent

boolean

minQty

int32

maxQty

int32 | null

priceRange

object

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.

price

object

Price of the product with any sale and discounts applied.

volumePriceRange

object

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.

availableShippingDiscounts

array of objects | null

List of potential shipping discounts available for this product.

availableShippingDiscounts

object

discountId

int32

Unique identifier of the discount.

expirationDate

date-time | null

Date when the discount expires.

name

string | null

Name of the discount.

friendlyDescription

string | null

Description of the discount.

impact

double

The Impact of the individual Discount

productType

string | null

productTypeId

int32 | null

isTaxable

boolean

If true, the product is subject to tax.

isRecurring

boolean

If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.

pricingBehavior

object

inventoryInfo

object

createDate

date-time

When the product was created with the product admin resource.

updateDate

date-time

When the product was last modified with the product admin resource.

dateFirstAvailableInCatalog

date-time | null

catalogStartDate

date-time | null

catalogEndDate

date-time | null

daysAvailableInCatalog

int32 | null

upc

string | null

UPC code of the product.

upCs

array of strings | null

UPC code of the products (populated for configurable products).

upCs

mfgPartNumber

string | null

Manufacturer part number.

mfgPartNumbers

array of strings | null

Manufacturer part numbers (populated for configurable products).

mfgPartNumbers

variationProductCode

string | null

When a configurable product has IsPurchasable=true on a GetProduct, this property will be populated for submission to cart.

categories

object

categoryId

int32

Internal unique identifier of the category. System-supplied and read-only.

parentCategory

object

Has additional fields

content

object

Name of the category and optionally, a description, page title, friendly URL, associated images, and any metadata.

childrenCategories

array of objects | null

List of subcategories that belong to this category.

childrenCategories

object

sequence

int32 | null

Order in which categories appear when they are at the same level (siblings). For example, categories can be sequenced so that a specific category always appears first (or last).

isDisplayed

boolean

Indicates whether the category should be displayed.

categoryCode

string | null

External unique identifier of the category.

count

int32 | null

Indicates whether the category should be displayed.

updateDate

date-time

Last Modified Date Time

shouldSlice

boolean

Indicates whether the category should be sliced

attributes

array of objects | null

attributes

object

fullyQualifiedName

string | null

dataType

int32

values

array | null

values

productRules

array of strings | null

productRules

measurements

object

Physical dimensions of the package required to ship the product and its weight.

isPackagedStandAlone

boolean | null

Is this product shipped in its own package

properties

array of objects | null

List of product properties. These are attributes that might apply to multiple products, for example, price, size, manufacturer. These attributes cannot be configured by the shopper.

properties

object

attributeFQN

string | null

Attribute fully qualified name

isHidden

boolean | null

Indicates whether the product property should be hidden from the customer

isMultiValue

boolean | null

Indicates whether it's possible for there to be more than one value in the Values field

attributeDetail

object

Product Attribute properties common between a Product Propery, Option, and Extra

values

array of objects | null

Value(s) of the product property

values

object

value

string

stringValue

string | null

Localized Value in the language of the locale code

displayInfo

object

Product Attribute properties common between a Product Propery, Option, and Extra

propertyType

string | null

Property Type of the Property

options

array of objects | null

List of the product's configurable options and extras.
Includes whether an option is configurable (for example, a T-shirt) or an Extra (for example, monogram or gift-wrapping).

options

object

attributeFQN

string | null

Attribute fully qualified name

isRequired

boolean | null

If true, the shopper must provide a value for the option before it can be purchased.

isMultiValue

boolean | null

If true, more than one value can be assigned to an option. Only possible with stand-alone options.

values

array of objects | null

Possible choices for an option, for example, values of the option "Color" can be "red," "white," and "blue."

values

object

value

string

attributeValueId

int32

Unique Id for the Value

stringValue

string | null

Localized Value in the language of the locale code only available for dataType string

isEnabled

boolean | null

If true, this option is enabled and can be selected. During configuration, this returns false of this option value is invalid with other current selected options.

isSelected

boolean | null

If true, this is the option that is currently selected. It can be either the default value or one that the shopper has selected.

isDefault

boolean | null

If true, this is the default value that the merchant supplied.

deltaWeight

double | null

How much this option weighs above the weight of the product.

deltaPrice

double | null

How much this option costs above the cost of the product.

shopperEnteredValue

string

How much this option costs above the cost of the product.

bundledProduct

object

Details of a product, including its product code, name, description, options (if any), and current state--whether the product can be purchased given the options selected currently.

displayInfo

object

Product Attribute properties common between a Product Propery, Option, and Extra

attributeDetail

object

Product Attribute properties common between a Product Propery, Option, and Extra

isProductImageGroupSelector

boolean

variations

array of objects | null

variations

object

productCode

string | null

Merchant-created code associated with the variation product, for example, a SKU.

upc

string | null

UPC code of the variant product

options

array of objects | null

The combination of options that resolve to this variation product

options

object

valueSequence

int32

attributeFQN

string | null

value

string

inventoryInfo

object

validPriceLists

array of strings | null

List of valid pricelists for the product

validPriceLists

locationsInStock

array of strings | null

Any location code (eq) or array of location codes which are in stock.

locationsInStock

slicingAttributeFQN

string | null

productImageGroups

array of objects | null

List of the image groups this product uses.
Image groups are used to map different images to different product options.
If the product doesn't have options then all images will be in the default
image group.

productImageGroups

object

productImageGroupId

string

required

productImageGroupTags

array of objects | null

productImageGroupTags

object

attributeFqn

string | null

value

string | null

sliceValue

string | null

Readonly value of the selected value of the option corresponding to the Mozu.ProductRuntime.Contracts.Product.SlicingAttributeFQN

productCollections

array of objects | null

List of product codes of product collections that this product is a member of.

productCollections

object

productCode

string | null

Product Code of the collection

isPrimary

boolean

True if the collection is the primary collection for the containing product.

productCollectionMembers

array of objects | null

list of member products that are part of the collection
This requires that the ProductUsage be set to Collection

productCollectionMembers

object

memberKey

object

This is the key of the product collection member. For now, it's just product code, but may expand in future

collectionMembersProductContent

array of objects | null

Only used for indexing

collectionMembersProductContent

object

productName

string | null

Name of the product.

productFullDescription

string | null

Detailed description of the product typically used for a product details page.

productShortDescription

string | null

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

metaTagTitle

string | null

Metadata title used to manage information internally.

metaTagDescription

string | null

Metadata description used to manage information internally.

metaTagKeywords

string | null

Metadata keywords used to manage information internally.

seoFriendlyUrl

string | null

Human-readable identifier defined for the product to create friendly URLs.

productImages

array of objects | null

Images associated with the product.

productImages

object

imageLabel

string | null

Image title. Unicode data with a maximum length of 50 characters.

altText

string | null

Descriptive text associated with the image. Unicode data with a maximum length of 200 characters.

imageUrl

string | null

Image URL. Unicode data with a maximum length of 4000 characters.

cmsId

string | null

Id of the image in the CMS.

videoUrl

string | null

URL of the video. Unicode data with a maximum length of 4000 characters.

mediaType

string | null

Type of media. Used by the client to determine how to render the image or video or what have you.

sequence

int32 | null

For products with multiple images, the sequence is the order in which this image appears. Whole number data. Required.

productImageGroupId

string | null

score

double

The item's search engine relevancy score.

personalizationScore

double

costPriceMargin

double | null

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://t0-s0.sb.usc1.kibocommerce.com/api/commerce/catalog/storefront/productsearch/search?collapse=true&startIndex=0&enableSearchTuningRules=true&includeAllImages=false&spellcorrectOverride=Default&useSubscriptionPricing=false' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success