Shopware icon

Shopware

Shopware

Actions778

Cms Section → Search Cms Section

AI-generated

Overview

This node operation performs a search query on CMS Sections within a Shopware environment. It allows users to retrieve CMS Section data based on various search parameters such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you need to programmatically access or analyze CMS content sections, for example, to display specific CMS sections on a website or to integrate CMS data with other systems.

Use Case Examples

  1. Retrieve the first page of CMS Sections with a limit of 10 items per page.
  2. Search CMS Sections with specific filters to find sections matching certain criteria.
  3. Sort CMS Sections by a particular field and retrieve only selected fields for performance optimization.

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 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 groupings over certain fields in the search results.
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 CMS Section IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data at the API level.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

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

Dependencies

  • An API key credential for Shopware Admin API authentication

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access CMS Section 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 query may be slow for large datasets.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion