createProduct( )

Creates a new product.

You can also add a ribbon, brand, info sections, options, and modifiers in the same request.

Notes:

  • This method doesn't create inventory items. Use Create Product With Inventory to create a product with inventory in a single call, or create inventory items separately using the Inventory Items API.
  • When you create a product with inline options or modifiers (without referencing existing customization IDs), new standalone Customization entities are automatically created. These can be reused across other products.
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productV3ProductRequired

Product to create.

At least 1 variant must be provided, and each variant must have an item in the choices field for every item in options. If options is empty, 1 default variant must be provided with an empty choices list.

optionsCreateProductOptions
Returns
Return Type:Promise<V3Product>
Errors
400Invalid Argument

There are 14 errors with this status code.

404Not Found

There are 5 errors with this status code.

409Already Exists

There are 5 errors with this status code.

428Failed Precondition

There are 14 errors with this status code.

500Internal

There are 4 errors with this status code.

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

Did this help?