Shopware icon

Shopware

Shopware

Actions778

Order Customer → Search Order Customer

AI-generated

Overview

This node operation allows searching for order customers within the Shopware platform. It is useful for retrieving paginated lists of order customers based on various search criteria such as filters, sorting, and specific fields. This operation supports advanced search features including aggregations, groupings, and post-filters, enabling users to perform detailed and customized queries on order customer data. Practical examples include fetching a specific page of order customers, limiting the number of results per page, applying filters to find customers matching certain conditions, and sorting the results by specific fields.

Use Case Examples

  1. Retrieve the first page of order customers with a limit of 20 per page.
  2. Search order customers filtered by a specific attribute, such as customer status or order date.
  3. Sort order customers by their last purchase date in descending order.
  4. Use aggregations to get summarized data about order customers, such as counts by region.

Properties

Name Meaning
Page The page number of the search result to retrieve.
Limit The number of items to return per result page.
Filter A list of filters to restrict the search results based on specific criteria.
Sort Sorting criteria to order the search results.
Post Filter Filters applied without affecting aggregations in the search results.
Associations Associations to include related entities in the search results.
Aggregations Aggregations to perform summarized calculations on the search results.
Grouping Fields to group the search results by.
Fields Specific fields to be returned in the search results.
Total Count Mode Determines how the total number of hits is calculated for the search query. Options include none (disabled), exact (slow but accurate), and next-pages (fast for next page).
Ids List of specific IDs to search for.
Includes Specify fields to be returned for given entities, improving performance by limiting returned data.

Output

JSON

  • data - The search results containing order customer records matching the query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregated data based on the search query, if aggregations are used.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access order customer 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, expect slower response times due to the calculation of the 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 security implications.

Links

Discussion