Shopware icon

Shopware

Read, update, write and delete data from Shopware

Category → Get

AI-generated

Summary

Retrieve a specific category from a Shopware store by its ID, optionally specifying which fields to return.

Inputs

  • Category ID (required) — The unique identifier of the category to retrieve, found in the category's URL in Shopware Admin.
  • Filters — Specify which fields of the category to return as a comma-separated string; by default, all fields are returned.

Output shape

a JSON object representing the requested category with fields as specified or all fields if not specified

Returns the full details of the single category identified by the given ID. The 'fields' filter can limit the returned properties to improve efficiency.

Examples

Example 1: Get a category with all its details by its ID

Set 'Category ID' to the category's ID; leave 'Filters.fields' empty to retrieve all fields.

Example 2: Get only the name and description fields of a category

Set 'Category ID' to the category's ID; set 'Filters.fields' to 'name,description'.

Discussion