Shopware icon

Shopware

Shopware

Actions778

Order → Search Order

AI-generated

Overview

This node performs a search operation for orders in the Shopware system. It allows users to specify various parameters to filter, sort, and paginate the search results, making it useful for retrieving specific order data based on complex criteria. Common scenarios include fetching orders for reporting, monitoring order statuses, or integrating order data into other workflows.

Use Case Examples

  1. Retrieve the first page of orders with a limit of 20 items per page.
  2. Search for orders with specific filters such as date range or customer ID.
  3. Sort orders by creation date or total amount.
  4. Use aggregations to get summarized data about orders.

Properties

Name Meaning
Page The page number of the search result to retrieve.
Limit The number of items to return per page in the search result.
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 A JSON array of filters applied after aggregations, not affecting them.
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).
Ids A JSON array of specific order IDs to search for.
Includes A JSON object specifying fields to be returned for given entities, used to strip fields at the API level.
Request Options Settings for batching, SSL certificate validation, proxy usage, and request timeout.

Output

JSON

  • orders - The list of orders returned by the search query.
  • total - The total number of orders matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregated data based on the search query, if aggregations are used.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the JSON input for filters, sort, post-filter, associations, aggregations, grouping, fields, ids, and includes is correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times due to the calculation of the exact total number of hits.
  • Check network settings such as proxy and SSL options if requests fail or time out.
  • Verify that the Shopware API URL and credentials are correctly configured in the node settings.

Links

Discussion