GET
/
public
/
v1
/
catalog-search-service
/
catalogs
/
categories
/
{category-id}
Get Category
curl --request GET \
  --url https://api.topsort.com/public/v1/catalog-search-service/catalogs/categories/{category-id} \
  --header 'Authorization: Bearer <token>'
{
  "globalId": "CAT-12345",
  "id": "ahEDqV5uhjj8",
  "metadata": {
    "associatedProducts": 100,
    "description": "All drinks available in the marketplace.",
    "globalName": "Beers",
    "path": "Driks/Alcoholic/Beers",
    "showInStore": true
  },
  "name": "Beers/Belgian",
  "parentId": "bneEmHKG2yUe"
}

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI.

Path Parameters

category-id
string
required

ID of the category.

Minimum length: 1

Response

Successful Response

Categories provide a way to organize your catalog.

Products always belong to at least one category, but can belong to more. Categories can be organized into hierarchies.

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 length: 1
Example:

"ahEDqV5uhjj8"

name
string
required

Category name. Shown in Topsort UI.

Minimum length: 1
Example:

"Beers/Belgian"

globalId
string

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

Example:

"CAT-12345"

metadata
object

Additional metadata for the category.

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

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

Minimum length: 1
Example:

"bneEmHKG2yUe"