Shopware icon

Shopware

Shopware

Actions778

Order Line Item → Search Order Line Item

AI-generated

Overview

This node performs a search operation on Order Line Items within the Shopware platform. It allows users to query order line items with various filters, sorting options, pagination, and other advanced search parameters. This is useful for scenarios where you need to retrieve specific order line items based on complex criteria, such as filtering by product attributes, sorting by date, or limiting the number of results per page.

Use Case Examples

  1. Retrieve all order line items for a specific order with pagination.
  2. Search order line items filtered by product ID and sorted by price.
  3. Get aggregated data on order line items grouped by product category.

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 A JSON array of filters applied after aggregations, which do not affect aggregation results.
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 fields to group the search results by.
Fields A JSON array specifying which fields should be returned in the search results.
Total Count Mode Option to determine how the total count of hits is calculated: none (disabled), exact (slow but accurate), or next-pages (fast for next page counts).
Ids A JSON array of specific IDs to search for.
Includes A 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 validation, proxy, and timeout.

Output

JSON

  • data - The search results containing the order line items matching the query.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times due to the calculation overhead.
  • Check network settings if using proxy or if SSL validation is disabled, as misconfiguration can cause request failures.
  • Verify that the Shopware API credentials are valid and have sufficient permissions to perform search operations.

Links

Discussion