Shopware icon

Shopware

Shopware

Actions778

Cms Slot → Search Cms Slot

AI-generated

Overview

This node performs a search operation on CMS Slots within a Shopware environment. It allows users to query CMS Slots with various parameters such as pagination (page, limit), filtering, sorting, and field selection. This is useful for retrieving specific CMS Slot data based on complex search criteria, for example, fetching CMS Slots that match certain filters or sorting them by specific fields.

Use Case Examples

  1. Retrieve the first page of CMS Slots with a limit of 10 items per page.
  2. Search CMS Slots with specific filters applied, such as slots belonging to a certain category.
  3. Sort CMS Slots by creation date and return 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 criteria.
Sort A JSON array defining the sorting order of the search results.
Post Filter A JSON array of filters applied after aggregations, which do not affect aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON array defining aggregations to perform on the search results.
Grouping A JSON array specifying fields to group the search results by.
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 Slot 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 Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The search results containing the CMS Slot data matching the query.
  • total - The total number of CMS Slots matching the search criteria, if total count mode is enabled.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is correctly formatted.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode may slow down the response time significantly for large datasets.
  • SSL certificate validation errors can be bypassed by enabling 'Ignore SSL Issues' but this is insecure and should be used cautiously.

Links

Discussion