Shopware icon

Shopware

Shopware

Actions778

App Payment Method → Search App Payment Method

AI-generated

Overview

This node performs a search operation for App Payment Methods in the Shopware system. It allows users to query and retrieve payment method data with various customizable parameters such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you need to fetch specific payment method details or lists based on certain criteria, for example, retrieving all active payment methods or filtering by specific attributes.

Use Case Examples

  1. Retrieve the first page of payment methods with a limit of 10 items per page.
  2. Search payment methods with specific filters applied, such as filtering by status or type.
  3. Sort payment methods by name or creation date.
  4. Select specific fields to be returned in the search results to optimize data usage.

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 specifying aggregations to perform on the search results.
Grouping JSON array to perform 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 for the search query. Options include none (disabled), exact (slow but accurate), and next-pages (fast for next page calculation).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to be returned for given entities, used to control the data returned at the API level.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • data - The search results containing the list of App Payment Methods matching the query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

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

Links

Discussion