Upsert Categories

Create or replace one or more categories in the catalog.

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

Try it

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": "bneEmHKG2yUe",
      "globalId": "CAT-12345",
      "metadata": {
        "associatedProducts": 100,
        "description": "All drinks available in the marketplace.",
        "globalName": "Beers",
        "path": "Driks/Alcoholic/Beers",
        "showInStore": true
      }
    }
  ]
}
'

204

{}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

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

categories. id · string · required

Unique ID of the category. Topsort treats IDs as strings, choose any format as long as it is unique within the catalog.

Minimum string length: 1

categories. name · string · required

Category name. Shown in Topsort UI.

Minimum string length: 1

categories. parentId · string | null

ID of the parent category. Each category can have at most one parent category, allowing categories to be organized into hierarchies.

Minimum string length: 1

Example:

"bneEmHKG2yUe"

categories. globalId · string | null

Global ID of the category. This is an optional field that can be used to link the category to other marketplaces.

Example:

"CAT-12345"

categories. metadata · Metadata · object

Additional metadata for the category.

Show child attributes

categories.metadata. {key}

Example:

{
  "associatedProducts": 100,
  "description": "All drinks available in the marketplace.",
  "globalName": "Beers",
  "path": "Driks/Alcoholic/Beers",
  "showInStore": true
}

Response

204

Successful Response