Skip to main content
GET
/
api
/
v1
/
merchants
/
{merchant_id}
/
collections
/
{collection_id}
Get Collection Endpoint
curl --request GET \
  --url https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id} \
  --header 'Authorization: Bearer <token>'
import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

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

curl_close($curl);

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

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

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/merchants/{merchant_id}/collections/{collection_id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externally_owned": true,
  "title": "<string>",
  "uri": "<string>",
  "permissions": {
    "can_edit_metadata": true,
    "can_edit_visibility": true,
    "can_update_products": true,
    "can_pin_products": true,
    "can_hide_products": true,
    "can_edit_images": true,
    "can_edit_content": true,
    "can_delete": true
  },
  "market_context": {
    "market_group_id": "<string>",
    "market_id": "<string>",
    "resolved_market": "<string>"
  },
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "localized_titles": {},
  "n_main_products": 123,
  "manual_product_count": 123,
  "image_urls": [],
  "cover_image_url": "<string>",
  "content_blocks": [],
  "ranking_type": "top",
  "show_in_filter": true,
  "show_in_search_suggestions": false,
  "appear_in_quicklinks": true,
  "display_breadcrumb": true,
  "children": []
}
{
"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

market
string | null
locale
string | null
market_group_id
string | null

Response

Successful Response

collection_id
string<uuid>
required
collection_type
enum<string>
required
Available options:
long_tail_collection,
campaign,
category,
smart_pick,
style,
brand,
look
externally_owned
boolean
required
title
string
required
uri
string
required
permissions
CollectionPermissions · object
required
market_context
CollectionMarketContext · object
required
parent_id
string<uuid> | null
localized_titles
Localized Titles · object
n_main_products
integer | null
manual_product_count
integer | null
image_urls
string[]
cover_image_url
string | null
content_blocks
ContentBlock · object[]
chunk_type
enum<string> | null
Available options:
similar,
complementary
ranking_type
enum<string>
default:top
Available options:
top,
similar,
complementary
show_in_filter
boolean
default:true
show_in_search_suggestions
boolean
default:false
display_breadcrumb
boolean
default:true
children
CollectionChild · object[]