Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

SiteStores

# Introduction
To use the Stores API, import `* as wixSiteStores` from the `@wix/site-stores` module:

   ```javascript
   import * as wixSiteStores from '@wix/site-stores';
   ```
> **Notes:**
> + Additional Stores related APIs can be found in the [`CartIcon`](https://dev.wix.com/docs/velo/api-reference/$w/cart-icon/introduction), [`ProductPage`](https://dev.wix.com/docs/velo/api-reference/$w/product-page/introduction), [`ThankYouPage`](https://dev.wix.com/docs/velo/api-reference/$w/thank-you-page/introduction), and [`Currencies`](https://dev.wix.com/docs/velo/api-reference/wix-pay-backend/currencies) pages.
> + The Cart and Navigate modules are deprecated. They will continue to work, but newer versions are available in the frontend [`ecom`](https://dev.wix.com/docs/sdk/frontend-modules/ecom/introduction) module and the backend [`ecom.CurrentCart`](https://dev.wix.com/docs/sdk/backend-modules/ecom/current-cart/setup) module.

# Schema for Wix Search





This article describes the Wix Store product fields you can [search](https://www.wix.com/velo/reference/wix-search.html#search), [sort](https://www.wix.com/velo/reference/wix-search.WixSearchBuilder.html#ascending), [filter](https://www.wix.com/velo/reference/wix-search.html#filter), and [apply facets](https://www.wix.com/velo/reference/wix-search.WixSearchBuilder.html#facets) to when using the [wix-search API](https://www.wix.com/velo/reference/wix-search.html).

To search Wix Store products on your site, set the search document type as `"Stores/Products"`:

```javascript
wixSearch.search(phrase)
  .documentType("Stores/Products")
  .find()
  .then( (results) => {
    // handle the results
  } );
```

> **Note**
> The Stores/Products fields supported by wix-search are not identical to the fields in your site's [Stores/Products collection](https://support.wix.com/en/article/velo-wix-stores-products-collection-fields).

The following fields appear in each matching search result [document](https://dev.wix.com/docs/velo/api-reference/wix-search/wix-search-result/documents) when searching Wix Store products:

#### documentType 

**Description**: Document type that was searched. In this case, "Stores/Products".  
**Type**: String  
**Can search the content of this field**: No  
**Can facet**: No  
**Can sort**: No  
**Can filter**: No

#### \_id 

**Description**: Product ID.  
**Type**: String  
**Can search the content of this field**: No  
**Can facet**: No  
**Can sort**: No  
**Can filter**: No

#### title 

**Description**: Product name.  
**Type**: String  
**Can search the content of this field**: Yes  
**Can facet**: No  
**Can sort**: No  
**Can filter**: No

#### description 

**Description**: Product description.  
**Type**: String  
**Can search the content of this field**: Yes  
**Can facet**: No  
**Can sort**: No  
**Can filter**: No

#### url 

**Description**: Relative URL of the product's page on your site.  
**Type**: String  
**Can search the content of this field**: No  
**Can facet**: No  
**Can sort**: No  
**Can filter**: No

#### image 

**Description**: File source of the main media image for this product.  
**Type**: String  
**Can search the content of this field**: No  
**Can facet**: No  
**Can sort**: No  
**Can filter**: No

#### sku 

**Description**: Product's stock keeping unit number.  
**Type**: String  
**Can search the content of this field**: Yes  
**Can facet**: Yes  
**Can sort**: Yes  
**Can filter**: in, eq, ne, gt, ge, lt, le 

#### inStock 

**Description**: Indicates whether the product is in stock.  
**Type**: Boolean  
**Can search the content of this field**: No  
**Can facet**: Yes  
**Can sort**: Yes  
**Can filter**: eq, ne 

#### options 

**Description**: Product options and choices.  
**Type**: Array of Strings  
**Can search the content of this field**: Yes  
**Can facet**: Yes  
**Can sort**: No  
**Can filter**: hasSome, hasAll 

The `options` array contains product option names (for example, `Color`) followed by the descriptions of the choices for that option (for example, `blue`, `black`). If there is more than one option for a product, the options and their choice descriptions are listed in sequence.

The following is an example of an `options` array for a product with 2 options: `Color` and `Size`:

```javascript
options: ["Color", "Orange", "Blue", "Size", "Small", "Medium", "Large"]
```

> **Note**
> Faceting products with more than 1 product option may return unexpected results. 

#### collections 

**Description**: Collections the product belongs to.  
**Type**: Array of Strings  
**Can search the content of this field**: Yes  
**Can facet**: Yes  
**Can sort**: No  
**Can filter**: hasSome, hasAll 

#### onSale 

**Description**: Indicates whether the product is on sale.  
**Type**: Boolean  
**Can search the content of this field**: No  
**Can facet**: Yes  
**Can sort**: Yes  
**Can filter**: eq, ne

site-stores

Cart

Navigates to the specified product's page.

![developer preview tag](https://user-images.githubusercontent.com/89579857/213133550-2b4fa3e8-e8fc-4513-a733-00abcc70925c.png)

> **Note:** This method is supported in [sites](https://dev.wix.com/docs/develop-websites) and [mobile apps](https://www.wix.com/app-builder).

toProduct

Fulfilled - When the browser or app is directed to the product's page.

Navigate

Retrieves the availability of a product based on the specified option choices.

The information returned in the `selectedVariant` and `availableForPurchase`
 properties reflects the option choices passed in the `choices` parameter.

 If the specified choices result in the selection of a single product variant,
 that variant is returned in the `selectedVariant` property and the `availableForPurchase`
 property indicates whether that product variant is available for purchase.

 If the choices specified in the `choices` parameter don't result in the selection of a single product variant,
 no variant is returned in the `selectedVariant` property and the `availableForPurchase`
 property will be `false`.

getOptionsAvailability

Fulfilled - The availability information of the product.

Gets a product's available variants based on the specified product ID and either option choices or variant IDs.

getVariants

Fulfilled - The variants with the specified choices.

Opens the [Quick View](https://support.wix.com/en/article/wix-stores-customizing-the-quick-view-in-the-product-gallery) modal of a specified product.

The quantity input field in the Quick View will be pre-populated with 1, unless otherwise specified in the `options.quantity` field.

If the product has different [options or variants](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#product-option-faqs),
they will be displayed for selection in the opened Quick View.

>**Note:**
> This API fails when viewing the site on mobile because there is no Quick View on the mobile site.

openQuickView

Fulfilled - When the Quick View modal is opened.

# Introduction
To use the Wix Stores Product API, import `{ product }` from the `@wix/site-stores` module:

   ```javascript
   import { product } from '@wix/site-stores';
   ```

Product

AddToCartItem

Specific product options to add to the cart.
 If the product you're adding has options, you must specify which options to add.

options

AddToCartOptions

productId

string

Number of product units to add to the cart.

quantity

number

Product options to use when adding the
 product to the cart. The object contains key:value pairs where the key is the option name and the value is the chosen option value.

choices

object

Custom text fields to use when adding the product to the cart.

customTextFields

CustomTextField

title

value

CartAddress

address

email

firstName

lastName

phone

CartAppliedCoupon

code

couponId

Type of coupon.
 One of:

 + `"BuyXGetY"`
 + `"FixedPriceAmount"`
 + `"FreeShipping"`
 + `"MoneyOffAmount"`
 + `"PercentOffRate"`

couponType

discountValue

name

CartBuyerInfo

Buyer's identity.
 One of:

 + `"ADMIN"`: Buyer is the site owner.
 + `"MEMBER"`: Buyer is a logged-in site member.
 + `"VISITOR"`: Buyer is not logged in.
 + `"CONTACT"`: A contact has been created for the buyer.

identityType

CartChangedHandler

cart

CartObj

void

CartCustomTextField

CartLineItem

Type of the line item.
 One of:

 + `"DIGITAL"`: Digital item.
 + `"PHYSICAL"`: Physical item.
 + `"CUSTOM_AMOUNT_ITEM"`: Item with a custom price.
 + `"UNSPECIFIED"`: Type can't be classified due to an error.

lineItemType

mediaItem

CartMediaItem

notes

price

Total price charged to the customer for all line items after any applicable discounts.

totalPrice

weight

Media item source for media uploaded to Wix (wix:image, wix:video or external URL).

Media item type. Currently only `"IMAGE"` type supported.

type

appliedCoupon

billingAddress

buyerInfo

currency

Currency

lineItems

The shopping cart's shipping information.

shippingInfo

CartShippingInfo

Cart status. Either `"INCOMPLETE"` or `"COMPLETE"`.

status

totals

OrderTotals

The order's units of weight. One of: `"KG"`, `"LB"`, or `"UNSPECIFIED_WEIGHT_UNIT"`.

weightUnit

pickupInfo

shippingAddress

MediaItem

description

thumbnail

Media items type. Can be "image" or "video."

Option

option

selection

discount

The total quantity of the the order's line items.

shipping

The subtotal of all the order's line items, excluding tax.

subtotal

total

ProductOption

Option type. Either `"color"` or `"drop_down"`.

optionType

ProductOptions

Name of the option. This key name
 is dependent on the options added to the product. For example, if a product has a size
 option, this key will be something like `"Size"`.

 `optionKey` isn't case-sensitive. Therefore the values for the option keys "`Size`", "`SIZE`", and "`size`" are combined.

optionKey

ProductOptionsAvailability

Whether the product with the specified option choices is available for purchase.

availableForPurchase

boolean

Main product media item (image or video) URL.

mainMedia

mediaItems

An object representing all the available options for a store product.

productOptions

The variant of the product selected using the specified option choices if there is one.

selectedVariant

ProductOptionsAvailabilitySelectedVariant

discountedPrice

Discounted product variant price formatted with the currency.

formattedDiscountedPrice

Product variant price formatted with the currency.

formattedPrice

inStock

Product variant price. The variant price must be greater than its discount.

Product variant stock keeping unit value.

Whether the product variant is shown in the store.

visible

ProductOptionsChoice

Whether the product with this choice is in stock.

media

ProductOptionsChoiceMedia

Whether the product with this option is visible.

Main choice media item (image or video thumbnail) URL.

ProductVariantOptions

variantIds

QuickViewOptions

Product quantity to be displayed in the Quick View. Defaults to 1.

VariantInfo

Discounted variant price formatted with the currency.

Variant price formatted with the currency.

Price per unit formatted with currency symbol.

formattedPricePerUnit

Variant price. The variant price must be greater than its discount. If the variant price has been updated, changes to the product price don't affect the variant price.

pricePerUnit

Whether the variant is visible in the store.

VariantItem

Choices of the retrieved variant in the form of an object containing a `key:value` pair for each variant choice. For example, if a variant has a size option, this key value will be something like "Size" and its value will be something like "Large".

openQuickView( )