Shopware icon

Shopware

Shopware

Actions778

Number Range Sales Channel → Search Number Range Sales Channel

AI-generated

Overview

This node performs a search operation on the 'Number Range Sales Channel' resource in the Shopware system. It allows users to query and retrieve paginated search results with various filtering, sorting, and grouping options. This is useful for scenarios where you need to fetch specific number range sales channel data based on complex search criteria, such as filtering by attributes, sorting results, or limiting the fields returned.

Use Case Examples

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

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 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 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 for the search query, with options 'none', 'exact', and 'next-pages'.
Ids A JSON array of specific IDs to search for.
Includes A JSON object specifying fields to include for given entities, used to control returned data at the API level.

Output

JSON

  • data - The array of number range sales channel records returned by the search.
  • total - The total number of records matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results based on the search query, if aggregations are specified.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access the Number Range Sales Channel resource.
  • 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 exact total number of hits.
  • Check network connectivity and proxy settings if requests fail or time out.

Links

Discussion