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
      }
    }
  ]
}
'

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