Skip to main content
PUT
/
collections
/
{collection_id}
Error
A valid request URL is required to generate request examples
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
{
  "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

Body

application/json
​
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
​
version
string<uuid> | null
required
​
main
boolean
required
​
use_collection_specific_boost_bury
boolean
required
​
unpin_oos
boolean
required

Response

Successful Response

The response is of type string<uuid>.