Product Object

Product ID.

Revision number, which increments by 1 each time the product is updated. To prevent conflicting changes, the current revision must be passed when updating the product.

Ignored when creating a product.

Date and time the product was created.

Date and time the product was updated.

Product name. Translatable.

Product slug.

If not provided, the slug is autogenerated based on the product name.

URL to the site's product page.

Product description in HTML.

• When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
• plainDescription is ignored when value is also passed to the description field.

Whether the product is visible to site visitors on the site.

Default: true

Whether the product is visible in POS (point of sale).

Default: true

Product media items.

Product SEO data.

Tax group ID.

Product options. Allows the customer to customize the product. For example, selecting color, size, and more.

Always generates variants: every variant must have exactly one choice related to each option. Since options and variants tightly coupled and rely on each other they usually should be provided together in all operations.

Product modifiers.

Allows the customer to customize product, e.g. select Color, Size and so on similarly to options but with one main difference - modifiers never generate any variants.

Product brand.

• Pass brand.name to add a new brand while creating a product.
• Pass an existing brand's id to assign that brand to the product.

Product info section.

• Pass infoSection.uniqueName, infoSection.title, and infoSection.description to add a new info section while creating a product.
• Pass an existing info section's id or uniqueName to assign that info section to the product.

Product ribbon.

• Pass ribbon.name to add a new ribbon while creating a product.
• Pass an existing ribbon's id or name to assign that ribbon to the product.

List of categories that directly contain this product.

Updated automatically when a product is added/removed from a category, when an item is moved within a category, or when a category is deleted.

List of categories that directly contain this product, as well as their parent categories.

Main category ID.

Product base price range - minimum and maximum prices of all product variants.

Product sale price range - minimum and maximum sale prices of all product variants.

Product cost range - minimum and maximum costs of all product variants.

Product inventory info.

Product type.

When passing productType: PHYSICAL, you must also pass physicalProperties.

A unique human-friendly identifier for the product. Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms. In case handle wasn't given, the handle will be automatically generated.

Currency used for the pricing of this product, in ISO-4217 format.

Defaults to the currency defined in the site settings, unless specified in x-wix-currency header.

Breadcrumbs of the mainCategoryId. Used to navigate to parent categories.

Product variants.

Custom extended fields for the product object.

Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls.

Product subscriptions.

The total number of variants for the product.

Physical properties.

Required when productType: PHYSICAL.