Product Object


Read and write products from Wix Stores Catalog

Properties
additionalInfoSectionsArray <AdditionalInfoSection>

Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.).


brandstringminLength 1maxLength 50

Product brand. Including a brand name can help improve site and product visibility on search engines.


collectionIdsArray <string>Read-only

A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).


convertedPriceDataConvertedPriceDataRead-only

Price data, converted to the currency specified in request header.


costAndProfitDataCostAndProfitData

Cost and profit data.


costRangeCostRangeRead-only

Product cost range. The minimum and maximum costs of all the variants.


createdDatestringRead-onlyformat date-time

Date and time the product was created.


customTextFieldsArray <CustomTextField>Read-only

Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.


descriptionstringmaxLength 8000

Product description. Accepts rich text.


discountDiscount

Discount deducted from the product's original price.


idstringRead-only

Product ID (generated automatically by the catalog).


inventoryItemIdstringRead-only

Inventory item ID - ID referencing the inventory system.


lastUpdatedstringRead-onlyformat date-time

Date and time the product was last updated.


manageVariantsboolean

Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data.


mediaMediaRead-only

Media items (images, videos etc) associated with this product (writable via Add Product Media endpoint).


namestringminLength 1maxLength 80

Product name.

Min: 1 character Max: 80 characters


numericIdnumberRead-only

Product’s unique numeric ID (assigned in ascending order). Primarily used for sorting and filtering when crawling all products.


pricePriceRead-onlydeprecated

Deprecated (use priceData instead).


priceDataPriceData

Price data.


pricePerUnitDataPricePerUnitData

Price per unit data.


priceRangePriceRangeRead-only

Product price range. The minimum and maximum prices of all the variants.


productOptionsArray <ProductOption>maxItems 6

Options for this product.


productPageUrlProductPageUrlRead-only

Product page URL for this product (generated automatically by the server).


productTypestring

Currently, only creating physical products ( "productType": "physical" ) is supported via the API.


ribbonstringmaxLength 30

Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out".


ribbonsArray <Ribbon>Read-onlydeprecated

Deprecated (use ribbon instead).


seoDataSeoData

Custom SEO data for the product.


skustringmaxLength 40

Stock keeping unit. If variant management is enabled, SKUs will be set per variant, and this field will be empty.


slugstringmaxLength 100

A friendly URL name (generated automatically by the catalog when a product is created), can be updated.


stockStockRead-only

Product inventory status (in future this will be writable via Inventory API).


variantsArray <Variant>Read-onlymaxItems 1000

Product variants, will be provided if the request was sent with the includeVariants: true.

Max: 1,000 variants


visibleboolean

Whether the product is visible to site visitors.


weightnumberminimum 0maximum 999999999.99format double

Product weight. If variant management is enabled, weight will be set per variant, and this field will be empty.


weightRangeWeightRangeRead-only

Product weight range. The minimum and maximum weights of all the variants.

Did this help?