Shopware icon

Shopware

Shopware

Actions778

Import Export Profile → Search Import Export Profile

AI-generated

Overview

This node operation allows searching for Import Export Profiles within the Shopware platform. It is useful for retrieving profiles based on various search criteria such as pagination, filtering, sorting, and field selection. Practical applications include managing data import/export configurations, automating profile retrieval for integration workflows, and customizing data handling processes.

Use Case Examples

  1. Retrieve a paginated list of import export profiles with specific filters applied.
  2. Sort import export profiles by creation date and limit the number of results per page.
  3. Fetch only certain fields of import export profiles to optimize data processing.

Properties

Name Meaning
Page The page number of the search results to retrieve.
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, not affecting 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: none (disabled), exact (slow but accurate), or next-pages (fast for next page only).
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, optimizing API-level field stripping.

Output

JSON

  • data - The array of Import Export Profile objects returned by the search.
  • total - The total number of matching Import Export Profiles found.
  • aggregations - Aggregation results based on the search query, if any.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access Import Export Profiles.
  • 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 for large datasets; consider using 'next-pages' or 'none' for performance.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion