Product Object
Product ID (generated automatically by the catalog).
Product name.
Min: 1 character Max: 80 characters
A friendly URL name (generated automatically by the catalog when a product is created), can be updated.
Whether the product is visible to site visitors.
Currently, only creating physical products ( "productType": "physical" ) is supported via the API.
Product description. Accepts rich text.
Stock keeping unit. If variant management is enabled, SKUs will be set per variant, and this field will be empty.
Product weight. If variant management is enabled, weight will be set per variant, and this field will be empty.
Product weight range. The minimum and maximum weights of all the variants.
Product inventory status (in future this will be writable via Inventory API).
Deprecated (use priceData instead).
Price data.
Price data, converted to the currency specified in request header.
Product price range. The minimum and maximum prices of all the variants.
Cost and profit data.
Product cost range. The minimum and maximum costs of all the variants.
Price per unit data.
Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.).
Deprecated (use ribbon instead).
Media items (images, videos etc) associated with this product (writable via Add Product Media endpoint).
Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data.
Options for this product.
Product page URL for this product (generated automatically by the server).
Product’s unique numeric ID (assigned in ascending order). Primarily used for sorting and filtering when crawling all products.
Inventory item ID - ID referencing the inventory system.
Discount deducted from the product's original price.
A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
Product variants, will be provided if the the request was sent with the includeVariants flag.
Date and time the product was last updated.
Date and time the product was created.
Custom SEO data for the product.
Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out".
Product brand. Including a brand name can help improve site and product visibility on search engines.