Shopware icon

Shopware

Shopware

Actions778

Payment Method → Search Payment Method

AI-generated

Overview

This node operation allows searching for payment methods within the Shopware platform. It is useful for retrieving a list of payment methods based on various search criteria such as pagination, filtering, sorting, and field selection. Practical applications include fetching payment methods for display in an e-commerce admin panel or integrating payment method data into other workflows.

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 to find active or preferred payment options.
  3. Sort payment methods by name or creation date and return only selected fields for performance optimization.

Properties

Name Meaning
Page The page number of the search results to retrieve.
Limit The number of items to return per page in the search results.
Filter A JSON list of filters to restrict the search results based on specific criteria.
Sort A JSON list defining the sorting order of the search results.
Post Filter A JSON list of filters applied after aggregations, not affecting aggregation results.
Associations A JSON object defining related entities to include in the search results.
Aggregations A JSON list defining aggregations to perform on the search results.
Grouping A JSON list specifying fields to group the search results by.
Fields A JSON list of fields to include 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 A JSON list of specific payment method IDs to search for.
Includes A JSON object specifying which fields to return for given entities, used for API-level field filtering.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The array of payment method objects returned from the search.
  • total - The total number of payment methods matching the search criteria.
  • aggregations - Aggregation results if any aggregations were requested in the search.

Dependencies

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

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is well-formed.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results. Verify these values are within valid ranges.
  • Using 'exact' total count mode may slow down the search significantly on large datasets.
  • SSL certificate validation errors can occur if the 'Ignore SSL Issues' option is not enabled when using self-signed certificates.
  • Proxy misconfiguration can prevent the node from connecting to the Shopware API. Verify proxy settings if used.

Links

Discussion