Shopware icon

Shopware

Shopware

Actions778

Category → Search Category

AI-generated

Overview

This node performs a search operation on the 'Category' resource within the Shopware platform. It allows users to query categories with various parameters such as pagination (page and limit), filtering, sorting, and grouping. The node supports advanced search features including post-filters, aggregations, and specifying which fields to return. This is useful for scenarios where you need to retrieve and manipulate category data from a Shopware store, for example, to display categories on a website or to analyze category data.

Use Case Examples

  1. Retrieve a paginated list of categories with a limit of 10 items per page.
  2. Search categories with specific filters applied, such as categories belonging to a certain parent category.
  3. Sort categories by name or creation date.
  4. Use aggregations to get summary data about categories, such as counts by type.

Properties

Name Meaning
Page The page number of the search results to retrieve, used for pagination.
Limit The number of items to return per page in the search results.
Filter A JSON array of filters to restrict the search results based on specific criteria.
Sort A JSON array defining the sorting order of the search results.
Post Filter Filters applied after aggregations that do not affect the aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array specifying aggregations to perform on the search results.
Grouping A JSON array defining fields to group the search results by.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total number of hits is calculated: none (disabled), exact (slow), or next-pages (fast).
Ids A JSON array of specific category IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data.
Request Options Additional request settings such as batching, SSL certificate validation, proxy, and timeout.

Output

JSON

  • data - The search results containing the list of categories matching the query.
  • total - The total number of categories found matching the search criteria, if total count mode is enabled.

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access category data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the request might be slow for large datasets.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion