🔒
Requires write_product access scope. For more access scope

The Create Product API enables merchants to add new products to their store seamlessly. This endpoint supports detailed customization of product attributes, including title, price, inventory, and more.This API is especially useful for:

Adding new products with tailored specifications such as descriptions, SEO details, and inventory settings.
Simplifying product management with customizable fields like tags, variants, and vendor details.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Body Parameters

Parameter	Type	Required	Description	Example
`product`	object	Yes	Container for product data	-
`product.title`	string	Yes	Product display name	`"Wireless Headphones"`
`product.brief`	string	No	Short description	`"Noise-cancelling Bluetooth headphones"`
`product.description`	string	No	Full product description	`"Premium wireless headphones with 30hr battery..."`
`product.published`	boolean	No	Publish status	`true`
`product.requires_shipping`	boolean	No	Shipping requirement	`true`
`product.taxable`	boolean	No	Taxable status	`true`
`product.tags`	array of strings	No	Product tags	`["audio", "wireless"]`
`product.vendor`	string	No	Manufacturer name	`"Sony"`
`product.vendor_url`	string	No	Vendor website	`"https://sony.com"`
`product.note`	string	No	Internal notes	`"2025 summer collection"`
`product.seo_title`	string	No	SEO title	`"Premium Wireless Headphones"`
`product.seo_description`	string	No	SEO description	`"Buy best noise-cancelling headphones"`
`product.seo_keywords`	array of strings	No	SEO keywords	`["headphones", "bluetooth"]`
`product.handle`	string	No	URL handle	`"wireless-headphones"`
`product. has_only_default_variant`	boolean	Yes	Single variant flag	`false`
`product.inventory_tracking`	boolean	No	Inventory tracking	`true`
`product.inventory_policy`	string	No	Inventory policy	`"deny"`
`product.need_variant_image`	boolean	No	Variant images required	`true`
`product.spu`	string	No	Standard product unit	`"SPU123"`
`product.fake_sales`	string	No	Display sales count	`"100"`
`product.display_fake_sales`	boolean	No	Show fake sales	`true`
`product.options`	array of objects	Yes	Product options	-
`product.options.name`	string	Yes	Option name	`"Color"`
`product.options.values`	array of strings	Yes	Option values	`["Black", "White"]`
`product.images`	array of objects	Yes	Product images	-
`product.images.src`	string	Yes	Image URL	`"https://example.com/image.jpg"`
`product.images.width`	int32	No	Image width	`800`
`product.images.height`	int32	No	Image height	`600`
`product.images.alt`	string	No	Alt text	`"Black headphones"`
`product.images.path`	string	No	Image path	`"/images/headphones"`
`product.variants`	array of objects	Yes	Product variants	-
`product.variants.option1`	string	No	Option 1 value	`"Black"`
`product.variants.option2`	string	No	Option 2 value	`"Large"`
`product.variants.option3`	string	No	Option 3 value	`""`
`product.variants.position`	int64	No	variant position	1
`product.variants. image`	object	No	Variant image	-
`product.variants. image.src`	string	Yes	Image URL	`"https://example.com/variant.jpg"`
`product.variants. image.width`	int32	No	Image width	`800`
`product.variants. image.height`	int32	No	Image height	`600`
`product.variants. image.alt`	string	No	Alt text	`"Black variant"`
`product.variants. image.path`	string	No	Image path	`"/images/variant"`
`product.variants. compare_at_price`	float	No	Original price	`199.99`
`product.variants. price`	float	Yes	Selling price	`149.99`
`product.variants.sku`	string	No	Stock keeping unit	`"SKU123BLK"`
`product.variants.barcode`	string	No	Product barcode	`"123456789"`
`product.variants.note`	string	No	Variant notes	`"New stock"`
`product.variants. inventory_quantity`	string	No	Stock quantity	`"50"`
`product.variants. weight`	float	No	Product weight	`0.5`
`product.variants. weight_unit`	string	No	Weight unit	`"kg"`
`product.variants. cost_price`	float	No	Cost price	`89.99`
`product.variants. whole_prices`	array of objects	No	Wholesale prices	-
`product.variants. whole_prices.price`	float	Yes	Wholesale price	`129.99`
`product.variants. whole_prices.min_quantity`	string	Yes	Minimum order	`"10"`
`product.variants.retail_price`	float	No	Retail price	`149.99`
`product.variants.position`	string	No	Display order	`"1"`
`product.variants.extend`	object	No	Extended properties	-
`product.variants.extend. length`	float	No	Product length	`20.5`
`product.variants.extend. width`	float	No	Product width	`15.0`
`product.variants.extend. height`	float	No	Product height	`5.0`
`product.variants.extend. dimension_unit`	string	No	Dimension unit	`"cm"`
`product.variants.extend. origin_country_code`	string	No	Country of origin	`"CN"`
`product.variants.extend. hs_code`	string	No	HS code	`"8518.29"`
`product.variants.extend. mixed_wholesale`	boolean	No	Mixed wholesale	`false`
`product.collection_ids`	array of strings	No	Collection IDs	`["coll_123"]`
`product.product_type`	string	No	Product category	`"electronics"`
`product.brand`	string	No	Brand name	`"Sony"`
`product.unique_token`	string	No	Idempotency key	`"e6cc4df1-d4f5-4ad4-a019-2e0f3ddd6e63"`
`product.independent_seo`	boolean	No	Custom SEO flag	`true`
`product.inventory_quantity`	string	No	Total inventory	`"150"`
`product.category_id`	string	No	Category Id	`"e6cc4df1-d4f5-4ad4-a019-2e0f3ddd6e63"`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`"200"`	HTTP status code
`message`	string	`"Success"`	Operation result message
`data.product`	objects	-

Product Object

Parameter	Type	Example	Description
`id`	string	`"prod_123"`	Product ID
`title`	string	`"Wireless Headphones"`	Product title
`description`	string	`"Noise-cancelling wireless headphones"`	Product description
`published`	boolean	`true`	Published status
`requires_shipping`	boolean	`true`	Shipping requirement
`taxable`	boolean	`true`	Taxable status
`tags`	array of strings	`["audio", "wireless"]`	Product tags
`vendor`	string	`"Sony"`	Vendor name
`vendor_url`	string	`"https://sony.com"`	Vendor URL
`note`	string	`"Limited edition"`	Internal note
`seo_title`	string	`"Premium Headphones"`	SEO title
`seo_description`	string	`"Buy best wireless headphones"`	SEO description
`seo_keywords`	array of strings	`["headphones", "audio"]`	SEO keywords
`handle`	string	`"wireless-headphones"`	Product handle
`has_only_default_variant`	boolean	`false`	Single variant flag
`inventory_tracking`	boolean	`true`	Inventory tracking
`inventory_policy`	string	`"deny"`	Inventory policy
`need_variant_image`	boolean	`true`	Variant image requirement
`spu`	string	`"SPU123"`	Standard product unit
`fake_sales`	string	`"100"`	Display sales count
`display_fake_sales`	boolean	`true`	Show fake sales
`options`	array of objects	-	Product options
`options.id`	string	`"opt_123"`	Option ID
`options.name`	string	`"Color"`	Option name
`options.values`	array of strings	`["Black", "White"]`	Option values
`options.position`	string	`"1"`	Option position
`images`	array of objects	-	Product images
`images.id`	string	`"img_123"`	Image ID
`images.src`	string	`"https://example. com/image.jpg"`	Image URL
`images.width`	int32	`800`	Image width
`images.height`	int32	`600`	Image height
`images.alt`	string	`"Black headphones"`	Image alt text
`images.position`	string	`"1"`	Image position
`images.path`	string	`"/images/headphones"`	Image path
`variants`	array of objects	-	Product variants
`variants.id`	string	`"var_123"`	Variant ID
`variants.product_id`	string	`"prod_123"`	Parent product ID
`variants.image_id`	string	`"img_123"`	Variant image ID
`variants.created_at`	string	`"2025-01-01T00:00:00Z"`	Creation time
`variants.updated_at`	string	`"2025-06-01T00:00:00Z"`	Update time
`variants.title`	string	`"Black"`	Variant title
`variants.option1`	string	`"Black"`	Option 1 value
`variants.option2`	string	`"Large"`	Option 2 value
`variants.option3`	string	`""`	Option 3 value
`variants.image`	object	-	Variant image
`variants.image.position`	string	`"1"`	Image position
`variants.compare_at_price`	float	`199.99`	Compare at price
`variants.price`	float	`149.99`	Current price
`variants.sku`	string	`"SKU123BLK"`	Stock keeping unit
`variants.barcode`	string	`"123456789"`	Barcode
`variants.note`	string	`"New stock"`	Variant note
`variants. inventory_quantity`	string	`"50"`	Inventory count
`variants.weight`	float	`0.5`	Product weight
`variants.weight_unit`	string	`"kg"`	Weight unit
`variants.cost_price`	float	`89.99`	Cost price
`variants.whole_prices`	array of objects	-	Wholesale prices
`variants. whole_prices.price`	float	`129.99`	Wholesale price
`variants.whole_prices. min_quantity`	string	`"10"`	Minimum quantity
`variants. retail_price`	float	`149.99`	Retail price
`variants. is_discount`	boolean	`false`	Discount status
`variants. origin_price`	float	`149.99`	Original price
`variants. extend`	object	-	Extended properties
`variants. extend.length`	float	`20.5`	Product length
`variants. extend.width`	float	`15.0`	Product width
`variants. extend.height`	float	`5.0`	Product height
`variants.extend. dimension_unit`	string	`"cm"`	Dimension unit
`variants.extend. origin_country_code`	string	`"CN"`	Country of origin
`variants.extend. hs_code`	string	`"8518.29"`	HS code
`variants.extend. mixed_wholesale`	boolean	`false`	Mixed wholesale
`product_type`	string	`"electronics"`	Product type
`brand`	string	`"Sony"`	Product brand
`brief`	string	`"Premium audio"`	Brief description
`inventory_quantity`	string	`"150"`	Total inventory
`price_min`	float	`149.99`	Minimum price
`price_max`	float	`199.99`	Maximum price
`compare_at_price_min`	float	`199.99`	Minimum compare price
`compare_at_price_max`	float	`249.99`	Maximum compare price
`published_at`	string	`"2025-05-15T00:00:00Z"`	Publish date
`created_at`	string	`"2025-01-01T00:00:00Z"`	Creation date
`updated_at`	string	`"2025-06-01T00:00:00Z"`	Update date
`sales`	string	`"75"`	Actual sales count
`independent_seo`	boolean	`true`	Custom SEO flag
`url`	string	`"/products/wireless-headphones"`	Product URL
`available`	boolean	`true`	Availability status
`retail_price_min`	float	`149.99`	Minimum retail price
`retail_price_max`	float	`199.99`	Maximum retail price
`origin_price_min`	float	`149.99`	Minimum original price
`origin_price_max`	float	`199.99`	Maximum original price
`primary_image`	object	-	Primary image
`primary_image.src`	string	`"https://example. com/primary.jpg"`	Image URL
`primary_image.width`	int32	`800`	Image width
`primary_image.height`	int32	`600`	Image height
`primary_image.alt`	string	`"Primary product image"`	Alt text
`primary_image.path`	string	`"/images/primary"`	Image path
`tax_code`	string	`"TAX123"`	Tax code
`category_id`	string	`"cat_123"`	Category ID
`category`	object	-	Category details
`category.id`	string	`"cat_123"`	Category ID
`category.name`	string	`"Electronics"`	Category name
`category.google_id`	string	`"12345"`	Google category ID
`category.level`	int32	`2`	Category level
`category.path`	string	`"Electronics/Audio"`	Category path

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

200OK