createProductWithInventory( )

Creates a new product with its inventory in a single call.

Pass variantsInfo.variants.inventoryItem to create inventory items for each variant in the default location. If inventoryItem is not provided, no inventory items are created.

This endpoint also allows to add a ribbon, brand, info sections, options, and modifiers.

Note: When you create a product with inline options or modifiers (without referencing existing customization IDs), new standalone Customization entities are automatically created. These can then be reused across other products.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productProductWithInventoryRequired

Product to create with inventory.

At least one variant must be provided and each variant must have relevant item in choices field for every item in options. If options is empty one default variant must be provided with empty choices list.

optionsCreateProductWithInventoryOptions
Returns
Return Type:Promise<CreateProductWithInventoryResponse>
Errors
400Invalid Argument

There are 8 errors with this status code.

404Not Found

There are 3 errors with this status code.

428Failed Precondition

There is 1 error with this status code.

500Internal

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?