Similar Products - Channel3

Python

import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
page = client.products.find_similar(
    product_id="product_id",
)
page = page.products[0]
print(page.id)

import Channel3 from '@channel3/sdk';

const client = new Channel3({
  apiKey: process.env['CHANNEL3_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const productDetail of client.products.findSimilar({ product_id: 'product_id' })) {
  console.log(productDetail.id);
}

curl --request POST \
  --url https://api.trychannel3.com/v1/similar \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "product_id": "<string>",
  "limit": 20,
  "filters": {
    "conditions": [
      "new"
    ],
    "availability": [
      "InStock"
    ]
  },
  "config": {},
  "page_token": "<string>"
}
'

{
  "products": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "brands": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "images": [],
      "category": {
        "slug": "<string>",
        "title": "<string>",
        "has_children": true,
        "path": [
          {
            "slug": "<string>",
            "title": "<string>"
          }
        ]
      },
      "gender": "male",
      "age": "newborn",
      "materials": [
        "<string>"
      ],
      "key_features": [
        "<string>"
      ],
      "offers": [
        {
          "url": "<string>",
          "domain": "<string>",
          "price": {
            "price": 123,
            "currency": "<string>",
            "compare_at_price": 123
          },
          "availability": "InStock",
          "condition": "new",
          "max_commission_rate": 0,
          "dimensions": {
            "length": {
              "number": 123,
              "unit": "mm"
            },
            "width": {
              "number": 123,
              "unit": "mm"
            },
            "height": {
              "number": 123,
              "unit": "mm"
            },
            "weight": {
              "number": 123,
              "unit": "mg"
            }
          }
        }
      ],
      "variants": {
        "options": [
          {
            "name": "<string>",
            "values": [
              {
                "label": "<string>",
                "exists": true,
                "available": "InStock",
                "thumbnail_url": "<string>",
                "product_id": "<string>"
              }
            ]
          }
        ],
        "selected": [
          {
            "name": "<string>",
            "label": "<string>"
          }
        ]
      },
      "structured_attributes": {}
    }
  ],
  "next_page_token": "<string>"
}

POST

/

v1

/

similar

Python

import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
page = client.products.find_similar(
    product_id="product_id",
)
page = page.products[0]
print(page.id)

import Channel3 from '@channel3/sdk';

const client = new Channel3({
  apiKey: process.env['CHANNEL3_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const productDetail of client.products.findSimilar({ product_id: 'product_id' })) {
  console.log(productDetail.id);
}

curl --request POST \
  --url https://api.trychannel3.com/v1/similar \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "product_id": "<string>",
  "limit": 20,
  "filters": {
    "conditions": [
      "new"
    ],
    "availability": [
      "InStock"
    ]
  },
  "config": {},
  "page_token": "<string>"
}
'

{
  "products": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "brands": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "images": [],
      "category": {
        "slug": "<string>",
        "title": "<string>",
        "has_children": true,
        "path": [
          {
            "slug": "<string>",
            "title": "<string>"
          }
        ]
      },
      "gender": "male",
      "age": "newborn",
      "materials": [
        "<string>"
      ],
      "key_features": [
        "<string>"
      ],
      "offers": [
        {
          "url": "<string>",
          "domain": "<string>",
          "price": {
            "price": 123,
            "currency": "<string>",
            "compare_at_price": 123
          },
          "availability": "InStock",
          "condition": "new",
          "max_commission_rate": 0,
          "dimensions": {
            "length": {
              "number": 123,
              "unit": "mm"
            },
            "width": {
              "number": 123,
              "unit": "mm"
            },
            "height": {
              "number": 123,
              "unit": "mm"
            },
            "weight": {
              "number": 123,
              "unit": "mg"
            }
          }
        }
      ],
      "variants": {
        "options": [
          {
            "name": "<string>",
            "values": [
              {
                "label": "<string>",
                "exists": true,
                "available": "InStock",
                "thumbnail_url": "<string>",
                "product_id": "<string>"
              }
            ]
          }
        ],
        "selected": [
          {
            "name": "<string>",
            "label": "<string>"
          }
        ]
      },
      "structured_attributes": {}
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

x-api-key

string

header

required

Headers

x-user-id

string | null

Optional user identifier to attribute clicks and sales to a user in your system. Channel3 appends it to buy URLs in the response.

Body

application/json

Find products similar to a given product.

product_id

string

required

Canonical product ID to find similar products for.

limit

integer | null

default:20

Optional limit on the number of results. Default is 20, max is 30.

Required range: x >= 1

filters

SearchFilters · object

Optional filters. Search will only consider products that match all of the filters.

Show child attributes

config

LocaleConfig · object

Optional locale configuration.

Show child attributes

page_token

string | null

Opaque token from a previous similar response to fetch the next page of results.

Response

Successful Response

v1 paginated search response.

products

Product · object[]

required

Show child attributes

next_page_token

string | null

Token to fetch the next page. Null when no more results.