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

This request returns the known products in the given category. Since API version v16.

Required permission: categories-read

Response:

200 Ok:

The body is a CategoryProductListResponse.

400 Bad Request:

The $CATEGORY_ID parameter is malformed. Returned with TALER_EC_GENERIC_PARAMETER_MALFORMED.

404 Not found:

The category is unknown. Returned with TALER_EC_MERCHANT_GENERIC_CATEGORY_UNKNOWN.

500 Internal Server Error:

The server experienced an internal failure. Returned with TALER_EC_GENERIC_DB_FETCH_FAILED.

Details:

interface CategoryProductListResponse {

  // Name of the category.
  name: string;

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

  // The products in this category.
  products: CategoryProductSummary[];

}

interface CategoryProductSummary {

  // ID of a product in the category.
  product_id: string;

}