{"id":"223507be-b24e-4fa6-ac4c-e3d6a5010383","createdDate":"2024-09-22T14:49:48.653Z","updatedDate":"2024-09-22T14:49:48.653Z","resourceId":"a98deb84-4264-40c6-a64c-bdc660dd66fb","sdk":{"schema":{"name":"velo_wix-stores-frontend","fqn":"","slug":"velo-wix-stores-frontend","typesMap":{"Cart.AddToCartItem":{"name":"AddToCartItem","fqn":"Cart.AddToCartItem","slug":"add-to-cart-item","actions":[],"properties":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddToCartOptions","referenceFqn":"Cart.AddToCartOptions"},"description":"Specific product options to add to the cart.\r\n If the product you're adding has options, you must specify which options to add."},{"name":"productId","slug":"product-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the product to add to the cart."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of product units to add to the cart."}]},"Cart.AddToCartOptions":{"name":"AddToCartOptions","fqn":"Cart.AddToCartOptions","slug":"add-to-cart-options","actions":[],"properties":[{"name":"choices","slug":"choices","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"Product options to use when adding the\r\n 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."},{"name":"customTextFields","slug":"custom-text-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CustomTextField","referenceFqn":"Cart.CustomTextField"}},"description":"Custom text fields to use when adding the product to the cart."}]},"Cart.CustomTextField":{"name":"CustomTextField","fqn":"Cart.CustomTextField","slug":"custom-text-field","actions":[],"properties":[{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom text field title."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom text field value."}]},"CartObj":{"name":"CartObj","fqn":"CartObj","slug":"cart-obj","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique identifier of the shopping cart."},{"name":"appliedCoupon","slug":"applied-coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartAppliedCoupon","referenceFqn":"CartAppliedCoupon"},"description":"Coupon applied in the shopping cart."},{"name":"billingAddress","slug":"billing-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartAddress","referenceFqn":"CartAddress"},"description":"Cart billing address."},{"name":"buyerInfo","slug":"buyer-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartBuyerInfo","referenceFqn":"CartBuyerInfo"},"description":"The buyer's information."},{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Currency","referenceFqn":"Currency"},"description":"Currency of the shopping cart."},{"name":"lineItems","slug":"line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CartLineItem","referenceFqn":"CartLineItem"}},"description":"Items in the shopping cart."},{"name":"shippingInfo","slug":"shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartShippingInfo","referenceFqn":"CartShippingInfo"},"description":"The shopping cart's shipping information."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cart status. Either `\"INCOMPLETE\"` or `\"COMPLETE\"`."},{"name":"totals","slug":"totals","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderTotals","referenceFqn":"OrderTotals"},"description":"The shopping cart's totals."},{"name":"weightUnit","slug":"weight-unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The order's units of weight. One of: `\"KG\"`, `\"LB\"`, or `\"UNSPECIFIED_WEIGHT_UNIT\"`."}]},"CartAppliedCoupon":{"name":"CartAppliedCoupon","fqn":"CartAppliedCoupon","slug":"cart-applied-coupon","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."},{"name":"couponId","slug":"coupon-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon unique identifier."},{"name":"couponType","slug":"coupon-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of coupon.\r\n One of:\r\n\r\n + `\"BuyXGetY\"`\r\n + `\"FixedPriceAmount\"`\r\n + `\"FreeShipping\"`\r\n + `\"MoneyOffAmount\"`\r\n + `\"PercentOffRate\"`"},{"name":"discountValue","slug":"discount-value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Value of the coupon discount."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon name."}]},"CartAddress":{"name":"CartAddress","fqn":"CartAddress","slug":"cart-address","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Address."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."}]},"CartBuyerInfo":{"name":"CartBuyerInfo","fqn":"CartBuyerInfo","slug":"cart-buyer-info","actions":[],"properties":[{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer's email address."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer's first name."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer's unique ID."},{"name":"identityType","slug":"identity-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer's identity.\r\n One of:\r\n\r\n + `\"ADMIN\"`: Buyer is the site owner.\r\n + `\"MEMBER\"`: Buyer is a logged-in site member.\r\n + `\"VISITOR\"`: Buyer is not logged in.\r\n + `\"CONTACT\"`: A contact has been created for the buyer."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer's last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer's phone number."}]},"Currency":{"name":"Currency","fqn":"Currency","slug":"currency","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The currency code."}]},"CartLineItem":{"name":"CartLineItem","fqn":"CartLineItem","slug":"cart-line-item","actions":[],"properties":[{"name":"customTextFields","slug":"custom-text-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CartCustomTextField","referenceFqn":"CartCustomTextField"}},"description":"Custom text."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Cart line item ID."},{"name":"lineItemType","slug":"line-item-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Type of the line item.\r\n One of:\r\n\r\n + `\"DIGITAL\"`: Digital item.\r\n + `\"PHYSICAL\"`: Physical item.\r\n + `\"CUSTOM_AMOUNT_ITEM\"`: Item with a custom price.\r\n + `\"UNSPECIFIED\"`: Type can't be classified due to an error."},{"name":"mediaItem","slug":"media-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartMediaItem","referenceFqn":"CartMediaItem"},"description":"Media item."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the line item."},{"name":"notes","slug":"notes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Notes about the line item."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Option","referenceFqn":"Option"}},"description":"Line item options."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item price."},{"name":"productId","slug":"product-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item product ID."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item stock keeping unit."},{"name":"totalPrice","slug":"total-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Total price charged to the customer for all line items after any applicable discounts."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item weight."}]},"CartCustomTextField":{"name":"CartCustomTextField","fqn":"CartCustomTextField","slug":"cart-custom-text-field","actions":[],"properties":[{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Field title."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Field value."}]},"CartMediaItem":{"name":"CartMediaItem","fqn":"CartMediaItem","slug":"cart-media-item","actions":[],"properties":[{"name":"src","slug":"src","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media item source for media uploaded to Wix (wix:image, wix:video or external URL)."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media item type. Currently only `\"IMAGE\"` type supported."}]},"Option":{"name":"Option","fqn":"Option","slug":"option","actions":[],"properties":[{"name":"option","slug":"option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of the product option."},{"name":"selection","slug":"selection","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Selected option."}]},"CartShippingInfo":{"name":"CartShippingInfo","fqn":"CartShippingInfo","slug":"cart-shipping-info","actions":[],"properties":[{"name":"pickupInfo","slug":"pickup-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartAddress","referenceFqn":"CartAddress"},"description":"Pickup address."},{"name":"shippingAddress","slug":"shipping-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartAddress","referenceFqn":"CartAddress"},"description":"Shipment address."}]},"OrderTotals":{"name":"OrderTotals","fqn":"OrderTotals","slug":"order-totals","actions":[],"properties":[{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The total calculated discount amount."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The total quantity of the the order's line items."},{"name":"shipping","slug":"shipping","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The total shipping price, including tax."},{"name":"subtotal","slug":"subtotal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The subtotal of all the order's line items, excluding tax."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The total amount of tax."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The total price."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The total weight of the order's items."}]},"CartChangedHandler":{"name":"CartChangedHandler","fqn":"CartChangedHandler","slug":"cart-changed-handler","actions":[],"properties":[{"name":"cart","slug":"cart","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartObj","referenceFqn":"CartObj"},"description":"The changed cart."}],"returnType":{"kind":"PRIMITIVE","name":"void"}},"ProductOptionsAvailability":{"name":"ProductOptionsAvailability","fqn":"ProductOptionsAvailability","slug":"product-options-availability","actions":[],"properties":[{"name":"availableForPurchase","slug":"available-for-purchase","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the product with the specified option choices is available for purchase."},{"name":"mainMedia","slug":"main-media","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main product media item (image or video) URL."},{"name":"mediaItems","slug":"media-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MediaItem","referenceFqn":"MediaItem"},"description":"List of product media items."},{"name":"productOptions","slug":"product-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductOptions","referenceFqn":"ProductOptions"},"description":"An object representing all the available options for a store product."},{"name":"selectedVariant","slug":"selected-variant","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductOptionsAvailabilitySelectedVariant","referenceFqn":"ProductOptionsAvailabilitySelectedVariant"},"description":"The variant of the product selected using the specified option choices if there is one."}]},"MediaItem":{"name":"MediaItem","fqn":"MediaItem","slug":"media-item","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media item description."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media item ID."},{"name":"src","slug":"src","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media item URL."},{"name":"thumbnail","slug":"thumbnail","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Thumbnail URL for videos only."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media item title."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media items type. Can be \"image\" or \"video.\""}]},"ProductOptions":{"name":"ProductOptions","fqn":"ProductOptions","slug":"product-options","actions":[],"properties":[{"name":"optionKey","slug":"option-key","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductOption","referenceFqn":"ProductOption"},"description":"Name of the option. This key name\r\n is dependent on the options added to the product. For example, if a product has a size\r\n option, this key will be something like `\"Size\"`.\r\n\r\n `optionKey` is not case-sensitive. Therefore the values for the option keys \"`Size`\", \"`SIZE`\", and \"`size`\" are combined."}]},"ProductOption":{"name":"ProductOption","fqn":"ProductOption","slug":"product-option","actions":[],"properties":[{"name":"choices","slug":"choices","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ProductOptionsChoice","referenceFqn":"ProductOptionsChoice"}},"description":"Option choices."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Option name."},{"name":"optionType","slug":"option-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Option type. Either `\"color\"` or `\"drop_down\"`."}]},"ProductOptionsChoice":{"name":"ProductOptionsChoice","fqn":"ProductOptionsChoice","slug":"product-options-choice","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Choice description."},{"name":"inStock","slug":"in-stock","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the product with this choice is in stock."},{"name":"media","slug":"media","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductOptionsChoiceMedia","referenceFqn":"ProductOptionsChoiceMedia"},"description":"Choice media."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Choice value."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the product with this option is visible."}]},"ProductOptionsChoiceMedia":{"name":"ProductOptionsChoiceMedia","fqn":"ProductOptionsChoiceMedia","slug":"product-options-choice-media","actions":[],"properties":[{"name":"mainMedia","slug":"main-media","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main choice media item (image or video thumbnail) URL."},{"name":"mediaItems","slug":"media-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MediaItem","referenceFqn":"MediaItem"},"description":"List of choice media items."}]},"ProductOptionsAvailabilitySelectedVariant":{"name":"ProductOptionsAvailabilitySelectedVariant","fqn":"ProductOptionsAvailabilitySelectedVariant","slug":"product-options-availability-selected-variant","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Product variant currency."},{"name":"discountedPrice","slug":"discounted-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Discounted product variant price."},{"name":"formattedDiscountedPrice","slug":"formatted-discounted-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discounted product variant price formatted with the currency."},{"name":"formattedPrice","slug":"formatted-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Product variant price formatted with the currency."},{"name":"inStock","slug":"in-stock","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the product variant is in stock."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Product variant price. The variant price must be greater than its discount."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Product variant stock keeping unit value."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the product variant is shown in the store."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Product variant weight."}]},"ProductVariantOptions":{"name":"ProductVariantOptions","fqn":"ProductVariantOptions","slug":"product-variant-options","actions":[],"properties":[{"name":"choices","slug":"choices","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"Choices of the retrieved variants."},{"name":"variantIds","slug":"variant-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the variants to retrieve."}]},"VariantItem":{"name":"VariantItem","fqn":"VariantItem","slug":"variant-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique variant ID."},{"name":"choices","slug":"choices","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"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\"."},{"name":"variant","slug":"variant","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VariantInfo","referenceFqn":"VariantInfo"},"description":"Variant information."}]},"VariantInfo":{"name":"VariantInfo","fqn":"VariantInfo","slug":"variant-info","actions":[],"properties":[{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Variant currency."},{"name":"discountedPrice","slug":"discounted-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Discounted variant price."},{"name":"formattedDiscountedPrice","slug":"formatted-discounted-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discounted variant price formatted with the currency."},{"name":"formattedPrice","slug":"formatted-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Variant price formatted with the currency."},{"name":"formattedPricePerUnit","slug":"formatted-price-per-unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Price per unit formatted with currency symbol."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Variant price. The variant price must be greater than its discount. If the variant price has been updated, changes to the product price do not affect the variant price."},{"name":"pricePerUnit","slug":"price-per-unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Price per unit."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Variant stock keeping unit value."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the variant is visible in the store."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Variant weight."}]},"QuickViewOptions":{"name":"QuickViewOptions","fqn":"QuickViewOptions","slug":"quick-view-options","actions":[],"properties":[{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Product quantity to be displayed in the Quick View. Defaults to 1."}]}},"standaloneTypes":[],"metadata":{},"actions":[],"webhooks":[],"articles":[{"content":"# Introduction\nTo use the Stores API, import `wixStoresFrontend` from the `wix-stores-frontend` module:\n\n ```javascript\n import wixStoresFrontend from 'wix-stores-frontend';\n ```\n> **Notes:**\n> + 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.\n> + The [Cart](/wix-stores-frontend/cart/introduction) and [Navigate](/wix-stores-frontend/navigate/introduction) modules are deprecated. They will continue to work, but newer versions are available at [`wix-ecom-frontend`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/introduction) and [`wix-ecom-backend.CurrentCart`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/introduction).","displayName":"Introduction","slugifyName":"introduction"},{"content":"\n\n\n\n# Schema for Wix Search\n\n\n\n\n\nThis 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).\n\nTo search Wix Store products on your site, set the search document type as `\"Stores/Products\"`:\n\n```javascript\nwixSearch.search(phrase)\n .documentType(\"Stores/Products\")\n .find()\n .then( (results) => {\n // handle the results\n } );\n```\n\n> **Note**\n> 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).\n\nThe following fields appear in each matching search result [document](/wix-search/wix-search-result/documents) when searching Wix Store products:\n\n#### documentType \n\n**Description**: Document type that was searched. In this case, \"Stores/Products\". \n**Type**: String \n**Can search the content of this field**: No \n**Can facet**: No \n**Can sort**: No \n**Can filter**: No\n\n#### \\_id \n\n**Description**: Product ID. \n**Type**: String \n**Can search the content of this field**: No \n**Can facet**: No \n**Can sort**: No \n**Can filter**: No\n\n#### title \n\n**Description**: Product name. \n**Type**: String \n**Can search the content of this field**: Yes \n**Can facet**: No \n**Can sort**: No \n**Can filter**: No\n\n#### description \n\n**Description**: Product description. \n**Type**: String \n**Can search the content of this field**: Yes \n**Can facet**: No \n**Can sort**: No \n**Can filter**: No\n\n#### url \n\n**Description**: Relative URL of the product's page on your site. \n**Type**: String \n**Can search the content of this field**: No \n**Can facet**: No \n**Can sort**: No \n**Can filter**: No\n\n#### image \n\n**Description**: File source of the main media image for this product. \n**Type**: String \n**Can search the content of this field**: No \n**Can facet**: No \n**Can sort**: No \n**Can filter**: No\n\n#### sku \n\n**Description**: Product's stock keeping unit number. \n**Type**: String \n**Can search the content of this field**: Yes \n**Can facet**: Yes \n**Can sort**: Yes \n**Can filter**: in, eq, ne, gt, ge, lt, le \n\n#### inStock \n\n**Description**: Indicates whether the product is in stock. \n**Type**: Boolean \n**Can search the content of this field**: No \n**Can facet**: Yes \n**Can sort**: Yes \n**Can filter**: eq, ne \n\n#### options \n\n**Description**: Product options and choices. \n**Type**: Array of Strings \n**Can search the content of this field**: Yes \n**Can facet**: Yes \n**Can sort**: No \n**Can filter**: hasSome, hasAll \n\nThe `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.\n\nThe following is an example of an `options` array for a product with 2 options: `Color` and `Size`:\n\n```javascript\noptions: [\"Color\", \"Orange\", \"Blue\", \"Size\", \"Small\", \"Medium\", \"Large\"]\n```\n\n> **Note**\n> Faceting products with more than 1 product option may return unexpected results. \n\n#### collections \n\n**Description**: Collections the product belongs to. \n**Type**: Array of Strings \n**Can search the content of this field**: Yes \n**Can facet**: Yes \n**Can sort**: No \n**Can filter**: hasSome, hasAll \n\n#### onSale \n\n**Description**: Indicates whether the product is on sale. \n**Type**: Boolean \n**Can search the content of this field**: No \n**Can facet**: Yes \n**Can sort**: Yes \n**Can filter**: eq, ne\n","displayName":"Stores Schema for Wix Search","slugifyName":"stores-schema-for-wix-search"}],"namespaces":[{"name":"Cart","slug":"cart","fqn":"Cart","standaloneTypes":[],"metadata":{},"actions":[{"name":"addProducts","fqn":"Cart.addProducts","slug":"add-products","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["products"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CartObj","referenceFqn":"CartObj"},"description":"Fulfilled - The updated cart with added products."},"examples":[{"title":"Add products to the cart","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\n\nconst products = [\n {\n \"productId\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n \"quantity\": 3\n },\n {\n \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n \"quantity\": 1,\n \"options\": {\n \"choices\": {\n \"Weight\": \"250g\",\n \"Ground for\": \"Filter\"\n }\n }\n },\n {\n \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n \"quantity\": 1,\n \"options\": {\n \"choices\": {\n \"Weight\": \"500g\",\n \"Ground for\": \"Stovetop\"\n },\n \"customTextFields\": [{\n \"title\": \"Custom package sticker\",\n \"value\": \"Enjoy your coffee!\"\n }]\n }\n }\n]\n\ncart.addProducts(products)\n .then((updatedCart) => {\n // Products added to cart\n const cartId = updatedCart._id;\n const cartLineItems = updatedCart.lineItems;\n })\n .catch((error) => {\n // Products not added to cart\n console.error(error);\n });\n\n\n/* Example of returned updatedCart object:\n *\n * {\n * \"_id\": \"5d54aa6f-f653-4bed-8c34-7f1373f88c89\",\n * \"status\": \"INCOMPLETE\",\n * \"billingAddress\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"email\": \"\",\n * \"phone\": \"+1234567890\",\n * \"company\": \"undefined\",\n * \"vatId\": \"undefined\",\n * \"address\": \"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"appliedCoupon\": \"null\",\n * \"buyerInfo\": {\n * \"email\": \"\",\n * \"firstName\": \"Jane\",\n * \"identityType\": \"ADMIN\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"+1234567890\"\n * },\n * \"buyerNote\": \"undefined\",\n * \"currency\": {\n * \"symbol\": \"$\",\n * \"code\": \"USD\"\n * },\n * \"lineItems\": [\n * {\n * \"id\": 16,\n * \"productId\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n * \"name\": \"Digital product\",\n * \"quantity\": 3,\n * \"lineItemType\": \"DIGITAL\",\n * \"customTextFields\": [],\n * \"options\": [],\n * \"price\": 20,\n * \"totalPrice\": 60,\n * \"mediaItem\": \"null\",\n * \"weight\": 0\n * },\n * {\n * \"id\": 17,\n * \"productId\": \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\",\n * \"name\": \"Colombian Arabica\",\n * \"quantity\": 1,\n * \"weight\": 0.25,\n * \"sku\": \"10003\",\n * \"lineItemType\": \"PHYSICAL\",\n * \"customTextFields\": [],\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/nsplsh_5033504669385448625573~mv2_d_6000_3376_s_4_2.jpg/file.jpg#originWidth=6000&originHeight=3376\",\n * \"type\": \"IMAGE\"\n * },\n * \"options\": [\n * {\n * \"option\": \"Weight\",\n * \"selection\": \"250g\"\n * },\n * {\n * \"option\": \"Ground for\",\n * \"selection\": \"Filter\"\n * }\n * ],\n * \"price\": 35,\n * \"totalPrice\": 35\n * },\n * {\n * \"id\": 18,\n * \"productId\": \"5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a\",\n * \"name\": \"Indonesian Blend\",\n * \"quantity\": 1,\n * \"lineItemType\": \"PHYSICAL\",\n * \"customTextFields\": [\n * {\n * \"title\": \"Custom package sticker\",\n * \"value\": \"Enjoy your coffee!\"\n * }\n * ],\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/nsplsh_316b6449475f3235386255~mv2_d_2977_3951_s_4_2.jpg/file.jpg#originWidth=2977&originHeight=3951\",\n * \"type\": \"IMAGE\"\n * },\n * \"options\": [\n * {\n * \"option\": \"Weight\",\n * \"selection\": \"500g\"\n * },\n * {\n * \"option\": \"Ground for\",\n * \"selection\": \"Stovetop\"\n * }\n * ],\n * \"price\": 35,\n * \"totalPrice\": 35,\n * \"weight\": 0\n * }\n * ],\n * \"shippingInfo\": {\n * \"shippingAddress\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"email\": \"\",\n * \"phone\": \"+1234567890\",\n * \"company\": \"undefined\",\n * \"vatId\": \"undefined\",\n * \"address\": \"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * }\n * },\n * \"totals\": {\n * \"discount\": 0,\n * \"quantity\": 5,\n * \"shipping\": 0,\n * \"subtotal\": 160,\n * \"tax\": 0,\n * \"total\": 160,\n * \"weight\": 0.75\n * },\n * \"weightUnit\": \"KG\"\n * }\n *\n */"}],"actionParams":[{"name":"products","slug":"products","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AddToCartItem","referenceFqn":"Cart.AddToCartItem"}},"description":"One or more products to be added to the cart."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-backend.currentCart.addToCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/add-to-current-cart).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-backend.currentCart.addToCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/add-to-current-cart).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { currentCart } from \"wix-ecom-backend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.addProducts()`,\r\n> and replace it with `currentCart.addToCurrentCart()`.\r\n> Update your code to work with the new `currentCart.addToCurrentCart()` call and response properties.\r\n>\r\n> To help with updating your code to work with the new `currentCart.addToCurrentCart()` properties, learn more about [integrating Wix Stores with the Wix eCommerce](https://dev.wix.com/docs/velo/api-reference/wix-stores-backend/e-commerce-integration).\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\n Adds one or more products to the cart.\r\n\r\n The `addProducts()` function returns a Promise that is resolved when the\r\n specified products are added to the cart.\r\n\r\n Use the `quantity` property of each `AddToCartItem` object that is\r\n passed to the products parameter to add one or more products to the cart at one time.\r\n\r\n Use the `options` property of each `AddToCartItem` object that is\r\n passed to the products parameter to specify the product options to choose when adding\r\n the product to the cart. For example, if a product comes in different sizes, you can\r\n specify the size that should be added to the cart. If the product you are adding to the\r\n cart has options, you must specify which options should be chosen.\r\n\r\n You can see a product's option information in the `productOptions` field in the **Stores/Products** collection.\r\n\r\n You can use [`product.getOptionsAvailability()`](https://www.wix.com/velo/reference/wix-stores-frontend/product/getoptionsavailability)\r\n to determine if an item with specific options is available for purchase.\r\n\r\n> **Note:** If you use [`wix-stores-backend.createProduct()`](https://www.wix.com/velo/reference/wix-stores-backend/createproduct) immediately before adding that product to the cart, we suggest [setting a timeout](https://developer.mozilla.org/en-US/docs/Web/API/setTimeout) for `\"1000\"` milliseconds (1 second) before calling `cart.addProducts()`. While this slows down the operation slightly, it also ensures proper retrieval of the newly created product before adding it to the cart."},{"name":"applyCoupon","fqn":"Cart.applyCoupon","slug":"apply-coupon","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["couponCode"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CartObj","referenceFqn":"CartObj"},"description":"Fulfilled - The updated cart."},"examples":[{"title":"Apply coupon code \"SummerSale\" to the cart","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\n\nconst couponCode = \"SummerSale\";\n\ncart.applyCoupon(couponCode)\n .then((updatedCart) => {\n const couponDiscount = updatedCart.appliedCoupon.discountValue;\n })\n .catch((error) => {\n console.error(error);\n });\n\n/* Example of returned updatedCart object:\n*\n* {\n* \"_id\": \"b36eb035-635a-450e-b74d-acf86ee4dfcc\",\n* \"appliedCoupon\": {\n* \"couponId\": \"e81e9c48-f954-4044-ba64-ccfe5c103c8f\",\n* \"name\": \"Summer Sale\",\n* \"code\": \"SummerSale\",\n* \"discountValue\": \"$10.00\",\n* \"couponType\": \"MoneyOff\"\n* },\n* \"billingAddress\": {\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\":\"john.doe@somedomain.com\",\n* \"phone\":\"5555555\",\n* \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n* },\n* \"buyerNote\": \"This is a note from the buyer.\",\n* \"buyerInfo\":{\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\": \"john.doe@somedomain.com\",\n* \"phone\": \"5555555555\",\n* \"identityType\": \"CONTACT\"\n* },\n* \"status\": \"INCOMPLETE\",\n* \"currency\": {\n* \"code\": \"USD\",\n* \"symbol\": \"$\"\n* },\n* \"shippingInfo\": {\n* \"deliveryOption\": \"Free Shipping\",\n* \"shippingAddress\": {\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\":\"john.doe@somedomain.com\",\n* \"phone\":\"5555555\",\n* \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n* },\n* \"pickupDetails\":null\n* },\n* \"lineItems\":[\n* {\n* \"quantity\": 1,\n* \"price\": 120,\n* \"name\": \"A product\",\n* \"productId\": \"a668ef33-f5b8-6569-d04c-1d123be68441\",\n* \"totalPrice\": 120,\n* \"lineItemType\": \"PHYSICAL\",\n* \"customTextFields\": [\n* \"title\": \"Custom Field\",\n* \"value\": \"Custom value\"\n* ],\n* \"mediaItem\": {\n* \"src\": \"wix:image://v1/a9ff3b_ed3b544c319b4fad9c222c791a997832.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n* \"type\": \"IMAGE\"\n* },\n* \"sku\": \"21554345656\",\n* \"options\": [ ],\n* \"weight\": 3,\n* \"id\": 1\n* },\n* {\n* \"quantity\": 1,\n* \"price\": 25,\n* \"name\": \"Another product\",\n* \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n* \"totalPrice\": 25,\n* \"lineItemType\": \"PHYSICAL\",\n* \"mediaItem\": {\n* \"src\": \"wix:image://v1/a9ff3b_c6158b4d41784ae8b08337a331e1de7f.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n* \"type\": \"IMAGE\"\n* },\n* \"sku\": \"217537123517253\",\n* \"options\": [\n* {\n* \"option\": \"Size\",\n* \"selection\": \"Medium\"\n* },\n* {\n* \"option\": \"Color\",\n* \"selection\": \"Black\"\n* }\n* ],\n* \"weight\": 2,\n* \"id\": 2\n* }\n* ],\n* \"totals\": {\n* \"discount\": 10,\n* \"quantity\": 2,\n* \"shipping\": 0,\n* \"subtotal\": 145,\n* \"tax\": 0,\n* \"total\": 135,\n* \"weight\": 5\n* },\n* \"weightUnit\": \"LB\"\n* }\n*/"}],"actionParams":[{"name":"couponCode","slug":"coupon-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The code of the coupon to be applied to the cart."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-backend.currentCart.updateCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/update-current-cart).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-backend.currentCart.updateCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/update-current-cart).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { currentCart } from \"wix-ecom-backend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.applyCoupon()`,\r\n> and replace it with `currentCart.updateCurrentCart()`.\r\n> Update your code to work with the new `currentCart.updateCurrentCart()`\r\n> call and response properties.\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\nAdds and applies a coupon to the cart.\r\n\r\n The `applyCoupon()` function returns a Promise that resolves to the current\r\n site visitor's cart when the specified coupon has been applied.\r\n\r\n The cart can only hold one coupon. If a coupon is already applied to the cart, passing a different `couponCode` to `applyCoupon()` will replace the existing one.\r\n\r\n> **Note:** When [editing a site as a contributor](https://support.wix.com/en/article/velo-working-with-contributors), `applyCoupon()` will only work when viewing the live site."},{"name":"getCurrentCart","fqn":"Cart.getCurrentCart","slug":"get-current-cart","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CartObj","referenceFqn":"CartObj"},"description":"Fulfilled - The retrieved cart."},"examples":[{"title":"Get the current site visitor's cart","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\n\ncart.getCurrentCart()\n .then((currentCart) => {\n const cartId = currentCart._id;\n const cartLineItems = currentCart.lineItems;\n })\n .catch((error) => {\n console.error(error);\n });\n\n\n/* Example of returned currentCart object:\n*\n* {\n* \"_id\": \"b36eb035-635a-450e-b74d-acf86ee4dfcc\",\n* \"appliedCoupon\": {\n* \"couponId\": \"e81e9c48-f954-4044-ba64-ccfe5c103c8f\",\n* \"name\": \"Summer Sale\",\n* \"code\": \"SummerSale\",\n* \"discountValue\": \"$10.00\",\n* \"couponType\": \"MoneyOff\"\n* },\n* \"billingAddress\": {\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\":\"john.doe@somedomain.com\",\n* \"phone\":\"5555555\",\n* \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n* },\n* \"buyerNote\": \"This is a note from the buyer.\",\n* \"buyerInfo\":{\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\": \"john.doe@somedomain.com\",\n* \"phone\": \"5555555555\",\n* \"identityType\": \"CONTACT\"\n* },\n* \"status\": \"INCOMPLETE\",\n* \"currency\": {\n* \"code\": \"USD\"\n* },\n* \"shippingInfo\": {\n* \"deliveryOption\": \"Free Shipping\",\n* \"shippingAddress\": {\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\":\"john.doe@somedomain.com\",\n* \"phone\":\"5555555\",\n* \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n* },\n* \"pickupDetails\":null\n* },\n* \"lineItems\":[\n* {\n* \"quantity\": 1,\n* \"price\": 120,\n* \"name\": \"A product\",\n* \"productId\": \"a668ef33-f5b8-6569-d04c-1d123be68441\",\n* \"totalPrice\": 120,\n* \"lineItemType\": \"PHYSICAL\",\n* \"customTextFields\": [\n* \"title\": \"Custom Field\",\n* \"value\": \"Custom value\"\n* ],\n* \"mediaItem\": {\n* \"src\": \"wix:image://v1/a9ff3b_ed3b544c319b4fad9c222c791a997832.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n* \"type\": \"IMAGE\"\n* },\n* \"sku\": \"21554345656\",\n* \"options\": [ ],\n* \"weight\": 3,\n* \"id\": 1\n* },\n* {\n* \"quantity\": 1,\n* \"price\": 25,\n* \"name\": \"Another product\",\n* \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n* \"totalPrice\": 25,\n* \"lineItemType\": \"PHYSICAL\",\n* \"mediaItem\": {\n* \"src\": \"wix:image://v1/a9ff3b_c6158b4d41784ae8b08337a331e1de7f.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n* \"type\": \"IMAGE\"\n* },\n* \"sku\": \"217537123517253\",\n* \"options\": [\n* {\n* \"option\": \"Size\",\n* \"selection\": \"Medium\"\n* },\n* {\n* \"option\": \"Color\",\n* \"selection\": \"Black\"\n* }\n* ],\n* \"weight\": 2,\n* \"id\": 2\n* }\n* ],\n* \"totals\": {\n* \"discount\": 0,\n* \"quantity\": 2,\n* \"shipping\": 0,\n* \"subtotal\": 145,\n* \"tax\": 0,\n* \"total\": 145,\n* \"weight\": 5\n* },\n* \"weightUnit\": \"LB\"\n* }\n*/"}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-backend.CurrentCart.getCurrentCart()`](https://www.wix.com/velo/reference/wix-ecom-backend/currentcart/getcurrentcart).\r\n\r\nWe recommend you migrate to the new [Wix eCommerce APIs](https://www.wix.com/velo/reference/wix-ecom-backend/introduction) as soon as possible.\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-backend.CurrentCart.getCurrentCart()`](wix-ecom-backend/currentcart/getcurrentcart).\r\n>\r\n> The `wix-ecom-backend.CurrentCart.getCurrentCart()` function works from both backend and frontend code.\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { currentCart } from 'wix-ecom-backend';\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.getCurrentCart()`,\r\n> and replace it with `currentCart.getCurrentCart()`.\r\n> Update your code to work with the new `currentCart.getCurrentCart()`\r\n> call and response properties.\r\n> For more info about the differences between the Stores Cart and eCommerce Cart, refer to the [cart conversion table](https://www.wix.com/velo/reference/wix-ecom-backend/cart/stores-to-ecommerce-cart-conversion-table).\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\nGets the current site visitor's shopping cart.\r\n\r\nThe `getCurrentCart()` function returns a Promise that resolves to the current\r\nsite visitor's shopping cart."},{"name":"hideMiniCart","fqn":"Cart.hideMiniCart","slug":"hide-mini-cart","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"Show and hide the Mini Cart","description":"This example uses a deprecated function.\nAdd products to the cart, then show the Mini Cart. After 3 seconds, hide the Mini Cart.","content":"import { cart } from 'wix-stores-frontend';\nimport { formFactor } from 'wix-window-frontend';\n\nconst products = [{\n \"productId\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n \"quantity\": 2\n}];\n\ncart.addProducts(products)\n .then(() => {\n // Only show the Mini Cart if the site is not being viewed on mobile\n if (formFactor !== \"Mobile\") {\n cart.showMiniCart();\n // After displaying the Mini Cart for 3 seconds, hide the Mini Cart\n setTimeout(() => cart.hideMiniCart(), 3000);\n }\n })\n .catch((error) => {\n console.error(error);\n });\n"}],"description":"**Deprecated.**\r\nThis function will continue to work, but will soon be deprecated. Hiding the Mini Cart or Side Cart can be done by clicking anywhere else on the page.\r\n\r\nHides the Mini Cart.\r\n\r\nThe `hideMiniCart()` function hides the Mini Cart.\r\nLearn more about the [Mini Cart](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-the-mini-cart).\r\n\r\n> **Note:** This API will fail when viewing the site on mobile because there is no Mini Cart on the mobile site."},{"name":"onChange","fqn":"Cart.onChange","slug":"on-change","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["handler"],"adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event when a cart is changed","description":"This example uses a deprecated function.","content":"/************************************\n * Global (Site) code (masterPage.js) *\n ************************************/\n\nimport { cart } from 'wix-stores-frontend';\n\n$w.onReady(function () {\n cart.onChange((changedCart) => {\n const cartId = changedCart._id;\n const cartLineItems = changedCart.lineItems;\n });\n});\n\n\n/* Example of returned changedCart object:\n *\n * {\n * \"_id\": \"b36eb035-635a-450e-b74d-acf86ee4dfcc\",\n * \"appliedCoupon\": {\n * \"couponId\": \"e81e9c48-f954-4044-ba64-ccfe5c103c8f\",\n * \"name\": \"Summer Sale\",\n * \"code\": \"SummerSale\",\n * \"discountValue\": \"$10.00\",\n * \"couponType\": \"MoneyOff\"\n * },\n * \"billingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"buyerNote\": \"This is a note from the buyer.\",\n * \"buyerInfo\":{\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"phone\": \"5555555555\",\n * \"identityType\": \"CONTACT\"\n * },\n * \"status\": \"INCOMPLETE\",\n * \"currency\": {\n * \"code\": \"USD\",\n * \"symbol\": \"$\"\n * },\n * \"shippingInfo\": {\n * \"deliveryOption\": \"Free Shipping\",\n * \"shippingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"pickupDetails\":null\n * },\n * \"lineItems\":[\n * {\n * \"quantity\": 1,\n * \"price\": 120,\n * \"name\": \"A product\",\n * \"productId\": \"a668ef33-f5b8-6569-d04c-1d123be68441\",\n * \"totalPrice\": 120,\n * \"lineItemType\": \"PHYSICAL\",\n * \"customTextFields\": [\n * \"title\": \"Custom Field\",\n * \"value\": \"Custom value\"\n * ],\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_ed3b544c319b4fad9c222c791a997832.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"21554345656\",\n * \"options\": [ ],\n * \"weight\": 3,\n * \"id\": 1\n * },\n * {\n * \"quantity\": 1,\n * \"price\": 25,\n * \"name\": \"Another product\",\n * \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"totalPrice\": 25,\n * \"lineItemType\": \"PHYSICAL\",\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_c6158b4d41784ae8b08337a331e1de7f.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"217537123517253\",\n * \"options\": [\n * {\n * \"option\": \"Size\",\n * \"selection\": \"Medium\"\n * },\n * {\n * \"option\": \"Color\",\n * \"selection\": \"Black\"\n * }\n * ],\n * \"weight\": 2,\n * \"id\": 2\n * }\n * ],\n * \"totals\": {\n * \"discount\": 0,\n * \"quantity\": 2,\n * \"shipping\": 0,\n * \"subtotal\": 145,\n * \"tax\": 0,\n * \"total\": 145,\n * \"weight\": 5\n * },\n * \"weightUnit\": \"LB\"\n * }\n *\n */"}],"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartChangedHandler","referenceFqn":"CartChangedHandler","isFunction":true},"description":"The name of the function to run when a cart changes."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-frontend.onCartChange()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/on-cart-change).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-frontend.onCartChange()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/on-cart-change).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import wixEcomFrontend from \"wix-ecom-frontend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.onChange()`,\r\n> and replace it with `wixEcomFrontend.onCartChange()`.\r\n> The new `onCartChange()` event handler does not return the changed cart. Update your code accordingly.\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\n\r\nAn event handler that is triggered when items are added or removed from a cart.\r\n\r\nThe `onChange()` function is a client-side event handler invoked every time the cart changes. It takes a callback function which receives the new `Cart` object as a parameter.\r\n\r\n> **Notes:**\r\n> + Use `onChange()` in the global site code file (masterPage.js). This ensures the event is triggered when a change to the cart is made on any page. Learn more about [global (site) code](https://support.wix.com/en/article/velo-working-with-the-velo-sidebar#global-site).\r\n> + The `onChange()` function can only be used once a page has loaded. Therefore, you must use it in code that is contained in or is called from the [onReady()]($w.html#onReady) event handler or any element event handler.\r\n> + When [editing a site as a contributor](https://support.wix.com/en/article/velo-working-with-contributors), `onChange()` will only work when viewing the live site."},{"name":"removeCoupon","fqn":"Cart.removeCoupon","slug":"remove-coupon","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CartObj","referenceFqn":"CartObj"},"description":"Fulfilled - The updated cart."},"examples":[{"title":"Remove coupon from the cart","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\n\ncart.removeCoupon()\n .then((updatedCart) => {\n const cartId = updatedCart._id;\n const cartLineItems = updatedCart.lineItems;\n })\n .catch((error) => {\n console.error(error);\n });\n\n\n/* Example of returned updatedCart object:\n *\n * {\n * \"_id\": \"b36eb035-635a-450e-b74d-acf86ee4dfcc\",\n * \"appliedCoupon\": \"null\",\n * \"billingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"buyerNote\": \"This is a note from the buyer.\",\n * \"buyerInfo\":{\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"phone\": \"5555555555\",\n * \"identityType\": \"CONTACT\"\n * },\n * \"status\": \"INCOMPLETE\",\n * \"currency\": {\n * \"code\": \"USD\",\n * \"symbol\": \"$\"\n * },\n * \"shippingInfo\": {\n * \"deliveryOption\": \"Free Shipping\",\n * \"shippingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"pickupDetails\":null\n * },\n * \"lineItems\":[\n * {\n * \"quantity\": 1,\n * \"price\": 120,\n * \"name\": \"A product\",\n * \"productId\": \"a668ef33-f5b8-6569-d04c-1d123be68441\",\n * \"totalPrice\": 120,\n * \"lineItemType\": \"PHYSICAL\",\n * \"customTextFields\": [\n * \"title\": \"Custom Field\",\n * \"value\": \"Custom value\"\n * ],\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_ed3b544c319b4fad9c222c791a997832.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"21554345656\",\n * \"options\": [ ],\n * \"weight\": 3,\n * \"id\": 1\n * },\n * {\n * \"quantity\": 1,\n * \"price\": 25,\n * \"name\": \"Another product\",\n * \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"totalPrice\": 25,\n * \"lineItemType\": \"PHYSICAL\",\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_c6158b4d41784ae8b08337a331e1de7f.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"217537123517253\",\n * \"options\": [\n * {\n * \"option\": \"Size\",\n * \"selection\": \"Medium\"\n * },\n * {\n * \"option\": \"Color\",\n * \"selection\": \"Black\"\n * }\n * ],\n * \"weight\": 2,\n * \"id\": 2\n * }\n * ],\n * \"totals\": {\n * \"discount\": 0,\n * \"quantity\": 2,\n * \"shipping\": 0,\n * \"subtotal\": 145,\n * \"tax\": 0,\n * \"total\": 145,\n * \"weight\": 5\n * },\n * \"weightUnit\": \"LB\"\n * }\n */"}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-backend.currentCart.removeCouponFromCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/remove-coupon-from-current-cart).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-backend.currentCart.removeCouponFromCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/remove-coupon-from-current-cart).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { currentCart } from \"wix-ecom-backend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.removeCoupon()`,\r\n> and replace it with `currentCart.removeCouponFromCurrentCart()`.\r\n> Update your code to work with the new `currentCart.removeCouponFromCurrentCart()`\r\n> call and response properties.\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\nRemoves the coupon currently applied to the cart.\r\n\r\n The `removeCoupon()` function returns a Promise that resolves to the current\r\n site visitor's cart when the currently applied coupon has been removed.\r\n\r\n> **Note:** When [editing a site as a contributor](https://support.wix.com/en/article/velo-working-with-contributors), `removeCoupon()` will only work when viewing the live site."},{"name":"removeProduct","fqn":"Cart.removeProduct","slug":"remove-product","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cartLineItemId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CartObj","referenceFqn":"CartObj"},"description":"Fulfilled - The updated cart."},"examples":[{"title":"Remove item with `id: 3` from cart","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\n\nconst cartLineItemId = 3;\n\ncart.removeProduct(cartLineItemId)\n .then((updatedCart) => {\n // Product successfully removed\n const cartLineItems = updatedCart.lineItems;\n })\n .catch((error) => {\n // Product not removed\n console.error(error);\n });\n\n\n/* Example of returned updatedCart:\n *\n * {\n * \"_id\": \"b36eb035-635a-450e-b74d-acf86ee4dfcc\",\n * \"appliedCoupon\": {\n * \"couponId\": \"e81e9c48-f954-4044-ba64-ccfe5c103c8f\",\n * \"name\": \"Summer Sale\",\n * \"code\": \"SummerSale\",\n * \"discountValue\": \"$10.00\",\n * \"couponType\": \"MoneyOff\"\n * },\n * \"billingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"buyerNote\": \"This is a note from the buyer.\",\n * \"buyerInfo\":{\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"phone\": \"5555555555\",\n * \"identityType\": \"CONTACT\"\n * },\n * \"status\": \"INCOMPLETE\",\n * \"currency\": {\n * \"code\": \"USD\",\n * \"symbol\": \"$\"\n * },\n * \"shippingInfo\": {\n * \"deliveryOption\": \"Free Shipping\",\n * \"shippingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"pickupDetails\":null\n * },\n * \"lineItems\":[\n * {\n * \"quantity\": 1,\n * \"price\": 120,\n * \"name\": \"A product\",\n * \"productId\": \"a668ef33-f5b8-6569-d04c-1d123be68441\",\n * \"totalPrice\": 120,\n * \"lineItemType\": \"PHYSICAL\",\n * \"customTextFields\": [\n * \"title\": \"Custom Field\",\n * \"value\": \"Custom value\"\n * ],\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_ed3b544c319b4fad9c222c791a997832.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"21554345656\",\n * \"options\": [ ],\n * \"weight\": 3,\n * \"id\": 1\n * },\n * {\n * \"quantity\": 1,\n * \"price\": 25,\n * \"name\": \"Another product\",\n * \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"totalPrice\": 25,\n * \"lineItemType\": \"PHYSICAL\",\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_c6158b4d41784ae8b08337a331e1de7f.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"217537123517253\",\n * \"options\": [\n * {\n * \"option\": \"Size\",\n * \"selection\": \"Medium\"\n * },\n * {\n * \"option\": \"Color\",\n * \"selection\": \"Black\"\n * }\n * ],\n * \"weight\": 2,\n * \"id\": 2\n * }\n * ],\n * \"totals\": {\n * \"discount\": 0,\n * \"quantity\": 2,\n * \"shipping\": 0,\n * \"subtotal\": 145,\n * \"tax\": 0,\n * \"total\": 145,\n * \"weight\": 5\n * },\n * \"weightUnit\": \"LB\"\n * }\n *\n */\n"},{"title":"Remove item by `productId`","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\n\nconst productIdToRemove = \"3fb6a3c8-988b-8755-04bd-5c59ae0b18ea\";\n\ncart.getCurrentCart()\n .then((currentCart) => {\n\n // Find the cart item by productId\n const itemToRemove = currentCart.lineItems.find(lineItem => lineItem.productId === productIdToRemove);\n\n // If the item is found, remove it from the cart\n if (itemToRemove) {\n cart.removeProduct(itemToRemove.id)\n .then((updatedCart) => {\n // Product successfully removed\n const cartLineItems = updatedCart.lineItems;\n })\n .catch((error) => {\n // Product not removed\n console.error(error);\n });\n } else {\n console.log(\"Item not found by productId\")\n }\n });\n\n\n/* Example of returned updatedCart object:\n *\n * {\n * \"_id\": \"b36eb035-635a-450e-b74d-acf86ee4dfcc\",\n * \"appliedCoupon\": {\n * \"couponId\": \"e81e9c48-f954-4044-ba64-ccfe5c103c8f\",\n * \"name\": \"Summer Sale\",\n * \"code\": \"SummerSale\",\n * \"discountValue\": \"$10.00\",\n * \"couponType\": \"MoneyOff\"\n * },\n * \"billingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"buyerNote\": \"This is a note from the buyer.\",\n * \"buyerInfo\":{\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\": \"john.doe@somedomain.com\",\n * \"phone\": \"5555555555\",\n * \"identityType\": \"CONTACT\"\n * },\n * \"status\": \"INCOMPLETE\",\n * \"currency\": {\n * \"code\": \"USD\",\n * \"symbol\": \"$\"\n * },\n * \"shippingInfo\": {\n * \"deliveryOption\": \"Free Shipping\",\n * \"shippingAddress\": {\n * \"firstName\": \"John\",\n * \"lastName\": \"Doe\",\n * \"email\":\"john.doe@somedomain.com\",\n * \"phone\":\"5555555\",\n * \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n * },\n * \"pickupDetails\":null\n * },\n * \"lineItems\":[\n * {\n * \"quantity\": 1,\n * \"price\": 120,\n * \"name\": \"A product\",\n * \"productId\": \"a668ef33-f5b8-6569-d04c-1d123be68441\",\n * \"totalPrice\": 120,\n * \"lineItemType\": \"PHYSICAL\",\n * \"customTextFields\": [\n * \"title\": \"Custom Field\",\n * \"value\": \"Custom value\"\n * ],\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_ed3b544c319b4fad9c222c791a997832.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"21554345656\",\n * \"options\": [ ],\n * \"weight\": 3,\n * \"id\": 1\n * },\n * {\n * \"quantity\": 1,\n * \"price\": 25,\n * \"name\": \"Another product\",\n * \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"totalPrice\": 25,\n * \"lineItemType\": \"PHYSICAL\",\n * \"mediaItem\": {\n * \"src\": \"wix:image://v1/a9ff3b_c6158b4d41784ae8b08337a331e1de7f.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n * \"type\": \"IMAGE\"\n * },\n * \"sku\": \"217537123517253\",\n * \"options\": [\n * {\n * \"option\": \"Size\",\n * \"selection\": \"Medium\"\n * },\n * {\n * \"option\": \"Color\",\n * \"selection\": \"Black\"\n * }\n * ],\n * \"weight\": 2,\n * \"id\": 2\n * }\n * ],\n * \"totals\": {\n * \"discount\": 0,\n * \"quantity\": 2,\n * \"shipping\": 0,\n * \"subtotal\": 145,\n * \"tax\": 0,\n * \"total\": 145,\n * \"weight\": 5\n * },\n * \"weightUnit\": \"LB\"\n * }\n *\n */\n"}],"actionParams":[{"name":"cartLineItemId","slug":"cart-line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"ID of the cart line item to remove."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-backend.currentCart.removeLineItemsFromCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/remove-line-items-from-current-cart).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-backend.currentCart.removeLineItemsFromCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/remove-line-items-from-current-cart).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { currentCart } from \"wix-ecom-backend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.removeProduct()`,\r\n> and replace it with `currentCart.removeLineItemsFromCurrentCart()`.\r\n> Update your code to work with the new `currentCart.removeLineItemsFromCurrentCart()`\r\n> call and response properties.\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\nRemoves a specified product from the cart.\r\n\r\n The `removeProduct()` function returns a Promise that resolves to the\r\n updated cart after the product is removed.\r\n Every line item in a cart has an ID. Pass this to `removeProduct()` to remove that line item/product from the cart.\r\n\r\n> **Notes:**\r\n> + `removeProduct()` does not decrement the line item's quantity, it removes the line item/product altogether.\r\n> + When [editing a site as a contributor](https://support.wix.com/en/article/velo-working-with-contributors), `removeProduct()` will only work when viewing the live site."},{"name":"showMiniCart","fqn":"Cart.showMiniCart","slug":"show-mini-cart","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"Add products to the cart, then show the Mini Cart","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\nimport { formFactor } from 'wix-window-frontend';\n\nconst products = [{\n \"productId\": \"0873ed58-f88d-77d1-4566-afd4c50d253e\",\n \"quantity\": 2\n}];\n\ncart.addProducts(products)\n .then(() => {\n // Only show the Mini Cart if the site is not being viewed on mobile\n if (formFactor !== \"Mobile\") {\n cart.showMiniCart();\n }\n })\n .catch((error) => {\n console.error(error);\n });\n"}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-frontend.openSideCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/open-side-cart).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-frontend.openSideCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/open-side-cart).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import wixEcomFrontend from \"wix-ecom-frontend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.showMiniCart()`,\r\n> and replace it with `wixEcomFrontend.openSideCart()`.\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\nShows the Mini Cart.\r\n\r\nThe `showMiniCart()` function displays the Mini Cart.\r\nLearn more about the [Mini Cart](https://support.wix.com/en/article/wix-stores-adding-and-setting-up-the-mini-cart).\r\n> **Note:** This API will fail when viewing the site on mobile because there is no Mini Cart on the mobile site."},{"name":"updateLineItemQuantity","fqn":"Cart.updateLineItemQuantity","slug":"update-line-item-quantity","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["cartLineItemId","quantity"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"CartObj","referenceFqn":"CartObj"},"description":"Fulfilled - The updated cart."},"examples":[{"title":"Update the quantity of a cart's line item","description":"This example uses a deprecated function.","content":"import { cart } from 'wix-stores-frontend';\n\nconst cartLineItemId = 2;\nconst quantity = 10;\n\ncart.updateLineItemQuantity(cartLineItemId, quantity)\n .then((updatedCart) => {\n // Cart line item's quantity updated\n const cartId = updatedCart._id;\n const updatedLineItems = updatedCart.lineItems;\n })\n .catch((error) => {\n // Cart line item's quantity not updated\n console.log(error);\n })\n\n\n/* Example of returned updatedCart object:\n*\n* {\n* \"_id\": \"b36eb035-635a-450e-b74d-acf86ee4dfcc\",\n* \"appliedCoupon\": {\n* \"couponId\": \"e81e9c48-f954-4044-ba64-ccfe5c103c8f\",\n* \"name\": \"Summer Sale\",\n* \"code\": \"SummerSale\",\n* \"discountValue\": \"$10.00\",\n* \"couponType\": \"MoneyOff\"\n* },\n* \"billingAddress\": {\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\":\"john.doe@somedomain.com\",\n* \"phone\":\"5555555\",\n* \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n* },\n* \"buyerNote\": \"This is a note from the buyer.\",\n* \"buyerInfo\":{\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\": \"john.doe@somedomain.com\",\n* \"phone\": \"5555555555\",\n* \"identityType\": \"CONTACT\"\n* },\n* \"status\": \"INCOMPLETE\",\n* \"currency\": {\n* \"code\": \"USD\",\n* \"symbol\": \"$\"\n* },\n* \"shippingInfo\": {\n* \"deliveryOption\": \"Free Shipping\",\n* \"shippingAddress\": {\n* \"firstName\": \"John\",\n* \"lastName\": \"Doe\",\n* \"email\":\"john.doe@somedomain.com\",\n* \"phone\":\"5555555\",\n* \"address\":\"235 West 23rd Street\\nNew York, New York 10011\\nUnited States\"\n* },\n* \"pickupDetails\":null\n* },\n* \"lineItems\":[\n* {\n* \"quantity\": 1,\n* \"price\": 120,\n* \"name\": \"A product\",\n* \"productId\": \"a668ef33-f5b8-6569-d04c-1d123be68441\",\n* \"totalPrice\": 120,\n* \"lineItemType\": \"PHYSICAL\",\n* \"customTextFields\": [\n* \"title\": \"Custom Field\",\n* \"value\": \"Custom value\"\n* ],\n* \"mediaItem\": {\n* \"src\": \"wix:image://v1/a9ff3b_ed3b544c319b4fad9c222c791a997832.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n* \"type\": \"IMAGE\"\n* },\n* \"sku\": \"21554345656\",\n* \"options\": [ ],\n* \"weight\": 3,\n* \"id\": 1\n* },\n* {\n* \"quantity\": 10,\n* \"price\": 25,\n* \"name\": \"Another product\",\n* \"productId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n* \"totalPrice\": 25,\n* \"lineItemType\": \"PHYSICAL\",\n* \"mediaItem\": {\n* \"src\": \"wix:image://v1/a9ff3b_c6158b4d41784ae8b08337a331e1de7f.jpg/file.jpg#originWidth=1000&originHeight=1000\",\n* \"type\": \"IMAGE\"\n* },\n* \"sku\": \"217537123517253\",\n* \"options\": [\n* {\n* \"option\": \"Size\",\n* \"selection\": \"Medium\"\n* },\n* {\n* \"option\": \"Color\",\n* \"selection\": \"Black\"\n* }\n* ],\n* \"weight\": 2,\n* \"id\": 2\n* }\n* ],\n* \"totals\": {\n* \"discount\": 0,\n* \"quantity\": 2,\n* \"shipping\": 0,\n* \"subtotal\": 145,\n* \"tax\": 0,\n* \"total\": 145,\n* \"weight\": 5\n* },\n* \"weightUnit\": \"LB\"\n* }\n*/"}],"actionParams":[{"name":"cartLineItemId","slug":"cart-line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"ID of the cart line item to update."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item's new quantity."}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-backend.currentCart.updateCurrentCartLineItemQuantity()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/update-current-cart-line-item-quantity).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-backend.currentCart.updateCurrentCartLineItemQuantity()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/update-current-cart-line-item-quantity).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import { currentCart } from \"wix-ecom-backend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `cart.updateLineItemQuantity()`,\r\n> and replace it with `currentCart.updateCurrentCartLineItemQuantity()`.\r\n> Update your code to work with the new `currentCart.updateCurrentCartLineItemQuantity()`\r\n> call and response properties.\r\n\r\nUpdates the quantity of a specified line item in the cart.\r\n\r\n The `updateLineItemQuantity()` function returns a Promise that resolves to the current\r\n site visitor's cart when the specified line item's quantity has been updated.\r\n\r\n> **Note:** When [editing a site as a contributor](https://support.wix.com/en/article/velo-working-with-contributors), `updateLineItemQuantity()` will only work when viewing the live site."}],"webhooks":[],"articles":[{"content":"# Introduction\n> **Note:**\n> The `wix-stores-frontend.Cart` modules is deprecated.\n> If you're already using this modules in your code, it will continue to work.\n> To stay compatible with future changes, update your code\n> with the migration instructions in this module's functions.\n\nThe `wix-stores-frontend.Cart` module contains functionality for working with your\n site's cart from client-side code.\n\n To use the Wix Stores Cart API, import `{ cart }` from the `wix-stores-frontend` module:\n\n ```javascript\n import { cart } from 'wix-stores-frontend';\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"Navigate","slug":"navigate","fqn":"Navigate","standaloneTypes":[],"metadata":{},"actions":[{"name":"toCart","fqn":"Navigate.toCart","slug":"to-cart","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the browser is directed to the site visitor's cart page."},"examples":[{"title":"Navigate to the site's cart page","description":"This example uses a deprecated function.","content":"import { navigate } from 'wix-stores-frontend';\n\n// ...\n\n$w('#myButton').onclick(() => {\n navigate.toCart();\n});"},{"title":"Navigate to the site's cart page - error handling","description":"This example uses a deprecated function.","content":"import { navigate } from 'wix-stores-frontend';\n\n// ...\n\n$w('#myButton').onclick(() => {\n navigate.toCart()\n .then(() => {\n console.log('Navigating to cart...');\n })\n .catch((error) => {\n console.error(error);\n // Handle the error\n });\n});"}],"description":"**Deprecated.**\r\nThis function will continue to work, but a newer version is available at\r\n[`wix-ecom-frontend.navigateToCartPage()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/navigate-to-cart-page).\r\n\r\n> #### Migration Instructions\r\n>\r\n> If this function is already in your code, it will continue to work.\r\n> To stay compatible with future changes, migrate to\r\n> [`wix-ecom-frontend.navigateToCartPage()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/navigate-to-cart-page).\r\n>\r\n> To migrate to the new function:\r\n>\r\n> 1. Add the new import statement:\r\n>\r\n> ```javascript\r\n> import wixEcomFrontend from \"wix-ecom-frontend\";\r\n> ```\r\n>\r\n> 2. Look for any code that uses `navigate.toCart()`,\r\n> and replace it with `wixEcomFrontend.navigateToCartPage()`.\r\n>\r\n> 3. Test your changes to make sure your code behaves as expected.\r\n\r\nDirects the browser to navigate to the site visitor's cart page.\r\n\r\n The `toCart()` function navigates the browser to the site visitor's cart page."}],"webhooks":[],"articles":[{"content":"# Introduction\nTo use the Wix Stores Navigate API, import `{ navigate }` from the `wix-stores-frontend` module:\n\n ```javascript\n import { navigate } from 'wix-stores-frontend';\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]},{"name":"Product","slug":"product","fqn":"Product","standaloneTypes":[],"metadata":{},"actions":[{"name":"getOptionsAvailability","fqn":"Product.getOptionsAvailability","slug":"get-options-availability","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["productId","choices"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ProductOptionsAvailability","referenceFqn":"ProductOptionsAvailability"},"description":"Fulfilled - The availability information of the product."},"examples":[{"title":"Get a product's availability information","description":"This example gets a product's availability information by specifying an option choice.\n Since all the product's options have a corresponding choice, a variant is selected.","content":"import { product } from 'wix-stores-frontend';\n\nconst productId = \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\";\nconst choices = {\n \"Weight\": \"250g\",\n \"Ground for\": \"Stovetop\"\n};\n\nproduct.getOptionsAvailability(productId, choices)\n .then((availability) => {\n const available = availability.availableForPurchase;\n const options = availability.productOptions;\n const mainMedia = availability.mainMedia;\n const mediaItems = availability.mediaItems;\n const selectedVariant = availability.selectedVariant;\n })\n .catch((error) => {\n console.log(error);\n });\n\n\n/*\n * Example of returned availability object:\n *\n * {\n * \"availableForPurchase\": true,\n * \"productOptions\": {\n * \"Weight\": {\n * \"optionType\": \"drop_down\",\n * \"name\": \"Weight\",\n * \"choices\": [\n * {\n * \"value\": \"250g\",\n * \"description\": \"250g\",\n * \"inStock\": true,\n * \"visible\": true,\n * \"mainMedia\": \"null\",\n * \"mediaItems\": []\n * },\n * {\n * \"value\": \"500g\",\n * \"description\": \"500g\",\n * \"inStock\": true,\n * \"visible\": true,\n * \"mainMedia\": \"null\",\n * \"mediaItems\": []\n * }\n * ]\n * },\n * \"Ground for\": {\n * \"optionType\": \"drop_down\",\n * \"name\": \"Ground for\",\n * \"choices\": [\n * {\n * \"value\": \"Stovetop\",\n * \"description\": \"Stovetop\",\n * \"inStock\": true,\n * \"visible\": true,\n * \"mainMedia\": \"null\",\n * \"mediaItems\": []\n * },\n * {\n * \"value\": \"Filter\",\n * \"description\": \"Filter\",\n * \"inStock\": true,\n * \"visible\": true,\n * \"mainMedia\": \"null\",\n * \"mediaItems\": []\n * }\n * ]\n * }\n * },\n * \"mainMedia\": \"null\",\n * \"mediaItems\": [],\n * \"selectedVariant\": {\n * \"sku\": \"10001\",\n * \"currency\": \"USD\",\n * \"price\": 35,\n * \"discountedPrice\": 30,\n * \"formattedPrice\": \"$35.00\",\n * \"formattedDiscountedPrice\": \"$30.00\",\n * \"visible\": true,\n * \"inStock\": true,\n * \"weight\": 0.25\n * }\n * }\n *\n */"}],"actionParams":[{"name":"productId","slug":"product-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The ID of the product whose availability is being checked."},{"name":"choices","slug":"choices","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"object"},"description":"Option choices to use when checking the product's availability in the form of\r\nan object containing a key:value pair for each product option. For example, if a product has a size option, the key will be something like \"Size\" and its value will be something like \"Large\"."}],"description":"Gets the availability of a product based on the specified option choices.\r\n\r\nThe `getProductOptionsAvailability()` function returns a Promise that is resolved\r\n to a `ProductOptionsAvailability` object when the product's availability information\r\n about the product is retrieved.\r\n\r\n The information returned in the `selectedVariant` and `availableForPurchase`\r\n properties reflects the option choices passed in the `choices` parameter.\r\n\r\n If the specified choices result in the selection of a single product variant,\r\n that variant is returned in the `selectedVariant` property and the `availableForPurchase`\r\n property indicates whether that product variant is available for purchase.\r\n\r\n If the choices specified in the `choices` parameter do not result in the selection of a single product variant,\r\n no variant is returned in the `selectedVariant` property and the `availableForPurchase`\r\n property will be `false`."},{"name":"getVariants","fqn":"Product.getVariants","slug":"get-variants","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["productId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"VariantItem","referenceFqn":"VariantItem"}},"description":"Fulfilled - The variants with the specified choices."},"examples":[{"title":"Get product variants by specified choices","content":"import { product } from 'wix-stores-frontend';\n\nconst productId = \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\";\nconst options = {\n choices: {\n \"Weight\": \"500g\"\n }\n};\n\nproduct.getVariants(productId, options)\n .then((variants) => {\n const firstVariant = variants[0];\n const firstPrice = firstVariant.variant.price;\n const numberOfReturnedVariants = variants.length;\n })\n .catch((error) => {\n console.error(error);\n });\n\n\n/*\n * Example of returned variants:\n *\n * [\n * {\n * \"_id\": \"00000000-0000-003f-0005-a316e6ba5b37\",\n * \"choices\": {\n * \"Weight\": \"500g\",\n * \"Ground for\": \"Stovetop\"\n * },\n * \"variant\": {\n * \"currency\": \"USD\",\n * \"price\": 65,\n * \"discountedPrice\": 60,\n * \"pricePerUnit\": 0.24,\n * \"formattedPrice\": \"$65.00\",\n * \"formattedDiscountedPrice\": \"$65.00\",\n * \"formattedPricePerUnit\": \"$0.24\",\n * \"weight\": 0.5,\n * \"sku\": \"10002\",\n * \"visible\": true\n * }\n * },\n * {\n * \"_id\": \"00000000-0000-0040-0005-a316e6ba5b37\",\n * \"choices\": {\n * \"Weight\": \"500g\",\n * \"Ground for\": \"Filter\"\n * },\n * \"variant\": {\n * \"currency\": \"USD\",\n * \"price\": 70,\n * \"discountedPrice\": 65,\n * \"pricePerUnit\": 0.26,\n * \"formattedPrice\": \"$70.00\",\n * \"formattedDiscountedPrice\": \"$70.00\",\n * \"formattedPricePerUnit\": \"$0.26\",\n * \"weight\": 1,\n * \"sku\": \"10004\",\n * \"visible\": true\n * }\n * }\n * ]\n *\n */"},{"title":"Get product variants by variant IDs","content":"import { product } from 'wix-stores-frontend';\n\nconst productId = \"91f7ac8b-2baa-289c-aa50-6d64764f35d3\";\nconst options = {\n variantIds: [\n \"00000000-0000-0020-0005-a316e6ba5b37\",\n \"00000000-0000-003f-0005-a316e6ba5b37\"\n ]\n};\n\nproduct.getVariants(productId, options)\n .then((variants) => {\n const firstVariant = variants[0];\n const firstPrice = firstVariant.variant.price;\n const numberOfReturnedVariants = variants.length;\n })\n .catch((error) => {\n console.error(error);\n })\n\n\n/*\n * Example of returned variants array:\n *\n * [\n * {\n * \"_id\": \"00000000-0000-0020-0005-a316e6ba5b37\",\n * \"choices\": {\n * \"Weight\": \"250g\",\n * \"Ground for\": \"Stovetop\"\n * },\n * \"variant\": {\n * \"currency\": \"USD\",\n * \"price\": 35,\n * \"discountedPrice\": 30,\n * \"pricePerUnit\": 0.12,\n * \"formattedPrice\": \"$35.00\",\n * \"formattedDiscountedPrice\": \"$35.00\",\n * \"formattedPricePerUnit\": \"$0.12\",\n * \"weight\": 0.25,\n * \"sku\": \"10001\",\n * \"visible\": true\n * }\n * },\n * {\n * \"_id\": \"00000000-0000-003f-0005-a316e6ba5b37\",\n * \"choices\": {\n * \"Weight\": \"500g\",\n * \"Ground for\": \"Stovetop\"\n * },\n * \"variant\": {\n * \"currency\": \"USD\",\n * \"price\": 65,\n * \"discountedPrice\": 60,\n * \"pricePerUnit\": 0.24,\n * \"formattedPrice\": \"$65.00\",\n * \"formattedDiscountedPrice\": \"$65.00\",\n * \"formattedPricePerUnit\": \"$0.24\",\n * \"weight\": 0.5,\n * \"sku\": \"10002\",\n * \"visible\": true\n * }\n * }\n * ]\n *\n */"}],"actionParams":[{"name":"productId","slug":"product-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the product whose variants are being retrieved. Pass only this field to retrieve all of the specified product's variants."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductVariantOptions","referenceFqn":"ProductVariantOptions"},"description":"Variant options to return. If not specified, all the product's variants are returned."}],"description":"Gets a product's available variants based on the specified product ID and either option choices or variant IDs.\r\n\r\nThe `getProductVariants()` function returns a Promise that is resolved\r\n to an array of `VariantItem` objects when the product variants with the specified\r\n choices or variant IDs are retrieved."},{"name":"openQuickView","fqn":"Product.openQuickView","slug":"open-quick-view","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":false,"maturity":"GA","requiredProperties":["productId"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"},"description":"Fulfilled - When the Quick View modal is opened."},"examples":[{"title":"Open Quick View modal","content":"import { product } from 'wix-stores-frontend';\n\n// ...\n\n$w('#myButton').onclick(() => {\n const productId = \"c329246b-d521-feb4-85f5-539ca992d73a\";\n\n product.openQuickView(productId)\n .then(() => {\n console.log('Opening Quick View...');\n })\n .catch((error) => {\n console.error(error);\n // Handle the error\n });\n});"},{"title":"Open Quick View modal with options","content":"import { product } from 'wix-stores-frontend';\n\n// ...\n\n$w('#myButton').onclick(() => {\n const productId = \"c329246b-d521-feb4-85f5-539ca992d73a\";\n const options = {\n quantity: 13\n };\n\n product.openQuickView(productId, options)\n .then(() => {\n console.log('Opening Quick View...');\n })\n .catch((error) => {\n console.error(error);\n // Handle the error\n });\n});"}],"actionParams":[{"name":"productId","slug":"product-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the product to be displayed in the Quick View."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"QuickViewOptions","referenceFqn":"QuickViewOptions"},"description":"Quick View options."}],"description":"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.\r\n\r\nThe `openQuickView()` function returns a Promise that is resolved\r\n when the Quick View modal is opened.\r\n\r\nThe quantity input field in the Quick View will be pre-populated with 1, unless otherwise specified in the `options.quantity` field.\r\n\r\nIf the product has different [options or variants](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#product-option-faqs),\r\nthey will be displayed for selection in the opened Quick View.\r\n\r\n>**Note:**\r\n> This API will fail when viewing the site on mobile because there is no Quick View on the mobile site."}],"webhooks":[],"articles":[{"content":"# Introduction\nTo use the Wix Stores Product API, import `{ product }` from the `wix-stores-frontend` module:\n\n ```javascript\n import { product } from 'wix-stores-frontend';\n ```","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[],"properties":[]}],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"}}