Shopware icon

Shopware

Shopware

Actions778

Customer Wishlist Product → Search Customer Wishlist Product

AI-generated

Overview

This node performs a search operation on Customer Wishlist Products within the Shopware platform. It allows users to query and retrieve wishlist product data based on various criteria such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you want to analyze or display customer wishlist items, for example, in e-commerce analytics, personalized marketing, or inventory management.

Use Case Examples

  1. Retrieve the first page of customer wishlist products with a limit of 20 items per page.
  2. Search customer wishlist products filtered by specific product attributes or customer IDs.
  3. Sort wishlist products by creation date or popularity and include only selected fields in the response.

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 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 customer wishlist products returned by the search.
  • total - The total number of matching wishlist products found.
  • aggregations - Aggregation results if any aggregations were requested.

Dependencies

  • Shopware API credentials

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access customer wishlist product 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 request might be slower 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.

Links

Discussion