Shopware icon

Shopware

Shopware

Actions778

Sales Channel Type → Search Sales Channel Type

AI-generated

Overview

This node operation allows searching for Sales Channel Types in the Shopware system. It supports detailed search queries with pagination, filtering, sorting, and field selection, enabling users to retrieve specific sales channel type data efficiently. This is useful for scenarios where you need to list or analyze sales channel types based on various criteria, such as filtering by attributes or sorting by specific fields.

Use Case Examples

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

Properties

Name Meaning
Page The page number of the search result to retrieve.
Limit The number of items to return per page in the search result.
Filter A list of filters to restrict the search results based on specific criteria.
Sort Sorting criteria to order the search results.
Post Filter Filters applied without affecting aggregations in the search results.
Associations Associations to include in the search query to fetch related entities.
Aggregations Aggregations to perform on the search results for summary data.
Grouping Fields to group the search results by.
Fields Specific fields to be returned in the search results.
Total Count Mode Determines 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 calculation).
Ids List of specific IDs to search for.
Includes Specifies fields to be returned for given entities, allowing fine control over the response content.

Output

JSON

  • data - The array of sales channel type objects returned from the search.
  • total - The total number of sales channel types matching the search criteria.
  • aggregations - Aggregated data based on the search query, if any aggregations were requested.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have the necessary permissions to access sales channel type 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 query might be slower due to the calculation of the total number of hits.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion