Passer au contenu principal
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": "<string>",
  "name": "<string>",
  "vendors": [
    "<string>"
  ],
  "categories": [
    "<string>"
  ],
  "description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
  "brand": {
    "id": "<string>",
    "name": "<string>"
  },
  "imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
  "price": 18.99,
  "active": true,
  "ean": "4003994155486",
  "quality_score": 0.5,
  "metadata": {},
  "globalId": "PROD-12345"
}

Autorisations

​
Authorization
string
header
requis

A valid API key generated in Topsort's UI.

Paramètres de chemin

​
product-id
string
requis

The ID of the product to retrieve.

Minimum string length: 1

Réponse

Successful Response

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

​
id
string
requis

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

Minimum string length: 1
Exemples:

"eyGqR4YQgBJa"

"PROD-548"

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

​
name
string
requis

Name of the product. Shown in Topsort UI.

Minimum string length: 1
Exemple:

"Delirium Tremens Beer Bottle 330cc x6"

​
vendors
string[]
requis

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

Exemple:
["9SiwYqqL8vdG", "BRAND-48795"]
​
categories
string[]
requis

IDs of the categories this product belongs to.

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

Description of the product.

Minimum string length: 1
Exemple:

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

​
brand
Brand · object

Brand information of the product.

​
imageURL
string<uri>

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 string length: 1
Exemple:

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

​
price
number | null

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

Plage requise: x > 0
Exemple:

18.99

​
active
boolean
défaut: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
Exemple:

"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.

Plage requise: 0 < x <= 1
​
metadata
Metadata · object

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

Exemple:

"PROD-12345"