Shopware icon

Shopware

Shopware

Actions778

App Cms Block → Search App Cms Block

AI-generated

Overview

This node performs a search operation on the 'App Cms Block' resource within the Shopware system. It allows users to query CMS blocks with various parameters such as pagination (page, limit), filtering, sorting, and aggregation. This is useful for retrieving specific CMS blocks based on complex search criteria, for example, fetching CMS blocks that match certain filters or sorting them by a particular field.

Use Case Examples

  1. Retrieve the first page of CMS blocks with a limit of 10 items per page.
  2. Search CMS blocks with specific filters applied, such as blocks created after a certain date.
  3. Sort CMS blocks by name or creation date.
  4. Use aggregations to get grouped data about CMS blocks.

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 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 JSON object defining related entities to include in the search results.
Aggregations JSON array defining aggregations to perform on the search results.
Grouping JSON array specifying fields to group the search results by.
Fields 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 JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data at the API level.

Output

JSON

  • total - Total number of search hits matching the query.
  • elements - Array of CMS block objects returned by the search.
  • aggregations - Aggregation results if any aggregations were requested.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access the App Cms Block resource.
  • Validate JSON input for filters, sorting, and other JSON properties to avoid parsing errors.
  • If pagination parameters (page, limit) are set incorrectly, the search may return no results or unexpected results.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion