> 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`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # BulkIncrementInventoryItemsByVariantAndLocation # Package: catalogV3 # Namespace: InventoryService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/bulk-increment-inventory-items-by-variant-and-location.md ## Permission Scopes: Inventory write in v3 catalog: SCOPE.STORES.INVENTORY_ITEM_WRITE ## Introduction Increments quantities of multiple inventory items by variant and location. > **Note:** `trackQuantity` must be `true` to allow for incrementing the quantity. --- ## REST API ### Schema ``` Method: bulkIncrementInventoryItemsByVariantAndLocation Description: Increments quantities of multiple inventory items by variant and location. > **Note:** `trackQuantity` must be `true` to allow for incrementing the quantity. URL: https://www.wixapis.com/stores/v3/bulk/inventory-items/increment-by-variant-and-location Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: incrementData, incrementData.variantId, incrementData.incrementBy Method parameters: param name: incrementData | type: array | description: Variant and location GUIDs, as well as increment data. | required: true - name: variantId | type: string | description: Variant GUID. | required: true - name: locationId | type: string | description: Location GUID. - name: incrementBy | type: integer | description: Amount to increment by. | required: true param name: reason | type: ReasonType | description: The reason for the inventory change. - enum: ORDER - MANUAL - REVERT_INVENTORY_CHANGE - param name: returnEntity | type: returnEntity | description: Whether to return the full inventory item entities in the response. Default: `false` Return type: BulkIncrementInventoryItemsByVariantAndLocationResponse - name: results | type: array | description: Inventory items updated by bulk action. - 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). - 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. - name: id | type: string | description: Inventory item 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. - name: createdDate | type: string | description: Date and time the inventory item was created. - name: updatedDate | type: string | description: Date and time the inventory item was last updated. - name: variantId | type: string | description: Variant GUID. - name: locationId | type: string | description: Stores location GUID. If not specified when creating an inventory item, the store's default location is used. - name: productId | type: string | description: Product GUID. - name: trackQuantity | type: boolean | description: Whether the quantity is being tracked. - name: availabilityStatus | type: AvailabilityStatus | description: Inventory item availability status. - 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. - 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` - name: counter | type: integer | description: Number of times this item has been preordered. Supported only for inventory items with `trackQuantity = true`. - name: quantity | type: integer | description: Remaining quantity available for preorder. Supported only for items with `trackQuantity` set to `true`. - name: product | type: Product | description: Associated product and variant details. - name: name | type: string | description: Product name. - name: directCategoryIds | type: array | description: List of category GUIDs that this product is included in directly. - name: variantName | type: string | description: Variant name. - name: variantSku | type: string | description: Variant SKU (stock keeping unit). - 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). - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata details as: totalSuccess and totalFailure. - 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: NOT_FOUND | Description: Inventory item with the specified `variant_id` and `location_id` not found. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MAX_QUANTITY_LIMIT_REACHED | Description: Increment would exceed the maximum quantity limit. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INVENTORY_QUANTITY_NOT_TRACKED | Description: Increment attempted for untracked inventory. Enable inventory tracking first. ``` ### Examples ### Increment quantity of multiple inventory items by variant ID and location ID Increment quantity of multiple inventory items. The 1st item is requested with both variant ID and location ID of a tracked inventory item and succeeds. The 2nd is requested with variant ID and empty location ID, so the variant in the default location is updated and succeeds. The 3rd is requested with variant ID and location ID of an untracked inventory item and fails. ```curl curl -X POST \ 'https://www.wixapis.com/stores/v3/bulk/inventory-items/increment-by-variant-and-location' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "incrementData": [ { "variantId": "b692b19a-0fb8-41b3-bcea-f742f42e8c95", "locationId": "6aa58daa-de56-4dd9-95c2-07943e346348", "incrementBy": 10 }, { "variantId": "a4eb080d-7aac-4b59-8d4e-ff7500a05cd1", "incrementBy": 5 }, { "variantId": "d889c456-4f6c-4dee-9658-0b3546b8cef2", "locationId": "6aa58daa-de56-4dd9-95c2-07943e346348", "incrementBy": 11 } ], "returnEntity": true }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.InventoryService.bulkIncrementInventoryItemsByVariantAndLocation(incrementData, options) Description: Increments quantities of multiple inventory items by variant and location. > **Note:** `trackQuantity` must be `true` to allow for incrementing the quantity. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: incrementData, incrementData.variantId, incrementData.incrementBy Method parameters: param name: incrementData | type: array | description: Variant and location GUIDs, as well as increment data. | required: true - name: variantId | type: string | description: Variant GUID. | required: true - name: locationId | type: string | description: Location GUID. - name: incrementBy | type: integer | description: Amount to increment by. | required: true param name: options | type: BulkIncrementInventoryItemsByVariantAndLocationOptions none - 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 increment inventory action. - enum: ORDER, MANUAL, REVERT_INVENTORY_CHANGE Return type: PROMISE - name: results | type: array | description: Inventory items updated by bulk action. - 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). - 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. - name: _id | type: string | description: Inventory item 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. - name: _createdDate | type: Date | description: Date and time the inventory item was created. - name: _updatedDate | type: Date | description: Date and time the inventory item was last updated. - name: variantId | type: string | description: Variant GUID. - name: locationId | type: string | description: Stores location GUID. If not specified when creating an inventory item, the store's default location is used. - name: productId | type: string | description: Product GUID. - name: trackQuantity | type: boolean | description: Whether the quantity is being tracked. - name: availabilityStatus | type: AvailabilityStatus | description: Inventory item availability status. - 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. - 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` - name: counter | type: integer | description: Number of times this item has been preordered. Supported only for inventory items with `trackQuantity = true`. - name: quantity | type: integer | description: Remaining quantity available for preorder. Supported only for items with `trackQuantity` set to `true`. - name: product | type: Product | description: Associated product and variant details. - name: name | type: string | description: Product name. - name: directCategoryIds | type: array | description: List of category GUIDs that this product is included in directly. - name: variantName | type: string | description: Variant name. - name: variantSku | type: string | description: Variant SKU (stock keeping unit). - 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). - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata details as: totalSuccess and totalFailure. - 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: NOT_FOUND | Description: Inventory item with the specified `variant_id` and `location_id` not found. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MAX_QUANTITY_LIMIT_REACHED | Description: Increment would exceed the maximum quantity limit. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: INVENTORY_QUANTITY_NOT_TRACKED | Description: Increment attempted for untracked inventory. Enable inventory tracking first. ``` ### Examples ### bulkIncrementInventoryItemsByVariantAndLocation ```javascript import { inventoryItemsV3 } from '@wix/stores'; async function bulkIncrementInventoryItemsByVariantAndLocation(incrementData,options) { const response = await inventoryItemsV3.bulkIncrementInventoryItemsByVariantAndLocation(incrementData,options); }; ``` ### bulkIncrementInventoryItemsByVariantAndLocation (with elevated permissions) ```javascript import { inventoryItemsV3 } from '@wix/stores'; import { auth } from '@wix/essentials'; async function myBulkIncrementInventoryItemsByVariantAndLocationMethod(incrementData,options) { const elevatedBulkIncrementInventoryItemsByVariantAndLocation = auth.elevate(inventoryItemsV3.bulkIncrementInventoryItemsByVariantAndLocation); const response = await elevatedBulkIncrementInventoryItemsByVariantAndLocation(incrementData,options); } ``` ### bulkIncrementInventoryItemsByVariantAndLocation (self-hosted) Self-hosted 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 bulkIncrementInventoryItemsByVariantAndLocation(incrementData,options) { const response = await myWixClient.inventoryItemsV3.bulkIncrementInventoryItemsByVariantAndLocation(incrementData,options); }; ``` ---