Python
from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment
client = Channel3(
api_key="<value>",
environment=Channel3Environment.PRODUCTION,
)
client.collections.retrieve(
collection_id="collection_id",
)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.trychannel3.com/v1/collections/{collection_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.trychannel3.com/v1/collections/{collection_id} \
--header 'x-api-key: <api-key>'{
"collection_id": "<string>",
"name": "<string>",
"clauses": [
{
"clause_id": "<string>",
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
],
"exclude_brand_ids": [
"<string>"
],
"exclude_website_ids": [
"<string>"
],
"exclude_category_ids": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"user_id": "<string>"
}
Collections
Get Collection
Get a collection. Merged brand ids are rewritten to the surviving brand.
GET
/
v1
/
collections
/
{collection_id}
Python
from channel3_sdk import Channel3
from channel3_sdk.environment import Channel3Environment
client = Channel3(
api_key="<value>",
environment=Channel3Environment.PRODUCTION,
)
client.collections.retrieve(
collection_id="collection_id",
)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.trychannel3.com/v1/collections/{collection_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://api.trychannel3.com/v1/collections/{collection_id} \
--header 'x-api-key: <api-key>'{
"collection_id": "<string>",
"name": "<string>",
"clauses": [
{
"clause_id": "<string>",
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
],
"exclude_brand_ids": [
"<string>"
],
"exclude_website_ids": [
"<string>"
],
"exclude_category_ids": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"user_id": "<string>"
}
Was this page helpful?