Shopware icon

Shopware

Shopware

Actions778

Order Delivery → Search Order Delivery

AI-generated

Overview

This node performs a search operation on Order Delivery data within the Shopware platform. It allows users to query order delivery records with various parameters such as pagination, filtering, sorting, and field selection. This is useful for retrieving specific order delivery information for reporting, analysis, or integration with other systems.

Use Case Examples

  1. Retrieve the first page of order deliveries with a limit of 20 items per page.
  2. Search order deliveries filtered by a specific status or date range.
  3. Sort order deliveries by delivery date in descending order.
  4. Fetch only specific fields of order deliveries to optimize data transfer.

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 array of filters to restrict the search results based on criteria such as status, date, or other attributes.
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 array of order delivery records returned by the search.
  • total - The total number of order delivery records matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access order delivery 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 search may be slower due to the calculation of the exact total number of hits.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of the security implications.

Links

Discussion