Error
A valid request URL is required to generate request examples[
{
"main_product_id": "<string>",
"title": "<string>",
"handle": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": 123,
"height": 123,
"alt": "<string>"
}
],
"price": 123,
"status": "ACTIVE",
"in_stock": true,
"quantity": 123,
"badges": [
{
"type": "on_sale",
"sale_percentage": 123
}
],
"n_sold_current_period": 123,
"n_sold_last_7_days": 123,
"clicks_current_period": 123,
"skus": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"variants": [
{
"id": "<string>",
"image_url": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"sort_index": 0,
"applied_boost_bury_rule": {
"strength": 123,
"badge": "on_sale",
"type": "badge"
}
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Reference
Get Collection Products
Returns all products in a collection, sorted according to the given sort order, the collections pinned products, and either the collection’s boost bury rules or the specified rules.
POST
/
collections
/
{collection_id}
/
products
Error
A valid request URL is required to generate request examples[
{
"main_product_id": "<string>",
"title": "<string>",
"handle": "<string>",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": 123,
"height": 123,
"alt": "<string>"
}
],
"price": 123,
"status": "ACTIVE",
"in_stock": true,
"quantity": 123,
"badges": [
{
"type": "on_sale",
"sale_percentage": 123
}
],
"n_sold_current_period": 123,
"n_sold_last_7_days": 123,
"clicks_current_period": 123,
"skus": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"published_at": "2023-11-07T05:31:56Z",
"variants": [
{
"id": "<string>",
"image_url": "<string>",
"selected_options": [
{
"name": "<string>",
"value": "<string>"
}
]
}
],
"sort_index": 0,
"applied_boost_bury_rule": {
"strength": 123,
"badge": "on_sale",
"type": "badge"
}
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
Available options:
ALPHA_ASC, ALPHA_DESC, BEST_SELLING, TRENDING, CREATED, CREATED_DESC, PRICE_ASC, PRICE_DESC, STOCK_DESC, CLICKS_DESC, MANUAL Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
Available options:
ACTIVE, ARCHIVED, DRAFT badges
(OnSaleProductBadge · object | OutOfStockProductBadge · object | NewInProductBadge · object | BestsellerProductBadge · object | SlowMoverProductBadge · object | TrendingProductBadge · object | FewVariantsAvailableProductBadge · object)[]
required
- OnSaleProductBadge
- OutOfStockProductBadge
- NewInProductBadge
- BestsellerProductBadge
- SlowMoverProductBadge
- TrendingProductBadge
- FewVariantsAvailableProductBadge
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The sort order of the product in the collection, disregarding pins
- BadgeBoostBuryRule
- CollectionBoostBuryRule
- TagBoostBuryRule
Show child attributes
Show child attributes
Was this page helpful?

