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": "eyGqR4YQgBJa",
"name": "Delirium Tremens Beer Bottle 330cc x6",
"vendors": [
"9SiwYqqL8vdG",
"BRAND-48795"
],
"categories": [
"ahEDqV5uhjj8"
],
"description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
"brand": {
"id": "es5086vyV",
"name": "Delirium"
},
"imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
"price": 18.99,
"active": true,
"ean": "4003994155486",
"gtin": "5901234123457",
"quality_score": 0.5,
"metadata": {},
"globalId": "PROD-12345",
"link": "http://www.example.com/asp/sp.asp?cat=12&id=1030",
"variantIds": [
"eyGqR4YQgBJa",
"PROD-548",
"52c8c83c-2f4f-4873-87a0-1ccd88273b27"
]
}
]
}
'import requests
url = "https://api.topsort.com/public/v1/catalog-search-service/catalogs/products"
payload = { "products": [
{
"id": "eyGqR4YQgBJa",
"name": "Delirium Tremens Beer Bottle 330cc x6",
"vendors": ["9SiwYqqL8vdG", "BRAND-48795"],
"categories": ["ahEDqV5uhjj8"],
"description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
"brand": {
"id": "es5086vyV",
"name": "Delirium"
},
"imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
"price": 18.99,
"active": True,
"ean": "4003994155486",
"gtin": "5901234123457",
"quality_score": 0.5,
"metadata": {},
"globalId": "PROD-12345",
"link": "http://www.example.com/asp/sp.asp?cat=12&id=1030",
"variantIds": ["eyGqR4YQgBJa", "PROD-548", "52c8c83c-2f4f-4873-87a0-1ccd88273b27"]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
products: [
{
id: 'eyGqR4YQgBJa',
name: 'Delirium Tremens Beer Bottle 330cc x6',
vendors: ['9SiwYqqL8vdG', 'BRAND-48795'],
categories: ['ahEDqV5uhjj8'],
description: 'Named as "Best Beer in the World" in 2008 at the World Beer Championships in Chicago, Illinois.',
brand: {id: 'es5086vyV', name: 'Delirium'},
imageURL: 'https://cdn.example.com/products/eyGqR4YQgBJa.jpg',
price: 18.99,
active: true,
ean: '4003994155486',
gtin: '5901234123457',
quality_score: 0.5,
metadata: {},
globalId: 'PROD-12345',
link: 'http://www.example.com/asp/sp.asp?cat=12&id=1030',
variantIds: ['eyGqR4YQgBJa', 'PROD-548', '52c8c83c-2f4f-4873-87a0-1ccd88273b27']
}
]
})
};
fetch('https://api.topsort.com/public/v1/catalog-search-service/catalogs/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.topsort.com/public/v1/catalog-search-service/catalogs/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'products' => [
[
'id' => 'eyGqR4YQgBJa',
'name' => 'Delirium Tremens Beer Bottle 330cc x6',
'vendors' => [
'9SiwYqqL8vdG',
'BRAND-48795'
],
'categories' => [
'ahEDqV5uhjj8'
],
'description' => 'Named as "Best Beer in the World" in 2008 at the World Beer Championships in Chicago, Illinois.',
'brand' => [
'id' => 'es5086vyV',
'name' => 'Delirium'
],
'imageURL' => 'https://cdn.example.com/products/eyGqR4YQgBJa.jpg',
'price' => 18.99,
'active' => true,
'ean' => '4003994155486',
'gtin' => '5901234123457',
'quality_score' => 0.5,
'metadata' => [
],
'globalId' => 'PROD-12345',
'link' => 'http://www.example.com/asp/sp.asp?cat=12&id=1030',
'variantIds' => [
'eyGqR4YQgBJa',
'PROD-548',
'52c8c83c-2f4f-4873-87a0-1ccd88273b27'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.topsort.com/public/v1/catalog-search-service/catalogs/products"
payload := strings.NewReader("{\n \"products\": [\n {\n \"id\": \"eyGqR4YQgBJa\",\n \"name\": \"Delirium Tremens Beer Bottle 330cc x6\",\n \"vendors\": [\n \"9SiwYqqL8vdG\",\n \"BRAND-48795\"\n ],\n \"categories\": [\n \"ahEDqV5uhjj8\"\n ],\n \"description\": \"Named as \\\"Best Beer in the World\\\" in 2008 at the World Beer Championships in Chicago, Illinois.\",\n \"brand\": {\n \"id\": \"es5086vyV\",\n \"name\": \"Delirium\"\n },\n \"imageURL\": \"https://cdn.example.com/products/eyGqR4YQgBJa.jpg\",\n \"price\": 18.99,\n \"active\": true,\n \"ean\": \"4003994155486\",\n \"gtin\": \"5901234123457\",\n \"quality_score\": 0.5,\n \"metadata\": {},\n \"globalId\": \"PROD-12345\",\n \"link\": \"http://www.example.com/asp/sp.asp?cat=12&id=1030\",\n \"variantIds\": [\n \"eyGqR4YQgBJa\",\n \"PROD-548\",\n \"52c8c83c-2f4f-4873-87a0-1ccd88273b27\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.topsort.com/public/v1/catalog-search-service/catalogs/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"id\": \"eyGqR4YQgBJa\",\n \"name\": \"Delirium Tremens Beer Bottle 330cc x6\",\n \"vendors\": [\n \"9SiwYqqL8vdG\",\n \"BRAND-48795\"\n ],\n \"categories\": [\n \"ahEDqV5uhjj8\"\n ],\n \"description\": \"Named as \\\"Best Beer in the World\\\" in 2008 at the World Beer Championships in Chicago, Illinois.\",\n \"brand\": {\n \"id\": \"es5086vyV\",\n \"name\": \"Delirium\"\n },\n \"imageURL\": \"https://cdn.example.com/products/eyGqR4YQgBJa.jpg\",\n \"price\": 18.99,\n \"active\": true,\n \"ean\": \"4003994155486\",\n \"gtin\": \"5901234123457\",\n \"quality_score\": 0.5,\n \"metadata\": {},\n \"globalId\": \"PROD-12345\",\n \"link\": \"http://www.example.com/asp/sp.asp?cat=12&id=1030\",\n \"variantIds\": [\n \"eyGqR4YQgBJa\",\n \"PROD-548\",\n \"52c8c83c-2f4f-4873-87a0-1ccd88273b27\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topsort.com/public/v1/catalog-search-service/catalogs/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"products\": [\n {\n \"id\": \"eyGqR4YQgBJa\",\n \"name\": \"Delirium Tremens Beer Bottle 330cc x6\",\n \"vendors\": [\n \"9SiwYqqL8vdG\",\n \"BRAND-48795\"\n ],\n \"categories\": [\n \"ahEDqV5uhjj8\"\n ],\n \"description\": \"Named as \\\"Best Beer in the World\\\" in 2008 at the World Beer Championships in Chicago, Illinois.\",\n \"brand\": {\n \"id\": \"es5086vyV\",\n \"name\": \"Delirium\"\n },\n \"imageURL\": \"https://cdn.example.com/products/eyGqR4YQgBJa.jpg\",\n \"price\": 18.99,\n \"active\": true,\n \"ean\": \"4003994155486\",\n \"gtin\": \"5901234123457\",\n \"quality_score\": 0.5,\n \"metadata\": {},\n \"globalId\": \"PROD-12345\",\n \"link\": \"http://www.example.com/asp/sp.asp?cat=12&id=1030\",\n \"variantIds\": [\n \"eyGqR4YQgBJa\",\n \"PROD-548\",\n \"52c8c83c-2f4f-4873-87a0-1ccd88273b27\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Catalog API
Upsert Products
Upsert products.
PUT
/
public
/
v1
/
catalog-search-service
/
catalogs
/
products
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": "eyGqR4YQgBJa",
"name": "Delirium Tremens Beer Bottle 330cc x6",
"vendors": [
"9SiwYqqL8vdG",
"BRAND-48795"
],
"categories": [
"ahEDqV5uhjj8"
],
"description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
"brand": {
"id": "es5086vyV",
"name": "Delirium"
},
"imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
"price": 18.99,
"active": true,
"ean": "4003994155486",
"gtin": "5901234123457",
"quality_score": 0.5,
"metadata": {},
"globalId": "PROD-12345",
"link": "http://www.example.com/asp/sp.asp?cat=12&id=1030",
"variantIds": [
"eyGqR4YQgBJa",
"PROD-548",
"52c8c83c-2f4f-4873-87a0-1ccd88273b27"
]
}
]
}
'import requests
url = "https://api.topsort.com/public/v1/catalog-search-service/catalogs/products"
payload = { "products": [
{
"id": "eyGqR4YQgBJa",
"name": "Delirium Tremens Beer Bottle 330cc x6",
"vendors": ["9SiwYqqL8vdG", "BRAND-48795"],
"categories": ["ahEDqV5uhjj8"],
"description": "Named as \"Best Beer in the World\" in 2008 at the World Beer Championships in Chicago, Illinois.",
"brand": {
"id": "es5086vyV",
"name": "Delirium"
},
"imageURL": "https://cdn.example.com/products/eyGqR4YQgBJa.jpg",
"price": 18.99,
"active": True,
"ean": "4003994155486",
"gtin": "5901234123457",
"quality_score": 0.5,
"metadata": {},
"globalId": "PROD-12345",
"link": "http://www.example.com/asp/sp.asp?cat=12&id=1030",
"variantIds": ["eyGqR4YQgBJa", "PROD-548", "52c8c83c-2f4f-4873-87a0-1ccd88273b27"]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
products: [
{
id: 'eyGqR4YQgBJa',
name: 'Delirium Tremens Beer Bottle 330cc x6',
vendors: ['9SiwYqqL8vdG', 'BRAND-48795'],
categories: ['ahEDqV5uhjj8'],
description: 'Named as "Best Beer in the World" in 2008 at the World Beer Championships in Chicago, Illinois.',
brand: {id: 'es5086vyV', name: 'Delirium'},
imageURL: 'https://cdn.example.com/products/eyGqR4YQgBJa.jpg',
price: 18.99,
active: true,
ean: '4003994155486',
gtin: '5901234123457',
quality_score: 0.5,
metadata: {},
globalId: 'PROD-12345',
link: 'http://www.example.com/asp/sp.asp?cat=12&id=1030',
variantIds: ['eyGqR4YQgBJa', 'PROD-548', '52c8c83c-2f4f-4873-87a0-1ccd88273b27']
}
]
})
};
fetch('https://api.topsort.com/public/v1/catalog-search-service/catalogs/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.topsort.com/public/v1/catalog-search-service/catalogs/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'products' => [
[
'id' => 'eyGqR4YQgBJa',
'name' => 'Delirium Tremens Beer Bottle 330cc x6',
'vendors' => [
'9SiwYqqL8vdG',
'BRAND-48795'
],
'categories' => [
'ahEDqV5uhjj8'
],
'description' => 'Named as "Best Beer in the World" in 2008 at the World Beer Championships in Chicago, Illinois.',
'brand' => [
'id' => 'es5086vyV',
'name' => 'Delirium'
],
'imageURL' => 'https://cdn.example.com/products/eyGqR4YQgBJa.jpg',
'price' => 18.99,
'active' => true,
'ean' => '4003994155486',
'gtin' => '5901234123457',
'quality_score' => 0.5,
'metadata' => [
],
'globalId' => 'PROD-12345',
'link' => 'http://www.example.com/asp/sp.asp?cat=12&id=1030',
'variantIds' => [
'eyGqR4YQgBJa',
'PROD-548',
'52c8c83c-2f4f-4873-87a0-1ccd88273b27'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.topsort.com/public/v1/catalog-search-service/catalogs/products"
payload := strings.NewReader("{\n \"products\": [\n {\n \"id\": \"eyGqR4YQgBJa\",\n \"name\": \"Delirium Tremens Beer Bottle 330cc x6\",\n \"vendors\": [\n \"9SiwYqqL8vdG\",\n \"BRAND-48795\"\n ],\n \"categories\": [\n \"ahEDqV5uhjj8\"\n ],\n \"description\": \"Named as \\\"Best Beer in the World\\\" in 2008 at the World Beer Championships in Chicago, Illinois.\",\n \"brand\": {\n \"id\": \"es5086vyV\",\n \"name\": \"Delirium\"\n },\n \"imageURL\": \"https://cdn.example.com/products/eyGqR4YQgBJa.jpg\",\n \"price\": 18.99,\n \"active\": true,\n \"ean\": \"4003994155486\",\n \"gtin\": \"5901234123457\",\n \"quality_score\": 0.5,\n \"metadata\": {},\n \"globalId\": \"PROD-12345\",\n \"link\": \"http://www.example.com/asp/sp.asp?cat=12&id=1030\",\n \"variantIds\": [\n \"eyGqR4YQgBJa\",\n \"PROD-548\",\n \"52c8c83c-2f4f-4873-87a0-1ccd88273b27\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.topsort.com/public/v1/catalog-search-service/catalogs/products")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"id\": \"eyGqR4YQgBJa\",\n \"name\": \"Delirium Tremens Beer Bottle 330cc x6\",\n \"vendors\": [\n \"9SiwYqqL8vdG\",\n \"BRAND-48795\"\n ],\n \"categories\": [\n \"ahEDqV5uhjj8\"\n ],\n \"description\": \"Named as \\\"Best Beer in the World\\\" in 2008 at the World Beer Championships in Chicago, Illinois.\",\n \"brand\": {\n \"id\": \"es5086vyV\",\n \"name\": \"Delirium\"\n },\n \"imageURL\": \"https://cdn.example.com/products/eyGqR4YQgBJa.jpg\",\n \"price\": 18.99,\n \"active\": true,\n \"ean\": \"4003994155486\",\n \"gtin\": \"5901234123457\",\n \"quality_score\": 0.5,\n \"metadata\": {},\n \"globalId\": \"PROD-12345\",\n \"link\": \"http://www.example.com/asp/sp.asp?cat=12&id=1030\",\n \"variantIds\": [\n \"eyGqR4YQgBJa\",\n \"PROD-548\",\n \"52c8c83c-2f4f-4873-87a0-1ccd88273b27\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.topsort.com/public/v1/catalog-search-service/catalogs/products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"products\": [\n {\n \"id\": \"eyGqR4YQgBJa\",\n \"name\": \"Delirium Tremens Beer Bottle 330cc x6\",\n \"vendors\": [\n \"9SiwYqqL8vdG\",\n \"BRAND-48795\"\n ],\n \"categories\": [\n \"ahEDqV5uhjj8\"\n ],\n \"description\": \"Named as \\\"Best Beer in the World\\\" in 2008 at the World Beer Championships in Chicago, Illinois.\",\n \"brand\": {\n \"id\": \"es5086vyV\",\n \"name\": \"Delirium\"\n },\n \"imageURL\": \"https://cdn.example.com/products/eyGqR4YQgBJa.jpg\",\n \"price\": 18.99,\n \"active\": true,\n \"ean\": \"4003994155486\",\n \"gtin\": \"5901234123457\",\n \"quality_score\": 0.5,\n \"metadata\": {},\n \"globalId\": \"PROD-12345\",\n \"link\": \"http://www.example.com/asp/sp.asp?cat=12&id=1030\",\n \"variantIds\": [\n \"eyGqR4YQgBJa\",\n \"PROD-548\",\n \"52c8c83c-2f4f-4873-87a0-1ccd88273b27\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.
Body
application/json
The products to create or substitute.
Required array length:
1 - 500 elementsShow child attributes
Show child attributes
Response
Successful Response
Was this page helpful?