> 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 # CreateInventoryItem # Package: catalogV3 # Namespace: InventoryService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/inventory-items-v3/create-inventory-item.md ## Permission Scopes: Inventory write in v3 catalog: SCOPE.STORES.INVENTORY_ITEM_WRITE ## Introduction Creates an inventory item. The combination of `variantId` and `locationId` must be unique. --- ## REST API ### Schema ``` Method: createInventoryItem Description: Creates an inventory item. The combination of `variantId` and `locationId` must be unique. URL: https://www.wixapis.com/stores/v3/inventory-items Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: inventoryItem, inventoryItem.variantId, inventoryItem.productId Method parameters: param name: inventoryItem | type: InventoryItem | description: Inventory Item. Each inventory item represents a specific product variant at a specific location. The combination of `variantId` and `locationId` is unique — you can't have two inventory items for the same variant at the same location. | required: true - ONE-OF: - required: true - 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: variantId | type: string | description: Variant GUID. | required: true - 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. | required: true - 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: 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). Return type: CreateInventoryItemResponse - name: inventoryItem | type: InventoryItem | description: Created inventory item. - 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). Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: DUPLICATE_BULK_UPSERT_KEY | Description: The request contains duplicate upsert keys. Each `productId`, `variantId`, and `locationId` combination must be unique after default location resolution. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: PREORDER_LIMIT_NOT_SUPPORTED_FOR_UNTRACKED_INVENTORY | Description: Preorder limit set for untracked inventory. Preorder limits are only supported for tracked inventory. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE | Description: Tracked inventory creation attempted with negative `quantity`. Quantity must be non-negative. HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: ITEM_ALREADY_EXISTS | Description: There is already an inventory item with this `variant_id` and `location_id`. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: PRE_ORDER_VALIDATION | Description: Preorder enabled for a digital product or subscription product. Preorder isn't supported for these product types. ``` ### Examples ### Create inventory item in default location Creates a new Inventory item associated with product and variant in default location. ```curl curl -X POST \ 'https://www.wixapis.com/stores/v3/inventory-items' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "inventoryItem": { "variantId": "ac00ed6f-1077-4672-b8ec-ace4ec283ff4", "productId": "56ba4206-dd72-4c20-ab57-79392fc1cf33", "inStock": true } }' ``` ### Create tracked inventory item with preorder info Creates a new tracked inventory item with preorder info for a variant of a product in a specific location. ```curl curl -X POST \ 'https://www.wixapis.com/stores/v3/inventory-items' \ -H 'Content-type: application/json' \ -H 'Authorization: ' \ -d '{ "inventoryItem": { "variantId": "9b88bcde-7119-483f-b969-909e45c54df3", "locationId": "d85fbb4d-e415-49b1-98bc-9d22ec338cb1", "productId": "a6a7de6c-2ff0-4d42-b738-b04bea042fb5", "quantity": 500, "preorderInfo": { "enabled": true, "message": "This product is available for preorder", "limit": 50 } } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.catalogV3.InventoryService.createInventoryItem(inventoryItem) Description: Creates an inventory item. The combination of `variantId` and `locationId` must be unique. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: inventoryItem, inventoryItem.variantId, inventoryItem.productId Method parameters: param name: inventoryItem | type: InventoryItem | description: Inventory Item. Each inventory item represents a specific product variant at a specific location. The combination of `variantId` and `locationId` is unique — you can't have two inventory items for the same variant at the same location. | required: true - ONE-OF: - required: true - 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: variantId | type: string | description: Variant GUID. | required: true - 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. | required: true - 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: 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). Return type: PROMISE - 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). Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: DUPLICATE_BULK_UPSERT_KEY | Description: The request contains duplicate upsert keys. Each `productId`, `variantId`, and `locationId` combination must be unique after default location resolution. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: PREORDER_LIMIT_NOT_SUPPORTED_FOR_UNTRACKED_INVENTORY | Description: Preorder limit set for untracked inventory. Preorder limits are only supported for tracked inventory. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE | Description: Tracked inventory creation attempted with negative `quantity`. Quantity must be non-negative. HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: ITEM_ALREADY_EXISTS | Description: There is already an inventory item with this `variant_id` and `location_id`. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: PRE_ORDER_VALIDATION | Description: Preorder enabled for a digital product or subscription product. Preorder isn't supported for these product types. ``` ### Examples ### Create an inventory item with preorder info ```javascript import { inventoryItemsV3 } from "@wix/stores"; const inventoryItem = { variantId: "9b88bcde-7119-483f-b969-909e45c54df3", locationId: "d85fbb4d-e415-49b1-98bc-9d22ec338cb1", productId: "a6a7de6c-2ff0-4d42-b738-b04bea042fb5", quantity: 500, preorderInfo: { enabled: true, message: "This product is available for preorder", limit: 50 } }; async function createInventoryItem() { const response = await inventoryItemsV3.createInventoryItem(inventoryItem); } ``` ### Create an inventory item ```javascript import { inventoryItemsV3 } from "@wix/stores"; const inventoryItem = { variantId: "ac00ed6f-1077-4672-b8ec-ace4ec283ff4", productId: "56ba4206-dd72-4c20-ab57-79392fc1cf33", inStock: true }; async function createInventoryItem() { const response = await inventoryItemsV3.createInventoryItem(inventoryItem); } ``` ### createInventoryItem (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 createInventoryItem(inventoryItem) { const response = await myWixClient.inventoryItemsV3.createInventoryItem(inventoryItem); }; ``` ---