Shopware icon

Shopware

Shopware

Actions778

Sales Channel → Search Sales Channel

AI-generated

Overview

This node operation allows searching for sales channels within the Shopware platform. It supports detailed search queries with pagination, filtering, sorting, and other advanced search options. This is useful for retrieving specific sales channel data based on various criteria, such as filtering by attributes, sorting results, and controlling the number of results per page.

Use Case Examples

  1. Retrieve the first page of sales channels with a limit of 10 items per page.
  2. Search sales channels with specific filters applied to narrow down results.
  3. Sort sales channels by a particular field and include only selected fields in the response.

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 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 for the search query. Options include none (disabled), exact (slow but accurate), and 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 the API-level response fields.
Request Options Node-level settings for request behavior such as batching, SSL certificate validation, proxy, and timeout.

Output

JSON

  • response - The JSON response from the Shopware API containing the search results for sales channels.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access sales channel data.
  • Verify that JSON inputs for filters, sorting, and other parameters are correctly formatted to avoid parsing errors.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity issues.
  • If the total count mode is set to exact, expect slower response times for large datasets.

Links

Discussion