Shopware icon

Shopware

Shopware

Actions778

Cms Block → Search Cms Block

AI-generated

Overview

This node performs a search operation on CMS Blocks within a Shopware environment. It allows users to query CMS Blocks with various parameters such as pagination (page and limit), filtering, sorting, and specifying fields to return. 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 attribute.

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. Return only specific fields of CMS Blocks to optimize data transfer.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of CMS Block items to return per page in the search result.
Filter A JSON array of filters to restrict the search results based on criteria such as field values.
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 specifying aggregations to perform on the search results.
Grouping JSON array to perform groupings over certain fields in the search results.
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 CMS Block IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data at the API level.
Request Options Node-level settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of CMS Block objects returned by the search query.
  • total - The total number of CMS Blocks matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • Requires Shopware API credentials with appropriate permissions to access CMS Block data.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have access to CMS Block resources.
  • 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', expect slower response times due to the calculation of total hits.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion