Product Object

Properties
idstringRead-only

Product ID (generated automatically by the catalog).


namestringminLength 1maxLength 80

Product name.

Min: 1 character Max: 80 characters


slugstringmaxLength 100

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


visibleboolean

Whether the product is visible to site visitors.


productTypestring
3 enum supported values:
unspecified_product_typephysicaldigital

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


descriptionstringmaxLength 8000

Product description. Accepts rich text.


skustringmaxLength 40

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


weightnumberminimum 0maximum 999999999.99format double

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


weightRangeobjectRead-only

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


stockobjectRead-only

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


priceobjectRead-onlydeprecated

Deprecated (use priceData instead).


priceDataobject

Price data.


convertedPriceDataobjectRead-only

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


priceRangeobjectRead-only

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


costAndProfitDataobject

Cost and profit data.


costRangeobjectRead-only

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


pricePerUnitDataobject

Price per unit data.


additionalInfoSectionsArray <AdditionalInfoSection>

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


ribbonsArray <Ribbon>Read-onlydeprecated

Deprecated (use ribbon instead).


mediaobjectRead-only

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


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.


manageVariantsboolean

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


productOptionsArray <ProductOption>maxItems 6

Options for this product.


productPageUrlobjectRead-only

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


numericIdnumberRead-only

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


inventoryItemIdstringRead-only

Inventory item ID - ID referencing the inventory system.


discountobject

Discount deducted from the product's original price.


collectionIdsArray <string>Read-only

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


variantsArray <Variant>Read-onlymaxItems 1000

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

Max: 1,000 variants


lastUpdatedstringRead-onlyformat date-time

Date and time the product was last updated.


createdDatestringRead-onlyformat date-time

Date and time the product was created.


seoDataobject

Custom SEO data for the product.


ribbonstringmaxLength 30

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


brandstringminLength 1maxLength 50

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

Was this helpful?
Yes
No