GET [/instances/$INSTANCE]/private/categories

This request returns the known product categories and the number of products in each category. Since API version v16.

Required permission: categories-read

Response:

200 Ok:

The body is a CategoryListResponse.

Details:

interface CategoryListResponse {

  // Array with all of the categories we know.
  categories: CategoryListEntry[];

}

interface CategoryListEntry {

  // Unique number for the category.
  category_id: Integer;

  // Name of the category.
  name: string;

  // Translations of the name into various
  // languages.
  name_i18n?: { [lang_tag: string]: string };

  // Number of products in this category.
  // A product can be in more than one category.
  product_count: Integer;

}