Shopware icon

Shopware

Shopware

Actions778

Landing Page → Search Landing Page

AI-generated

Overview

This node performs a search operation on Landing Pages within the Shopware platform. It allows users to query landing pages with various parameters such as pagination, filtering, sorting, and field selection. This is useful for retrieving specific landing page data based on complex search criteria, for example, fetching landing pages that match certain filters or sorting them by specific attributes.

Use Case Examples

  1. Retrieve the first page of landing pages with a limit of 10 items per page.
  2. Search landing pages with specific filters applied, such as filtering by category or status.
  3. Sort landing pages by creation date or name.
  4. Select only certain fields to be returned in the search results to optimize performance.

Properties

Name Meaning
Page The page number of the search results 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 exact count), or next-pages (fast count for next pages).
Ids JSON array of specific landing page 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 settings.

Output

JSON

  • data - The search results containing landing page data matching the query.
  • total - The total number of landing pages matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

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 landing page 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 request might be slower due to the calculation of the exact total number of hits.
  • Check network settings if using proxy or if SSL certificate validation issues occur, especially if 'Ignore SSL Issues' is disabled.

Links

Discussion