curl --request PUT \
--url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"products": [
{
"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"
}
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Upsert products.
curl --request PUT \
--url https://api.topsort.com/public/v1/catalog-search-service/catalogs/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"products": [
{
"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"
}
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}A valid API key generated in Topsort's UI.
The products to create or substitute.
1 - 500 elementsShow child attributes
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.
IDs of the categories this product belongs to.
Description of the product.
1"Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois."
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.
1"https://cdn.example.com/products/eyGqR4YQgBJa.jpg"
Price of the product in the currency configured in the marketplace.
x > 018.99
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.
European Article Number. Formatted as a thirteen digit EAN-13 code.
13"4003994155486"
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.
0 < x <= 1Global ID of the product. This is an optional field that can be used to link the product to other marketplaces
"PROD-12345"
Successful Response
Was this page helpful?