Shopware icon

Shopware

Shopware

Actions778

Cms Page → Search Cms Page

AI-generated

Overview

This node operation allows searching for CMS Pages within the Shopware platform. It supports pagination, filtering, sorting, and various advanced search query options to tailor the search results. This is useful for retrieving specific CMS pages based on criteria such as page number, limit of results per page, filters, sorting order, and more. For example, it can be used to fetch a list of CMS pages that match certain filters or to paginate through CMS pages in a Shopware store.

Use Case Examples

  1. Retrieve the first page of CMS pages with a limit of 10 items per page.
  2. Search CMS pages with specific filters applied to narrow down results.
  3. Sort CMS pages by a particular field and apply grouping or aggregations for advanced data analysis.

Properties

Name Meaning
Page The page number of the search result to retrieve.
Limit The number of items to return per result page.
Filter A list of filters to restrict the search results, allowing precise control over which CMS pages are returned.
Sort Defines the sorting order of the search results.
Post Filter Filters applied without affecting aggregations, used to refine search results post aggregation.
Associations Defines associations to include in the search results, allowing related entities to be fetched.
Aggregations Defines aggregations to perform on the search results for summary or grouped data.
Grouping Specifies groupings over certain fields in the search results.
Fields Specifies which fields should be returned in the search results.
Total Count Mode Determines how the total number of hits is calculated for the search query, with options for none, exact, or next-pages.
Ids A list of specific CMS page IDs to search for.
Includes Specifies fields to be returned for given entities, allowing fine control over the returned data.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - The main search result data containing the CMS pages matching the query.
  • total - The total number of CMS pages matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregated data based on the search query, if aggregations are used.

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 CMS pages.
  • Verify that the JSON input for filters, sorting, and other advanced search parameters is correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', be aware that the query might be slower due to the exact count calculation.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion