Upsert Categories

Create or replace one or more categories in the catalog.

PUT /public/v1/catalog-search-service/catalogs/categories

Upsert Categories

cURL

curl --request PUT \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "parentId": "CAT-434",
      "path": "apparel_and_accessories.clothing.dresses",
      "globalId": "CAT-12345",
      "metadata": {
        "description": "All drinks available in the marketplace.",
        "globalName": "Beers",
        "path": "Driks/Alcoholic/Beers",
        "showInStore": true
      }
    }
  ]
}
'

import requests

url = "https://api.topsort.com/public/v1/catalog-search-service/catalogs/categories"

payload = { "categories": [
        {
            "id": "<string>",
            "name": "<string>",
            "parentId": "CAT-434",
            "path": "apparel_and_accessories.clothing.dresses",
            "globalId": "CAT-12345",
            "metadata": {
                "description": "All drinks available in the marketplace.",
                "globalName": "Beers",
                "path": "Driks/Alcoholic/Beers",
                "showInStore": True
            }
        }
    ] }
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({
    categories: [
      {
        id: '<string>',
        name: '<string>',
        parentId: 'CAT-434',
        path: 'apparel_and_accessories.clothing.dresses',
        globalId: 'CAT-12345',
        metadata: {
          description: 'All drinks available in the marketplace.',
          globalName: 'Beers',
          path: 'Driks/Alcoholic/Beers',
          showInStore: true
        }
      }
    ]
  })
};

fetch('https://api.topsort.com/public/v1/catalog-search-service/catalogs/categories', 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/categories",
  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([
    'categories' => [
        [
                'id' => '<string>',
                'name' => '<string>',
                'parentId' => 'CAT-434',
                'path' => 'apparel_and_accessories.clothing.dresses',
                'globalId' => 'CAT-12345',
                'metadata' => [
                                'description' => 'All drinks available in the marketplace.',
                                'globalName' => 'Beers',
                                'path' => 'Driks/Alcoholic/Beers',
                                'showInStore' => true
                ]
        ]
    ]
  ]),
  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/categories"

	payload := strings.NewReader("{\n  \"categories\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"parentId\": \"CAT-434\",\n      \"path\": \"apparel_and_accessories.clothing.dresses\",\n      \"globalId\": \"CAT-12345\",\n      \"metadata\": {\n        \"description\": \"All drinks available in the marketplace.\",\n        \"globalName\": \"Beers\",\n        \"path\": \"Driks/Alcoholic/Beers\",\n        \"showInStore\": true\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/categories")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"categories\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"parentId\": \"CAT-434\",\n      \"path\": \"apparel_and_accessories.clothing.dresses\",\n      \"globalId\": \"CAT-12345\",\n      \"metadata\": {\n        \"description\": \"All drinks available in the marketplace.\",\n        \"globalName\": \"Beers\",\n        \"path\": \"Driks/Alcoholic/Beers\",\n        \"showInStore\": true\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/catalog-search-service/catalogs/categories")

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  \"categories\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"parentId\": \"CAT-434\",\n      \"path\": \"apparel_and_accessories.clothing.dresses\",\n      \"globalId\": \"CAT-12345\",\n      \"metadata\": {\n        \"description\": \"All drinks available in the marketplace.\",\n        \"globalName\": \"Beers\",\n        \"path\": \"Driks/Alcoholic/Beers\",\n        \"showInStore\": true\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

categories · Category · object[] · required

Categories to upsert. New categories will be created, and existing ones will be fully replaced with the provided data.

Required array length: 1 - 500 elements

Show child attributes

Response

204

Successful Response