Short description of ProductService
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.
Note: Returned only when you pass "URL" to the fields array in Products API requests.
Product description using rich content.
Note: Returned only when you pass "DESCRIPTION" to the fields array in Products API requests.
Product description in HTML.
plainDescription is ignored when value is also passed to the description field.Note: Returned only when you pass "PLAIN_DESCRIPTION" to the fields array in Products API requests.
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
Note: Always false for productType: DIGITAL.
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.
brand.name to add a new brand while creating a product.id to assign that brand to the product.Product info section.
infoSection.uniqueName, infoSection.title, and infoSection.description to add a new info section while creating a product.id or uniqueName to assign that info section to the product.Product ribbon.
ribbon.name to add a new ribbon while creating a product.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.
Note: Returned only when you pass "DIRECT_CATEGORIES_INFO" to the fields array in Products API requests.
List of categories that directly contain this product, as well as their parent categories.
Note: Returned only when you pass "ALL_CATEGORIES_INFO" to the fields array in Products API requests.
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.
Note: Returned only when the following conditions are met:
"MERCHANT_DATA" to the fields array in Products API requests.SCOPE.STORES.PRODUCT_READ_ADMIN permission scope.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.
Note: Returned only when you pass "CURRENCY" to the fields array in Products API requests.
Breadcrumbs of the mainCategoryId. Used to navigate to parent categories.
Note: Returned only when you pass "BREADCRUMBS_INFO" to the fields array in Products API requests.
Product actual price range - minimum and maximum prices of all product variants.
Product compare at price range - minimum and maximum compare at price prices of all product variants.
Product variants.
Custom extended fields for the product object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Product subscriptions.
The total number of variants for the product.
Physical properties.
Required when productType: PHYSICAL.