> To build or manage a Wix site with an AI agent, follow https://www.wix.com/headless/skill.md
> It builds a new Wix site or puts your own site online, from a prompt, and keeps changing it afterwards. The pages are code in any web technology, and Wix runs the backend.
> It works through the Wix plugin (the Wix MCP and the Wix skills), the Wix CLI or no Wix login, and puts the site live on Wix hosting or on another host.
> Business features include a store, bookings, events and tickets, a restaurant, a blog, forms, members and many more.
> Read the Wix skills online at https://www.wix.com/skills
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# BulkDecrementInventoryItems

# Package: catalogV3

# Namespace: InventoryService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/bulk-decrement-inventory-items?apiView=SDK.md

## Permission Scopes:
Inventory write in v3 catalog: SCOPE.STORES.INVENTORY_ITEM_WRITE

## Introduction

Decrements quantities of multiple inventory items.

> **Notes:**:
> + `trackQuantity` must be `true` to allow for decrementing the quantity.
> + If you pass `restrictInventory: true` and the `decrementData.decrementBy` amount is greater than the current quantity in stock, the request will fail with an `INSUFFICIENT_INVENTORY` error.
> + Pass `restrictInventory: false` to allow for negative quantities.
> + If you pass `preorderRequest: true` and the item is available for preorder, the item's `preorderCounter` will increase and the item's quantity will stay the same.

---

## REST API

### Schema

```
 Method: bulkDecrementInventoryItems
 Description: Decrements quantities of multiple inventory items.  > **Notes:**: > + `trackQuantity` must be `true` to allow for decrementing the quantity. > + If you pass `restrictInventory: true` and the `decrementData.decrementBy` amount is greater than the current quantity in stock, the request will fail with an `INSUFFICIENT_INVENTORY` error. > + Pass `restrictInventory: false` to allow for negative quantities. > + If you pass `preorderRequest: true` and the item is available for preorder, the item's `preorderCounter` will increase and the item's quantity will stay the same.
 URL: https://www.wixapis.com/stores/v3/bulk/inventory-items/decrement
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  decrementData, decrementData.inventoryItemId, decrementData.decrementBy
 Method parameters: 
   param name: decrementData | type: array<decrementData> | description: Inventory item GUIDs and decrement data. | required: true | validation: minItems 1, maxItems 300
              - name: inventoryItemId | type: string | description: Inventory item GUID. | required: true | validation: format GUID
              - name: decrementBy | type: integer | description: Amount to decrement by. | required: true | validation: minimum 1, maximum 99999
              - name: preorderRequest | type: boolean | description: Whether the request to decrement the inventory item's quantity was made as part of a purchase that includes preorder items.  + If `true` and the item is available for preorder in the default location, negative inventory quantity is allowed. + If `false` and the item is not available for preorder, negative inventory is not allowed.  
   param name: reason | type: ReasonType | description: The reason for the inventory change.  
      - enum:
           ORDER - An order changed the quantity.
           MANUAL - A manual adjustment changed the quantity.
           REVERT_INVENTORY_CHANGE - Reverting a previous inventory change changed the quantity.
   param name: restrictInventory | type: restrictInventory | description: Whether inventory is restricted from going below zero.  Default: `true` - inventory does not go below zero.  
   param name: returnEntity | type: returnEntity | description: Whether to return the full inventory item entities in the response.  Default: `false`  
 Return type: BulkDecrementInventoryItemsResponse
  - name: results | type: array<BulkInventoryItemResult> | description: Inventory items updated by bulk action.  | validation: minItems 1, maxItems 300
     - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for inventory item.  
        - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item).  | validation: format GUID
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items.  
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated.  
        - name: error | type: ApplicationError | description: Details about the error in case of failure.  
           - name: code | type: string | description: Error code.  
           - name: description | type: string | description: Description of the error.  
           - name: data | type: object | description: Data related to the error.  
     - name: item | type: InventoryItem | description: Full inventory item entity.  Returned only if `returnEntity: true` is passed in the request.  
        - ONE-OF: 
           - name: inStock | type: boolean | description: Indicates that inventory is tracked by status rather than quantity.  When set to `true`, the item is marked as available for sale without tracking exact quantities. When set to `false`, the item is marked as out of stock. This tracking method is useful for made-to-order products or items with unlimited inventory.  When using this tracking method, `trackQuantity` is `false` and preorder limits aren't supported.  
           - name: quantity | type: integer | description: Indicates that inventory is tracked by quantity.  Set this field to the number of items currently in stock. This tracking method is useful when you need to know exactly how many items are available.  When using this tracking method, `trackQuantity` is `true`. Quantity can be negative when inventory is decremented for an order that has already been paid.  | validation: minimum -99999, maximum 99999
        - name: id | type: string | description: Inventory item GUID.  | read-only: true | validation: format GUID
        - name: revision | type: string | description: Revision number, which increments by 1 each time the inventory item is updated. To prevent conflicting changes, the current revision must be passed when updating the inventory item.  Ignored when creating an inventory item.  | read-only: true | validation: format int64
        - name: createdDate | type: string | description: Date and time the inventory item was created.  | read-only: true | validation: format date-time
        - name: updatedDate | type: string | description: Date and time the inventory item was last updated.  | read-only: true | validation: format date-time
        - name: variantId | type: string | description: Variant GUID.  | validation: format GUID, immutable
        - name: locationId | type: string | description: Stores location GUID. If not specified when creating an inventory item, the store's default location is used.  | validation: format GUID, immutable
        - name: productId | type: string | description: Product GUID.  | validation: minLength 1, maxLength 36, immutable
        - name: trackQuantity | type: boolean | description: Whether the quantity is being tracked.  | read-only: true 
        - name: availabilityStatus | type: AvailabilityStatus | description: Inventory item availability status.  | read-only: true 
             - enum:
             -     OUT_OF_STOCK: Item is out of stock. For tracked inventory, `quantity` is zero or negative and preorder isn't available.
             -     IN_STOCK: Item is in stock and available for purchase. For tracked inventory, see the `quantity` field for the exact amount in stock.
             -     PREORDER: Item is available for preorder only. Stock is zero or negative, but preorder is enabled with remaining capacity.
        - name: preorderInfo | type: PreorderInfo | description: Item preorder info.  Preorder settings are configured per inventory item, so each variant-location combination can have its own preorder configuration.  > **Note:** The product entity's `inventory.preorderStatus` and `inventory.preorderAvailability` fields reflect only the default location's preorder state.  
           - name: enabled | type: boolean | description: Whether preorder is enabled for this inventory item.  > **Note:** Preorder can't be enabled for digital products or products with subscriptions.  Default: `false`  
           - name: message | type: string | description: Message displayed to customers when the item is out of stock and preorder is enabled.  | validation: minLength 1, maxLength 250
           - name: limit | type: integer | description: Maximum number of items that can be preordered after stock reaches zero.  Supported only for inventory items with `trackQuantity = true`.  Default: `100000`  | validation: minimum 0, maximum 100000, format int32
           - name: counter | type: integer | description: Number of times this item has been preordered.  Supported only for inventory items with `trackQuantity = true`.  | read-only: true | validation: minimum 0, maximum 99999, format int32
           - name: quantity | type: integer | description: Remaining quantity available for preorder.  Supported only for items with `trackQuantity` set to `true`.  | read-only: true | validation: format int32
        - name: product | type: Product | description: Associated product and variant details.  | read-only: true 
           - name: name | type: string | description: Product name.  | validation: maxLength 80
           - name: directCategoryIds | type: array<string> | description: List of category GUIDs that this product is included in directly.  | validation: maxItems 2000, format GUID
           - name: variantName | type: string | description: Variant name.  | validation: minLength 1, maxLength 250
           - name: variantSku | type: string | description: Variant SKU (stock keeping unit).  | validation: minLength 1, maxLength 40
           - name: variantVisible | type: boolean | description: Whether the variant is visible in the store.  
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the inventory item object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls.  
           - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).  | validation: format map
  - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata.  
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed.  
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed.  
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded.  

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MIN_QUANTITY_LIMIT_REACHED | Description: Decrement would reduce inventory below minimum quantity limit or `preorderInfo.counter` would exceed its maximum value.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INSUFFICIENT_INVENTORY | Description: Decrement would result in negative `quantity` or exceed preorder limit. Set `restrict_inventory` to `false` to allow negative quantities.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INVENTORY_QUANTITY_NOT_TRACKED | Description: Decrement attempted for untracked inventory. Enable inventory tracking first.


```

### Examples

### Bulk decrement inventory items by ids example - minimum required fields
Bulk decrement Inventory items associated with product, variant, and location. to product, variant and location.

```curl
curl -X POST \
'https://www.wixapis.com/stores/v3/bulk/inventory-items/decrement' \
  -H 'Content-type: application/json' \
  -H 'Authorization:  <AUTH>' \
  -d '{
      "decrementData": [
        {
          "inventoryItemId": "9c346207-6467-434f-aa9e-8999c32d119d",
          "decrementBy": 1
        }
      ],
      "returnEntity": true,
      "reason": "MANUAL"
    }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.stores.inventoryItemsV3.bulkDecrementInventoryItems(decrementData, options)
 Description: Decrements quantities of multiple inventory items.  > **Notes:**: > + `trackQuantity` must be `true` to allow for decrementing the quantity. > + If you pass `restrictInventory: true` and the `decrementData.decrementBy` amount is greater than the current quantity in stock, the request will fail with an `INSUFFICIENT_INVENTORY` error. > + Pass `restrictInventory: false` to allow for negative quantities. > + If you pass `preorderRequest: true` and the item is available for preorder, the item's `preorderCounter` will increase and the item's quantity will stay the same.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  decrementData, decrementData.inventoryItemId, decrementData.decrementBy
 Method parameters: 
   param name: decrementData | type: array<DecrementDataById> | description: Inventory item GUIDs and decrement data. | required: true | validation: minItems 1, maxItems 300
              - name: inventoryItemId | type: string | description: Inventory item GUID. | required: true | validation: format GUID
              - name: decrementBy | type: integer | description: Amount to decrement by. | required: true | validation: minimum 1, maximum 99999
              - name: preorderRequest | type: boolean | description: Whether the request to decrement the inventory item's quantity was made as part of a purchase that includes preorder items.  + If `true` and the item is available for preorder in the default location, negative inventory quantity is allowed. + If `false` and the item is not available for preorder, negative inventory is not allowed.  
   param name: options | type: BulkDecrementInventoryItemsOptions  none  
        - name: restrictInventory | type: boolean | description: Whether inventory is restricted from going below zero.  Default: `true` - inventory does not go below zero.  
        - name: returnEntity | type: boolean | description: Whether to return the full inventory item entities in the response.  Default: `false`  
        - name: reason | type: ReasonType | description: Reason for decrement inventory action.  
             - enum:
             -     ORDER: An order changed the quantity.
             -     MANUAL: A manual adjustment changed the quantity.
             -     REVERT_INVENTORY_CHANGE: Reverting a previous inventory change changed the quantity.
 Return type: PROMISE<BulkDecrementInventoryItemsResponse>
  - name: results | type: array<BulkInventoryItemResult> | description: Inventory items updated by bulk action.  | validation: minItems 1, maxItems 300
     - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for inventory item.  
        - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item).  | validation: format GUID
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items.  
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated.  
        - name: error | type: ApplicationError | description: Details about the error in case of failure.  
           - name: code | type: string | description: Error code.  
           - name: description | type: string | description: Description of the error.  
           - name: data | type: object | description: Data related to the error.  
     - name: item | type: InventoryItem | description: Full inventory item entity.  Returned only if `returnEntity: true` is passed in the request.  
        - ONE-OF: 
           - name: inStock | type: boolean | description: Indicates that inventory is tracked by status rather than quantity.  When set to `true`, the item is marked as available for sale without tracking exact quantities. When set to `false`, the item is marked as out of stock. This tracking method is useful for made-to-order products or items with unlimited inventory.  When using this tracking method, `trackQuantity` is `false` and preorder limits aren't supported.  
           - name: quantity | type: integer | description: Indicates that inventory is tracked by quantity.  Set this field to the number of items currently in stock. This tracking method is useful when you need to know exactly how many items are available.  When using this tracking method, `trackQuantity` is `true`. Quantity can be negative when inventory is decremented for an order that has already been paid.  | validation: minimum -99999, maximum 99999
        - name: _id | type: string | description: Inventory item GUID.  | read-only: true | validation: format GUID
        - name: revision | type: string | description: Revision number, which increments by 1 each time the inventory item is updated. To prevent conflicting changes, the current revision must be passed when updating the inventory item.  Ignored when creating an inventory item.  | read-only: true | validation: format int64
        - name: _createdDate | type: Date | description: Date and time the inventory item was created.  | read-only: true 
        - name: _updatedDate | type: Date | description: Date and time the inventory item was last updated.  | read-only: true 
        - name: variantId | type: string | description: Variant GUID.  | validation: format GUID, immutable
        - name: locationId | type: string | description: Stores location GUID. If not specified when creating an inventory item, the store's default location is used.  | validation: format GUID, immutable
        - name: productId | type: string | description: Product GUID.  | validation: minLength 1, maxLength 36, immutable
        - name: trackQuantity | type: boolean | description: Whether the quantity is being tracked.  | read-only: true 
        - name: availabilityStatus | type: AvailabilityStatus | description: Inventory item availability status.  | read-only: true 
             - enum:
             -     OUT_OF_STOCK: Item is out of stock. For tracked inventory, `quantity` is zero or negative and preorder isn't available.
             -     IN_STOCK: Item is in stock and available for purchase. For tracked inventory, see the `quantity` field for the exact amount in stock.
             -     PREORDER: Item is available for preorder only. Stock is zero or negative, but preorder is enabled with remaining capacity.
        - name: preorderInfo | type: PreorderInfo | description: Item preorder info.  Preorder settings are configured per inventory item, so each variant-location combination can have its own preorder configuration.  > **Note:** The product entity's `inventory.preorderStatus` and `inventory.preorderAvailability` fields reflect only the default location's preorder state.  
           - name: enabled | type: boolean | description: Whether preorder is enabled for this inventory item.  > **Note:** Preorder can't be enabled for digital products or products with subscriptions.  Default: `false`  
           - name: message | type: string | description: Message displayed to customers when the item is out of stock and preorder is enabled.  | validation: minLength 1, maxLength 250
           - name: limit | type: integer | description: Maximum number of items that can be preordered after stock reaches zero.  Supported only for inventory items with `trackQuantity = true`.  Default: `100000`  | validation: minimum 0, maximum 100000, format int32
           - name: counter | type: integer | description: Number of times this item has been preordered.  Supported only for inventory items with `trackQuantity = true`.  | read-only: true | validation: minimum 0, maximum 99999, format int32
           - name: quantity | type: integer | description: Remaining quantity available for preorder.  Supported only for items with `trackQuantity` set to `true`.  | read-only: true | validation: format int32
        - name: product | type: Product | description: Associated product and variant details.  | read-only: true 
           - name: name | type: string | description: Product name.  | validation: maxLength 80
           - name: directCategoryIds | type: array<string> | description: List of category GUIDs that this product is included in directly.  | validation: maxItems 2000, format GUID
           - name: variantName | type: string | description: Variant name.  | validation: minLength 1, maxLength 250
           - name: variantSku | type: string | description: Variant SKU (stock keeping unit).  | validation: minLength 1, maxLength 40
           - name: variantVisible | type: boolean | description: Whether the variant is visible in the store.  
        - name: extendedFields | type: ExtendedFields | description: Custom field data for the inventory item object.  [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls.  
           - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md).  | validation: format map
  - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata.  
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed.  
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed.  
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded.  

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MIN_QUANTITY_LIMIT_REACHED | Description: Decrement would reduce inventory below minimum quantity limit or `preorderInfo.counter` would exceed its maximum value.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INSUFFICIENT_INVENTORY | Description: Decrement would result in negative `quantity` or exceed preorder limit. Set `restrict_inventory` to `false` to allow negative quantities.
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INVENTORY_QUANTITY_NOT_TRACKED | Description: Decrement attempted for untracked inventory. Enable inventory tracking first.


```

### Examples

### Bulk decrement inventory items
Decrease inventory quantity for items by ID

```javascript
import { inventoryItemsV3 } from "@wix/stores";

const decrementData = [
  {
    inventoryItemId: "9c346207-6467-434f-aa9e-8999c32d119d",
    decrementBy: 1
  }
];

const options = {
  returnEntity: true,
  reason: inventoryItemsV3.ReasonType.MANUAL
};

async function bulkDecrementInventoryItems() {
  const response = await inventoryItemsV3.bulkDecrementInventoryItems(decrementData, options);
}

/* Promise resolves to:
 * {
 *   "results": [
 *     {
 *       "itemMetadata": {
 *         "id": "9c346207-6467-434f-aa9e-8999c32d119d",
 *         "originalIndex": 0,
 *         "success": true
 *       },
 *       "item": {
 *         "_id": "9c346207-6467-434f-aa9e-8999c32d119d",
 *         "variantId": "590cef15-c81d-4ed7-970c-1ff879946306",
 *         "productId": "babd2bcc-ea03-4b63-8053-0ec59c73fc36",
 *         "quantity": 2,
 *         "trackQuantity": true,
 *         "availabilityStatus": "IN_STOCK"
 *       }
 *     }
 *   ],
 *   "bulkActionMetadata": {
 *     "totalSuccesses": 1,
 *     "totalFailures": 0
 *   }
 * }
 */


```

### bulkDecrementInventoryItems (self-managed)
Self-managed SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { inventoryItemsV3 } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { inventoryItemsV3 },
  // Include the auth strategy and host as relevant
});


async function bulkDecrementInventoryItems(decrementData,options) {
  const response = await myWixClient.inventoryItemsV3.bulkDecrementInventoryItems(decrementData,options);
};
```

---