Shopware icon

Shopware

Shopware

Actions778

Customer Wishlist → Search Customer Wishlist

AI-generated

Overview

This node operation allows searching the Customer Wishlist resource in the Shopware system. It supports detailed search queries with pagination, filtering, sorting, and other advanced search options. This is useful for retrieving specific customer wishlist data based on various criteria, such as filtering by fields, sorting results, and controlling the number of items per page. Practical examples include fetching wishlists for a particular customer, filtering wishlists by product attributes, or sorting wishlists by creation date.

Use Case Examples

  1. Retrieve the first page of customer wishlists with a limit of 10 items per page.
  2. Search customer wishlists filtered by a specific product ID or customer ID.
  3. Sort customer wishlists by the date they were created in descending order.

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 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 for the search query. Options include none (disabled), exact (slow but accurate), and next-pages (fast for next page only).
Ids A JSON array of specific IDs to search for in the customer wishlists.
Includes A JSON object specifying which fields should be returned for given entities, used to control the response payload.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout duration.

Output

JSON

  • data - The search results containing customer wishlist entries matching the query.
  • total - The total number of matching customer wishlist entries, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search query.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure JSON inputs for filters, sorting, and other advanced options 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 exact total number of hits.
  • Verify that the Shopware API URL and credentials are correctly configured to avoid authentication errors.
  • If using proxy or ignoring SSL issues, ensure these settings are correctly applied to prevent connection failures.

Links

Discussion