Shopware icon

Shopware

Shopware

Actions778

Main Category → Search Main Category

AI-generated

Overview

This node performs a search operation on the 'Main Category' resource in a Shopware system. It allows users to query main categories with various parameters such as pagination (page, limit), filtering, sorting, and aggregations. This is useful for retrieving categorized data from a Shopware store, for example, to display categories on a website or to analyze category data programmatically.

Use Case Examples

  1. Retrieve the first page of main categories with a limit of 10 items per page.
  2. Search main categories with specific filters to find categories matching certain criteria.
  3. Sort main categories by a specific field and apply aggregations to get summarized data.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result.
Filter A JSON array of filters to restrict the search results based on specific conditions.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array defining aggregation operations to perform on the search results.
Grouping A JSON array specifying 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 but accurate), or next-pages (fast for next page only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data fields.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The search results containing main category data returned from the Shopware API.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is correctly formatted.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode may slow down the response time significantly.
  • Network issues or incorrect API credentials can cause authentication or connection errors.

Links

Discussion