Skip to main content
PATCH
/
api
/
v1
/
merchants
/
{merchant_id}
/
collections
/
{collection_id}
Save Collection Endpoint
curl --request PATCH \
  --url https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "market_group_id": "<string>",
  "market_id": "<string>",
  "localized_titles": {},
  "uri": "<string>",
  "show_in_filter": true,
  "show_in_search_suggestions": true,
  "appear_in_quicklinks": true,
  "display_breadcrumb": true,
  "pinned_main_product_ids": [
    "<string>"
  ],
  "hidden_main_product_ids": [
    "<string>"
  ],
  "added_main_product_ids": [
    "<string>"
  ],
  "removed_main_product_ids": [
    "<string>"
  ],
  "pinned_collection_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "content_blocks": [
    {
      "span_columns": 123,
      "span_rows": 123,
      "row": 123,
      "content": {
        "url": "<string>",
        "link": "<string>",
        "type": "image"
      }
    }
  ],
  "cover_image_url": "<string>",
  "added_filter_rules": [
    [
      {
        "field": "<string>",
        "data": "<unknown>",
        "meta": "<unknown>",
        "id": "<string>"
      }
    ]
  ]
}
'
import requests

url = "https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}"

payload = {
"market_group_id": "<string>",
"market_id": "<string>",
"localized_titles": {},
"uri": "<string>",
"show_in_filter": True,
"show_in_search_suggestions": True,
"appear_in_quicklinks": True,
"display_breadcrumb": True,
"pinned_main_product_ids": ["<string>"],
"hidden_main_product_ids": ["<string>"],
"added_main_product_ids": ["<string>"],
"removed_main_product_ids": ["<string>"],
"pinned_collection_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"content_blocks": [
{
"span_columns": 123,
"span_rows": 123,
"row": 123,
"content": {
"url": "<string>",
"link": "<string>",
"type": "image"
}
}
],
"cover_image_url": "<string>",
"added_filter_rules": [[
{
"field": "<string>",
"data": "<unknown>",
"meta": "<unknown>",
"id": "<string>"
}
]]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
market_group_id: '<string>',
market_id: '<string>',
localized_titles: {},
uri: '<string>',
show_in_filter: true,
show_in_search_suggestions: true,
appear_in_quicklinks: true,
display_breadcrumb: true,
pinned_main_product_ids: ['<string>'],
hidden_main_product_ids: ['<string>'],
added_main_product_ids: ['<string>'],
removed_main_product_ids: ['<string>'],
pinned_collection_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
content_blocks: [
{
span_columns: 123,
span_rows: 123,
row: 123,
content: {url: '<string>', link: '<string>', type: 'image'}
}
],
cover_image_url: '<string>',
added_filter_rules: [[{field: '<string>', data: '<unknown>', meta: '<unknown>', id: '<string>'}]]
})
};

fetch('https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'market_group_id' => '<string>',
'market_id' => '<string>',
'localized_titles' => [

],
'uri' => '<string>',
'show_in_filter' => true,
'show_in_search_suggestions' => true,
'appear_in_quicklinks' => true,
'display_breadcrumb' => true,
'pinned_main_product_ids' => [
'<string>'
],
'hidden_main_product_ids' => [
'<string>'
],
'added_main_product_ids' => [
'<string>'
],
'removed_main_product_ids' => [
'<string>'
],
'pinned_collection_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'content_blocks' => [
[
'span_columns' => 123,
'span_rows' => 123,
'row' => 123,
'content' => [
'url' => '<string>',
'link' => '<string>',
'type' => 'image'
]
]
],
'cover_image_url' => '<string>',
'added_filter_rules' => [
[
[
'field' => '<string>',
'data' => '<unknown>',
'meta' => '<unknown>',
'id' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}"

payload := strings.NewReader("{\n \"market_group_id\": \"<string>\",\n \"market_id\": \"<string>\",\n \"localized_titles\": {},\n \"uri\": \"<string>\",\n \"show_in_filter\": true,\n \"show_in_search_suggestions\": true,\n \"appear_in_quicklinks\": true,\n \"display_breadcrumb\": true,\n \"pinned_main_product_ids\": [\n \"<string>\"\n ],\n \"hidden_main_product_ids\": [\n \"<string>\"\n ],\n \"added_main_product_ids\": [\n \"<string>\"\n ],\n \"removed_main_product_ids\": [\n \"<string>\"\n ],\n \"pinned_collection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"content_blocks\": [\n {\n \"span_columns\": 123,\n \"span_rows\": 123,\n \"row\": 123,\n \"content\": {\n \"url\": \"<string>\",\n \"link\": \"<string>\",\n \"type\": \"image\"\n }\n }\n ],\n \"cover_image_url\": \"<string>\",\n \"added_filter_rules\": [\n [\n {\n \"field\": \"<string>\",\n \"data\": \"<unknown>\",\n \"meta\": \"<unknown>\",\n \"id\": \"<string>\"\n }\n ]\n ]\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"market_group_id\": \"<string>\",\n \"market_id\": \"<string>\",\n \"localized_titles\": {},\n \"uri\": \"<string>\",\n \"show_in_filter\": true,\n \"show_in_search_suggestions\": true,\n \"appear_in_quicklinks\": true,\n \"display_breadcrumb\": true,\n \"pinned_main_product_ids\": [\n \"<string>\"\n ],\n \"hidden_main_product_ids\": [\n \"<string>\"\n ],\n \"added_main_product_ids\": [\n \"<string>\"\n ],\n \"removed_main_product_ids\": [\n \"<string>\"\n ],\n \"pinned_collection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"content_blocks\": [\n {\n \"span_columns\": 123,\n \"span_rows\": 123,\n \"row\": 123,\n \"content\": {\n \"url\": \"<string>\",\n \"link\": \"<string>\",\n \"type\": \"image\"\n }\n }\n ],\n \"cover_image_url\": \"<string>\",\n \"added_filter_rules\": [\n [\n {\n \"field\": \"<string>\",\n \"data\": \"<unknown>\",\n \"meta\": \"<unknown>\",\n \"id\": \"<string>\"\n }\n ]\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"market_group_id\": \"<string>\",\n \"market_id\": \"<string>\",\n \"localized_titles\": {},\n \"uri\": \"<string>\",\n \"show_in_filter\": true,\n \"show_in_search_suggestions\": true,\n \"appear_in_quicklinks\": true,\n \"display_breadcrumb\": true,\n \"pinned_main_product_ids\": [\n \"<string>\"\n ],\n \"hidden_main_product_ids\": [\n \"<string>\"\n ],\n \"added_main_product_ids\": [\n \"<string>\"\n ],\n \"removed_main_product_ids\": [\n \"<string>\"\n ],\n \"pinned_collection_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"content_blocks\": [\n {\n \"span_columns\": 123,\n \"span_rows\": 123,\n \"row\": 123,\n \"content\": {\n \"url\": \"<string>\",\n \"link\": \"<string>\",\n \"type\": \"image\"\n }\n }\n ],\n \"cover_image_url\": \"<string>\",\n \"added_filter_rules\": [\n [\n {\n \"field\": \"<string>\",\n \"data\": \"<unknown>\",\n \"meta\": \"<unknown>\",\n \"id\": \"<string>\"\n }\n ]\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "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

merchant_id
string
required
collection_id
string<uuid>
required

Query Parameters

locale
string | null

Body

application/json
market_group_id
string | null
market_id
string | null
localized_titles
Localized Titles · object | null
uri
string | null
Maximum string length: 512
show_in_filter
boolean | null
show_in_search_suggestions
boolean | null
display_breadcrumb
boolean | null
pinned_main_product_ids
string[] | null
Maximum array length: 2000
hidden_main_product_ids
string[] | null
Maximum array length: 2000
added_main_product_ids
string[] | null
Maximum array length: 2000
removed_main_product_ids
string[] | null
Maximum array length: 2000
pinned_collection_ids
string<uuid>[] | null
content_blocks
ContentBlock · object[] | null
Maximum array length: 100
cover_image_url
string | null
ranking_type
enum<string> | null
Available options:
top,
similar,
complementary
added_filter_rules
PortalSearchFilter · object[][] | null
Maximum array length: 100

Response

Successful Response