Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Events
Audience API
Billing API
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
Assets API
Audience API
Billing API
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
Toppie API
Get Products
Get multiple products from the catalog.
curl --request GET \
--url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products{
"hasMore": true,
"nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
"response": [
{
"active": true,
"brand": {
"id": "es5086vyV",
"name": "Delirium"
},
"categories": [
"ahEDqV5uhjj8"
],
"description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
"ean": "4003994155486",
"id": "eyGqR4YQgBJa",
"imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
"metadata": {},
"name": "Delirium Tremens Beer Bottle 330cc x6",
"price": 18.99,
"quality_score": 0.5,
"vendors": [
"9SiwYqqL8vdG",
"BRAND-48795"
]
}
]
}Query Parameters
Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.
European Article Number to filter products by. Formatted as a thirteen digit EAN-13 code.
Vendor ID to filter products by.
Search terms to look for in product names and descriptions.
Response
Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.
Array of products.
IDs of the categories this product belongs to.
Unique ID of the product. Topsort treats IDs as strings, choose any format as long as it is unique within the catalog.
1Name of the product. Shown in Topsort UI.
1IDs of the vendors that can promote this product in campaigns.
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.
Note: Active products being upserted will be added to existing campaigns created through the Building Blocks service using the Promote My Shop feature.
Description of the product.
1European Article Number. Formatted as a thirteen digit EAN-13 code.
13URL 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.
1Additional metadata for the product.
Price of the product in the currency configured in the marketplace.
x > 0Marketplace'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.
0 < x < 1Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.
1curl --request GET \
--url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products{
"hasMore": true,
"nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
"response": [
{
"active": true,
"brand": {
"id": "es5086vyV",
"name": "Delirium"
},
"categories": [
"ahEDqV5uhjj8"
],
"description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
"ean": "4003994155486",
"id": "eyGqR4YQgBJa",
"imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
"metadata": {},
"name": "Delirium Tremens Beer Bottle 330cc x6",
"price": 18.99,
"quality_score": 0.5,
"vendors": [
"9SiwYqqL8vdG",
"BRAND-48795"
]
}
]
}