Shopware icon

Shopware

Shopware

Actions778

App Action Button → Search App Action Button

AI-generated

Overview

This node operation allows searching for App Action Buttons within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific sets of App Action Buttons based on various criteria. This is useful for scenarios where you need to programmatically access or analyze App Action Buttons, such as in custom integrations, reporting, or automation workflows.

Use Case Examples

  1. Retrieve the first page of App Action Buttons with a limit of 10 items per page.
  2. Search for App Action Buttons filtered by specific criteria using JSON filters.
  3. Sort App Action Buttons by a particular field and return only selected fields in the response.

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 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 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 IDs to search for.
Includes A JSON object specifying fields to include for given entities, optimizing the returned data.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • data - The array of App Action Button objects returned from the search query.
  • total - The total number of App Action Buttons matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations were requested.

Dependencies

  • An API key credential for authenticating with the Shopware Admin API.

Troubleshooting

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

Links

Discussion