Shopware icon

Shopware

Shopware

Actions778

Import Export File → Search Import Export File

AI-generated

Overview

This node performs a search operation on Import Export Files within the Shopware platform. It allows users to query and retrieve import/export file data based on various criteria such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you need to programmatically access and analyze import/export file records, for example, to automate data processing or reporting workflows.

Use Case Examples

  1. Retrieve a specific page of import/export files with a limit on the number of items per page.
  2. Filter import/export files based on specific attributes or conditions.
  3. Sort the search results by certain fields to organize the output.
  4. Select specific fields to be returned in the search results to optimize data handling.

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 be returned for given entities, used to control API-level field stripping.
Request Options Node-level settings for batching, SSL certificate validation, proxy usage, and request timeout.

Output

JSON

  • data - The search results containing the import/export file records matching the query criteria.
  • total - The total number of matching records found, depending on the total count mode.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the JSON input for filters, sorting, and other JSON properties is correctly formatted to avoid parsing errors.
  • If the total count mode is set to 'exact', expect slower response times for large datasets.
  • Verify that the API credentials and base URL are correctly configured to avoid authentication or connection errors.
  • If using proxy or SSL options, ensure they are correctly set to prevent request failures.

Links

Discussion