Skip to main content
GET
/
public
/
v1
/
catalog-search-service
/
catalogs
/
products
/
{product-id}
Get Product
curl --request GET \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products/{product-id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "eyGqR4YQgBJa",
  "name": "Delirium Tremens Beer Bottle 330cc x6",
  "description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
  "vendors": [
    "9SiwYqqL8vdG",
    "BRAND-48795"
  ],
  "brand": {
    "id": "es5086vyV",
    "name": "Delirium"
  },
  "imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
  "categories": [
    "ahEDqV5uhjj8"
  ],
  "price": 18.99,
  "active": true,
  "ean": "4003994155486",
  "quality_score": 0.5,
  "metadata": {},
  "globalId": "PROD-12345"
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Path Parameters

​
product-id
string
required

The ID of the product to retrieve.

Minimum length: 1

Response

Successful Response

A product is the minimum unit that can be sold within a marketplace catalog.

​
id
string
required

Unique ID of the product. Topsort treats IDs as strings, choose any format as long as it is unique within the catalog.

Minimum length: 1
Examples:

"eyGqR4YQgBJa"

"PROD-548"

"52c8c83c-2f4f-4873-87a0-1ccd88273b27"

​
name
string
required

Name of the product. Shown in Topsort UI.

Minimum length: 1
Examples:

"Delirium Tremens Beer Bottle 330cc x6"

​
vendors
string[]
required

IDs of the vendors that can promote this product in campaigns.

Examples:
["9SiwYqqL8vdG", "BRAND-48795"]
​
categories
string[]
required

IDs of the categories this product belongs to.

Examples:
["ahEDqV5uhjj8"]
["CAT-343", "CAT-456"]
["52c8c83c-2f4f-4873-87a0-1ccd88273b27"]
​
description
string | null

Description of the product.

Minimum length: 1
Examples:

"Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois."

​
brand
object | null

Brand information of the product. The brand which a product belongs to.

​
imageURL
string<uri> | null

URL of the product image. This image will be displayed in the Topsort UI. Image dimensions between 250x250 and 600x600 pixels are recommended for the best performance of the Topsort UI.

Minimum length: 1
Examples:

"https://cdn.example.com/products/eyGqR4YQgBJa.jpg"

​
price
number | null

Price of the product in the currency configured in the marketplace.

Required range: x > 0
Examples:

18.99

0.15

1999.95

​
active
boolean
default:true

Flag that indicates whether this product is active. Only active products can take part in campaigns and auctions. Set this value to false to deactivate a product. When a product is deactivated it will be removed from active campaigns. We advise to set this flag to false when a product is out of stock.

​
ean
string | null

European Article Number. Formatted as a thirteen digit EAN-13 code.

Required string length: 13
Examples:

"4003994155486"

​
quality_score
number | null

Marketplace's internal quality score for the product. This in an optional advanced use case, for which we can provide some insights. Examples of metrics include the product's rating, conversion rate, click through rate, combination of other metrics, etc.

Required range: 0 < x <= 1
​
metadata
object | null

Additional metadata for the product.

​
globalId
string | null

Global ID of the product. This is an optional field that can be used to link the product to other marketplaces

Examples:

"PROD-12345"

"PROD-67890"