Skip to main content
GET
/
collections
/
{collection_id}
/
versions
Error
A valid request URL is required to generate request examples
[
  {
    "collection_id": "<string>",
    "version": "<string>",
    "version_name": "<string>",
    "pinned_main_product_ids": [
      "<string>"
    ],
    "collection_boost_rules": [
      {
        "strength": 123,
        "type": "badge"
      }
    ],
    "use_collection_specific_boost_bury": true,
    "unpin_oos": true,
    "main": true,
    "updated_at": "2023-11-07T05:31:56Z"
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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

collection_id
string
required
version
string
required
version_name
string | null
required
sort_order
enum<string>
required
Available options:
ALPHA_ASC,
ALPHA_DESC,
BEST_SELLING,
TRENDING,
CREATED,
CREATED_DESC,
PRICE_ASC,
PRICE_DESC,
STOCK_DESC,
CLICKS_DESC,
MANUAL
pinned_main_product_ids
string[]
required
collection_boost_rules
(BadgeBoostBuryRule · object | CollectionBoostBuryRule · object | TagBoostBuryRule · object)[]
required
use_collection_specific_boost_bury
boolean
required
unpin_oos
boolean
required
main
boolean
required
updated_at
string<date-time>
required