Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

collection_id
string
required

Query Parameters

merchant_id
string
required

Response

Successful Response

main_product_id
string
required
title
string
required
handle
string
required
images
ShopifyImage · object[]
required
price
number | null
required
status
enum<string>
required
Available options:
ACTIVE,
ARCHIVED,
DRAFT
in_stock
boolean
required
quantity
integer
required
badges
(OnSaleProductBadge · object | OutOfStockProductBadge · object | NewInProductBadge · object | BestsellerProductBadge · object | SlowMoverProductBadge · object | TrendingProductBadge · object | FewVariantsAvailableProductBadge · object)[]
required
n_sold_current_period
integer
required
n_sold_last_7_days
integer
required
clicks_current_period
integer
required
skus
string[]
required
created_at
string<date-time>
required
published_at
string<date-time> | null
required
variants
LiteVariant · object[]
required
sort_index
integer
default:0
required

The sort order of the product in the collection, disregarding pins

applied_boost_bury_rule
BadgeBoostBuryRule · object
required