Shopware icon

Shopware

Shopware

Actions778

Product Export → Search Product Export

AI-generated

Overview

This node performs a search operation on Product Exports within the Shopware platform. It allows users to query product export data with various parameters such as pagination (page and limit), filtering, sorting, and grouping. This is useful for retrieving specific product export records based on complex search criteria, which can be applied in scenarios like data analysis, reporting, or integration workflows where product export data needs to be fetched programmatically.

Use Case Examples

  1. Retrieve the first page of product exports with a limit of 20 items per page.
  2. Search product exports filtered by specific criteria such as date range or status.
  3. Sort product exports by creation date in descending order.
  4. Apply aggregations and groupings to analyze product export data.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result, controlling the page size.
Filter A JSON array of filters to restrict the search results based on specific conditions.
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 aggregation operations to perform on the search results.
Grouping A JSON array defining fields over which to perform groupings 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: none (disabled), exact (slow but accurate), or next-pages (fast for next page only).
Ids A JSON array of specific IDs to search for within the product exports.
Includes A JSON object specifying which fields should be included for given entities, used to control the returned data structure.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy configuration, and timeout.

Output

JSON

  • data - The main search result data containing the product export records.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access product export 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 may be slow for large datasets.
  • Check network settings such as proxy and SSL options if requests fail or time out.

Links

Discussion