Shopware icon

Shopware

Shopware

Actions778

App Administration Snippet → Search App Administration Snippet

AI-generated

Overview

This node performs a search operation on the App Administration Snippet resource in Shopware. It allows users to query snippets with various parameters such as pagination (page, limit), filtering, sorting, and aggregation. This is useful for retrieving specific snippets or sets of snippets based on complex search criteria, which can be applied in scenarios like managing localized content or customizing app snippets in Shopware.

Use Case Examples

  1. Retrieve the first page of snippets with a limit of 10 items per page.
  2. Search snippets with specific filters to find those matching certain criteria.
  3. Sort snippets by a particular field and apply aggregations to analyze snippet data.

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 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 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 defining 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).
Ids JSON array of specific snippet 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 Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of snippet objects returned from the search query.
  • total - The total number of snippets matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the specified aggregation parameters.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access the App Administration Snippet resource.
  • 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 might be slow depending on the dataset size.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion