Skip to content
Topsort Documentation
API

Upsert Categories

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

Upsert categories.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Request Body

application/json
object
categories
required

The categories to create or substitute.

Array<object>
>= 1 items <= 500 items

A category is a division for products within a marketplace catalog. Categories may be organized into hierarchies.

object
id
required

The category ID. If there is no ID for categories in the marketplace, this can be the category name as long as it is unique.

string
>= 1 characters
name
required

The category name.

string
>= 1 characters
parentId

The ID of the parent category. This model assumes each category can at most one parent category. In this example, bneEmHKG2yUe could be a reference to the Beers category.

string
>= 1 characters

Responses

Successful Response