# About Products

The Products API allows you to create and manage a store's products. 

With the products API you can:
- [Create](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) and [Bulk Create Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-create-products)
- [Update](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) and [Bulk Update Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products)
- [Delete](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/delete-product) and [Bulk Delete Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-delete-products)
- [Get](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/get-product), [Search](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products), [Query](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/query-products), and [Count Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/count-products)
- [Bulk Update Variants](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter)
- [Bulk Add](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-add-products-to-categories-by-filter) and [Bulk Remove Products From Categories](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-remove-products-from-categories-by-filter)
- And more

## Before you begin
It’s important to note the following points before starting to code:
- The site owner must install the Wix Stores app.

## Sample flows
* [Add and arrange products in category](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category)
* [Prepare store for Christmas Sale](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#prepare-store-for-christmas-sale)
* [Extend product object with app specific fields](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#extend-product-object-with-app-specific-fields)

# Sample Use Cases and Flows

This article shares a possible use case your app could support, as well as sample flows that could support this use case.
This can be a helpful jumping-off point as you plan your app's implementation.

## Add and arrange products in category

Help merchants to manage their products by using categories. For this we will be using the [Categories API](fallback::https://dev.wix.com/docs/rest/business-management/categories/introduction).

1. Call [Create Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/create-category) and pass `"@wix/stores"` to the `treeReference.appNamespace` field.
2. Save `category.id` from the response. 
3. Call [Bulk Add Items To Category](fallback::https://dev.wix.com/docs/rest/business-management/categories/bulk-add-items-to-category) and pass the `items` you want to add to the category. After products added to category you can rearrange them for example to promote some products to be displayed in the beginning. Note that you can arrange only 100 products, more products can be added but you cannot control arrangement of them. Call [Set Arranged Items](fallback::https://dev.wix.com/docs/rest/business-management/categories/set-arranged-items) endpoint. Pass exactly same params as in step 2 but now `items` must be in same order in which you want to see them.
4. Now you can load all products that belongs to given category and keep their arrangement by calling [Search Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products) endpoint of ProductService with next body 

```json
{
  "search": {
    "sort": [
      {
        "selectItemsBy": [
          {
            "directCategoriesInfo.categories.id": "<categoryId>"
          }
        ],
        "fieldName": "directCategoriesInfo.categories.index",
        "order": "ASC"
      }
    ],
    "filter": {
      "directCategoriesInfo.categories": {
        "$matchItems": [
          {
            "id": "<categoryId>"
          }
        ]
      }
    }
  }
}
```
Replace `<categoryId>` with real category id from step 1. Pay attention to `sort.selectItemsBy` parameter where you must pass filter by categoryId, this allows you to sort products by arrangement that you set in CategoriesService on step 3.

## Prepare store for Christmas Sale
Before big sale merchant might want to prepare store by creating a new category for products on sale, adding ribbons to products to catch visitors' attention and of course setting new actual prices and compare at prices. Let's see how to do it step by step.
1. [Add and arrange products in category](fallback::#add-and-arrange-products-in-category). This will allow visitor to filter by this category on storefront category page (if merchant enabled this filter in editor). Also it allows merchant to control which products visitor will see first.
2. Create new ribbon by calling [Create Ribbon](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/ribbons-v3/create-ribbon) endpoint of external RibbonService. Save `ribbon.id` that you received in response.
3. To add ribbon "Sale!" to all products in category call [Bulk Update Products By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products-by-filter) endpoint. In `filter` send filter by category id. In `product` send only `ribbon`. So your request will look like:
```json
{
  "filter": {
    "directCategoriesInfo.categories.id": "<categoryId>"
  },
  "product": {
    "ribbon": {
      "id": "<ribbonId>"
    }
  }
}
```
4. Finally, we need to update the actual prices and compare-at prices. To simplify, consider a single product with one variant where the `actualPrice` is set at $100.
5. First we want to set a new `compareAtPrice`, this price will indicate to your client what is the price of the product before the sale. call [Bulk Update Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter) endpoint with variant with desired `compareAtPrice` and `actualPrice`:
```json
{
  "variant": {
    "price": {
      "compareAtPrice": {
        "amount": "100"
      },
      "actualPrice": {
        "amount": "90"
      }
    }
  }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 90$.

a) If you want to adjust all actual prices by some specific amount or percentage which depends on original `actualPrice` value call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter). For example if you want to decrease current actual prices by 10% pass next body:
```json
{
    "actualPrice": {
        "percentage": -10
    }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 81$.

b) If you want to calculate new `actualPrice` from `compareAtPrice` by applying some discount to it call [Bulk Adjust Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-adjust-product-variants-by-filter) with `actualPriceFromCompareAtPrice`. For example if you want to set `actualPrice` as 20% discount from `compareAtPrice` pass next body:
```json
{
    "actualPriceFromCompareAtPrice": {
        "percentage": 20
    }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 80$.

c) If you want to set exact `actualPrice` same for all variants of all products call [Bulk Update Product Variants By Filter](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-product-variants-by-filter) endpoint with variant with desired `actualPrice`:
```json
{
    "variant": {
        "price": {
            "actualPrice": {
                "amount": "75"
            }
        }
    }
}
```
After this call example product will have `compareAtPrice` 100$ and `actualPrice` 75$.

## Extend product object with app specific fields
The Product object includes predefined fields that cannot be removed or renamed. However, there may be instances where you need to add additional fields to accommodate specific flows or use cases for your application.

For example, consider a real estate app that needs to store information about the total area and the type of unit (such as whether it is an apartment or a house). This can be achieved using the `extendedFields` field of the Product object.

Before proceeding, you may want to review our documentation on data extensions or schema plugins [here](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions#extended-fields).
1. Follow this [guide](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/extend-an-existing-object) to create an extension of type "Stores Catalog Product" in the Dev Center. Be sure to note the namespace of your app, as you will need it for the next steps. For this example, let's assume the namespace is `@my-user-name/real-estate-app`.
2. In the JSON Editor, enter the following value:
```json
{
  "type": "object",
  "properties": {
    "unitType": {
      "type": "string",
      "maxLength": 50,
      "x-wix-permissions": {
        "read": [
          "owning-app",
          "users"
        ],
        "write": [
          "owning-app",
          "users"
        ]
      }
    },
    "areaInSqm": {
      "type": "integer",
      "minimum": 15,
      "x-wix-permissions": {
        "read": [
          "owning-app",
          "users"
        ],
        "write": [
          "owning-app",
          "users"
        ]
      }
    }
  }
}
```
This defines two fields: `areaInSqm`, which includes minimum value validation, and `unitType`, which includes maximum length validation. Both fields can be read and written by your app as well as by users, such as the site owner.
3. Save your extension. Please note that, according to this [guide](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/extend-an-existing-object), you must have your app approved before you can proceed with testing.
4. Once your app is approved, you can click "Test Your App" and select the site where you want to install it. Be sure to grant the app permissions to read and write to the stores catalog.
5. You can now create a product with extended fields by calling the [Create Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/create-product) endpoint or update an existing product by calling the [Update Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-product) endpoint. In your request, include the `extendedFields` object with your namespace and the relevant field values.
```json
{
  "product": {
    "id": "e0f16062-2f78-457b-ab47-78847e206e49",
    "revision": 1,
    "name": "Luxury apartment in the city center",
    "extendedFields": {
      "namespaces": {
        "@my-user-name/real-estate-app": {
          "unitType": "apartment",
          "areaInSqm": 120
        }
      }
    }
  }
}
```
Alternatively, you can update a product's extended fields without passing a revision by using the [Update Extended Fields](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/update-extended-fields) endpoint.
6. When you call the [Get Product](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/get-product) endpoint, the response will include the `extendedFields` object with your namespace.

# Stores Products: Supported Filters and Sorting


The following table shows field support for filters and sorting for the `SearchProducts` endpoint :

| Field                                                    | Supported Filters                                                      | Sortable |
|----------------------------------------------------------|------------------------------------------------------------------------|----------|
| `id`                                                     | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `handle`                                                 | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `slug`                                                   | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `directCategoriesInfo.categories`                        | `$matchItems`                                                          |          |
| `directCategoriesInfo.categories.id`                     | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `allCategoriesInfo.categories`                           | `$matchItems`                                                          |          |
| `allCategoriesInfo.categories.id`                        | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `productType`                                            | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `inventory.availabilityStatus`                           | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `inventory.preorderStatus`                               | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `inventory.preorderAvailability`                         | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `visible`                                                | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `visibleInPos`                                           | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `importId`                                               | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `modifiers.id`                                           | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `modifiers.choicesSettings.choices.choiceId`             | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `modifiers.choicesSettings.choices.name`                 | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `modifiers.name`                                         | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.id`                                             | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.choicesSettings.choices.choiceId`               | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.choicesSettings.choices.name`                   | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `options.name`                                           | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `flattenOptions`                                         | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `flattenModifiers`                                       | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `brand.id`                                               | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `brand.name`                                             | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `ribbon.id`                                              | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `ribbon.name`                                            | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `infoSections.id`                                        | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `infoSections.uniqueName`                                | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `taxGroupId`                                             | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `physicalProperties.fulfillerId`                         | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `physicalProperties.shippingGroupId`                     | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `physicalProperties.deliveryProfileId`                   | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `variantsInfo.variants`                                  | `$matchItems`                                                          |          |
| `variantsInfo.variants.visible`                          | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`                             |          |
| `variantsInfo.variants.price.actualPrice.amount`         | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` |          |
| `variantsInfo.variants.price.compareAtPrice.amount`      | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` |          |
| `variantsInfo.variants.choices.optionChoiceIds.optionId` | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `variantsInfo.variants.choices.optionChoiceIds.choiceId` | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `variantsInfo.variants.sku`                              | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `variantsInfo.variants.barcode`                          | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$startsWith`              |          |
| `variantsInfo.variants.physicalProperties.weight`        | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` |          |
| `subscriptionDetails.allowOneTimePurchases`              | `$eq`, `$ne`, `$exists`, `$in`                                         |          |
| `name`                                                   | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          | Sortable |
| `updatedDate`                                            | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `createdDate`                                            | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `numericId`                                              | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `actualPriceRange.minValue.amount`                       | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `actualPriceRange.maxValue.amount`                       | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `compareAtPriceRange.minValue.amount`                    | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `compareAtPriceRange.maxValue.amount`                    | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `physicalProperties.shippingWeightRange.minValue`        | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `physicalProperties.shippingWeightRange.maxValue`        | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `directCategoriesInfo.categories.index`                  | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |
| `allCategoriesInfo.categories.index`                     | `$eq`, `$ne`, `$exists`, `$in`, `$hasSome`, `$lt`, `$lte`, `$gt`, `$gte` | Sortable |


The following table shows field support for filters and sorting for the `QueryProducts` endpoint :

| Field         | Supported Filters                                                      | Sortable |
|---------------|------------------------------------------------------------------------|----------|
| `id`          | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `handle`      | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          |          |
| `options.id`  | `$isEmpty`, `$hasAll`, `$hasSome`                                      |          |
| `slug`        | `$eq`, `$ne`, `$exists`, `$in`, `$startsWith`                          | Sortable |
| `createdDate` | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `updatedDate` | `$eq`, `$ne`, `$exists`, `$in`, `$lt`, `$lte`, `$gt`, `$gte`             | Sortable |
| `visible`     | `$eq`, `$ne`, `$exists`, `$in`                                         | Sortable |




__Related content:__
[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
[Query Store Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/query-products),
[Search Store Products](fallback::https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/search-products)