Shopware icon

Shopware

Shopware

Actions778

App Shipping Method → Search App Shipping Method

AI-generated

Overview

This node performs a search operation for App Shipping Methods in the Shopware system. It allows users to query shipping methods with various parameters such as pagination, filtering, sorting, and field selection. This is useful for retrieving specific shipping method data based on custom criteria, for example, to display available shipping options in an e-commerce application or to analyze shipping method usage.

Use Case Examples

  1. Retrieve the first page of shipping methods with a limit of 10 items per page.
  2. Search for shipping methods that match specific filter criteria, such as those available in a certain region.
  3. Sort shipping methods by name or price and return only selected fields for performance optimization.

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 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 search results containing the App Shipping Method records matching the query.
  • total - The total number of matching records, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • An API key credential for Shopware Admin API access

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access App Shipping Method data.
  • Validate JSON input for filters, sorting, and other parameters to avoid malformed requests.
  • If the total count mode is set to 'exact', expect slower response times for large datasets.
  • Check network settings if using proxy or if SSL certificate validation is disabled, as these can affect connectivity.

Links

Discussion