# About the Wix Stores Catalog API

Wix Stores creates a catalog of store owners’ items for purchase and allows store owners to create smaller collections of products by type or theme. A catalog organizes the store’s products and collections and facilitates inventory management. With the Wix Stores Catalog API you can query individual products, collections or the entire catalog, as well as create products and add their media.

Querying the products and collections in the catalog enables you to coordinate a store’s inventory across other sales platforms (e.g., Facebook marketplace), or inventory management tools (e.g., NetSuite, TradeGecko), among other uses.

<blockquote class="important">
  <strong>Catalog V3</strong>

Wix Stores is introducing **Catalog V3**, a new set of APIs for the Wix Stores product catalog, set to roll out in **Q2 2025**.
The new catalog will initially be rolled out to new users only, and over time, Catalog V3 will fully replace Catalog V1.

This upgraded catalog will provide Wix Stores owners with enhanced tools to build more comprehensive
product catalogs and streamline store management.

To remain compatible with all Wix Stores users, your app must be able to support both versions of the catalog:
+ Learn more about how to integrate with the [Catalog V3 APIs](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/introduction).
+ Use the [Catalog Versioning API](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-versioning/introduction) to determine which version of the Wix Stores Catalog a site is using.

</blockquote>

## Terminology
- **The catalog** is a complete list of all the store’s products.
- **Collections** are themed groupings of items for purchase that a store owner can create to organize their products (e.g., Spring 2019, Running shoes, etc.). Products can belong to multiple collections.
- **Options** are property types that customers can select within the specific product - e.g., color and size.
- **Choices** are the available selections within each option - e.g., red and green choices under the Color option.
- **Variants** are combinations of different product options and choices - e.g., a red shirt in size large.
A variant can override the following values from the parent product:
  - Price
  - SKU
  - Weight
  - Inventory

## Error handling
| Status code | Description                                                                                                                         |
|-------------|-------------------------------------------------------------------------------------------------------------------------------------|
| 200         | Success                                                                                                                             |
| 400         | Invalid input (e.g., when the filter format is not valid or when providing invalid options when calling productOptionsAvailability) |
| 401         | Invalid authorization token, or Wix stores is not installed                                                                         |
| 404         | Requested product or collection is not found                                                                                        |
| 500         | Unexpected error                                                                                                                    |

@sdk_package_setup

# Filter and sort

## Query Language

Endpoints that allow querying follow these format [guidelines](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language).

## Query Products

### Fields That Allow Filtering

| Field                     | Operators                                        | Sorting Allowed |
|---------------------------|--------------------------------------------------|-----------------|
| `name`                    | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| `description`             | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` |                 |
| `sku`                     | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| `id`                      | `$eq`,`$ne`,`$hasSome`                           | Allowed         |
| `price`                   | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |
| `numericId`               | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |
| `productType`             | `$eq`,`$ne`,`$hasSome`                           | Allowed         |
| `slug`                    | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| `collections.id`          | `$eq`,`$ne`,`$hasSome`,`$hasAll`                 |                 |
| `options.\<option name\>` | `$eq`,`$ne`,`$hasSome`,`$hasAll`                 |                 |
| `inventoryStatus`         | `$eq`,`$ne`,`$hasSome`                           |                 |        
| `lastUpdated`             | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |
| `createdDate`             | `$eq`,`$ne`,`$hasSome`,`$lt`,`$lte`,`$gt`,`$gte` | Allowed         |

** Note that "hasSome" is same as the operator "IN" in SQL

### Examples

**Query products where price = 10**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"price\": \"10\"}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
``` 

**Query products, order by price descending**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"price\": \"desc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
``` 

**Getting all products for a given collection**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"collections.id\": { \"$hasSome\": [\"your_collection_id_here\"]} }"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

**Getting multiple products by IDs**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"id\": {\"$hasSome\": [\"YOUR_PRODUCT_ID_HERE\", \"YOUR_PRODUCT_ID_HERE\"]}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

**Getting all products with a specific choice**

```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"filter":"{\"productOptions.size\": \"L\"}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

**Getting all products in a store**

1. Get the first page:
```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"numericId\": \"asc\"}]"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
``` 

2. Take the numericId of the last returned item and run the following query:
```
curl 'https://www.wixapis.com/stores/v1/products/query' --data-binary '{"query":{"sort":"[{\"numericId\": \"asc\"}]","filter":"{\"numericId\": {\"$gt\": LAST_NUMERIC_ID}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

3. Continue until no more records are returned.

## Query Collections

### Fields That Allow Filtering

| Field | Operators                                        | Sorting Allowed |
|-------|--------------------------------------------------|-----------------|
| name  | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |
| id    | `$eq`,`$ne`,`$hasSome`,`$contains`,`$startsWith` | Allowed         |

** Note that "hasSome" is same as the operator "IN" in SQL

### Examples

**Query collections where name = my collection**

```
curl 'https://www.wixapis.com/stores/v1/collections/query' --data-binary '{"query":{"filter":"{\"name\": \"my collection\"}}"}}' -H 'Content-Type: application/json' -H 'Authorization: XXX'
```

# Use Cases

In this example we will query a product variant: 
* The product is a `Shirt`.
* The `Shirt` has 2 **options** - `Size` and `Color`.
* The size option has 3 **choices** - `S`/`M`/`L`.
* The color option has 3 **choices** - `Red`/`Green`/`Blue`.
* The product **variant** `S`+`Red` is out of stock.

**Call [Get Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog/get-product) to retrieve product options**

::::tabs
:::REST_TAB
```curl
    curl -X GET \
    'https: //www.wixapis.com/stores/v1/products/91f7ac8b-2baa-289c-aa50-6d64764f35d3' \
    -H 'Authorization: <AUTH>'
   ```
:::
:::SDK_TAB
```js
import { products } from "@wix/stores";

const id = "91f7ac8b-2baa-289c-aa50-6d64764f35d3"

async function getProduct(id) {
  const response = await products.getProduct(id);
}
```
:::
::::

```json
{
  ...
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ]
}
```

**Call [Get Product Options Availability](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog/get-product-options-availability) to retrieve the `S` size availability**  

Notice in the response that:
- `Red` is out of stock because `S`+`Red` is out of stock.
- `availableForPurchase` is false because both size and color must be given for this product.

::::tabs
:::REST_TAB
```curl
   curl -X POST \
    'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/productOptionsAvailability' \
    -d '{
          "options": {
            "size": "S"
          }
        }' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>'
   ```
:::
:::SDK_TAB
```js
import { products } from "@wix/stores";

const id = "1044e7e4-37d1-0705-c5b3-623baae212fd"

const options = {
  size = "S"
}

async function getProductOptionsAvailability(id, options) {
  const response = await products.getProductOptionsAvailability(id, options);
}
```
:::
::::

```json
{
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": false,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ],
  "availableForPurchase": false
}
```

**Call [Get Product Options Availability](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog/get-product-options-availability) to retrieve the availability of `S`+`Green`**

Notice in the response that:
- We get the selected variant, with proper values for price, weight, SKU and inventory.
- `availableForPurchase` is true.

::::tabs
:::REST_TAB
```curl
   curl -X POST \
    'https://www.wixapis.com/stores/v1/products/1044e7e4-37d1-0705-c5b3-623baae212fd/productOptionsAvailability' \
    -d '{
          "options": {
            "size": "S",
            "color": "Green"
          }
        }' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: <AUTH>'
   ```
:::
:::SDK_TAB
```js
import { products } from "@wix/stores";

const id = "1044e7e4-37d1-0705-c5b3-623baae212fd"

const options = {
    size = "S"
    color = "Green"
}

async function getProductOptionsAvailability(id, options) {
  const response = await products.getProductOptionsAvailability(id, options);
}
```
:::
::::

```json
{
  "selectedVariant": {
    "price": {
      "currency": "USD",
      "price": 81,
      "discountedPrice": 81,
      "formatted": {
        "price": "$81.00",
        "discountedPrice": "$81.00"
      }
    },
    "weight": 0,
    "sku": "364215376135191",
    "inStock": true,
    "visible": true
  },
  "productOptions": [
    {
      "optionType": "drop_down",
      "name": "Size",
      "choices": [
        {
          "value": "S",
          "description": "S",
          "inStock": true,
          "visible": true
        },
        {
          "value": "M",
          "description": "M",
          "inStock": true,
          "visible": true
        },
        {
          "value": "L",
          "description": "L",
          "inStock": true,
          "visible": true
        }
      ]
    },
    {
      "optionType": "color",
      "name": "Color",
      "choices": [
        {
          "value": "#FF0000",
          "description": "Red",
          "inStock": false,
          "visible": true
        },
        {
          "value": "#00FF00",
          "description": "Green",
          "inStock": true,
          "visible": true
        },
        {
          "value": "#00000FF",
          "description": "Blue",
          "inStock": true,
          "visible": true
        }
      ]
    }
  ],
  "availableForPurchase": true
}
```

# eCommerce Integration

Adding products from your Wix Stores catalog to an eCommerce cart, checkout, or order, must follow the structure of the `catalogReference` object.

Pass the `catalogReference` object as part of the `lineItems` array to [eCommerce](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/introduction) methods such as:
+ [Add To Cart](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/cart/cart/add-to-cart).
+ [Create Checkout](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/checkout/create-checkout) and [Add To Checkout](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/purchase-flow/checkout/checkout/add-to-checkout).
+ [Create Order](fallback::https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/orders/create-order).

The `catalogReference` object includes the following fields:
+ `catalogItemId` - When passing Wix Stores products, this is the `productId`.
+ `appId` - The Wix Stores app ID. When using products from the Stores catalog, this must always be `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`.
+ `options` - This optional field can hold different key:value pairs, depending on [variant management](fallback::https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) and whether the product/variant has custom text fields.

The examples below detail about the 2 main uses of the `catalogReference` object when passing Wix Stores products.

## Managed Variants

When a product's variants are managed (`product.manageVariants: true`), the `catalogReference.options` should hold the variant's `variantId`. In the following example, the variant also has `customTextFields`:

```json
{
  "catalogReference": {
    "catalogItemId": "5376f9ec-b92e-efa9-e4a1-f4f480aa0d3a",
    "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
    "options": {
      "variantId": "00000000-0000-0020-0005-ad9cdc10d3b8",
      "customTextFields": {
        "What would you like written on the custom label?": "Hope you enjoy the coffee! :)"
      }
    }
  }
}
```

## Non-Managed Variants

When a product's variants are not managed (`product.manageVariants: false`), the `options` object should hold the variant's options and choices:

```json
{
  "catalogReference": {
    "catalogItemId": "4d93fb7e-e612-612f-5c27-81b35b503ad7",
    "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
    "options": {
      "options": {
        "Size": "Medium",
        "Color": "Red"
      }
    }
  }
}
```

Remove Products From Collection