Shopware icon

Shopware

Shopware

Actions778

Promotion Sales Channel → Search Promotion Sales Channel

AI-generated

Overview

This node performs a search operation on the Promotion Sales Channel resource in the Shopware system. It allows users to query promotion sales channels with various parameters such as pagination (page and limit), filtering, sorting, and grouping. This is useful for retrieving specific promotion sales channel data based on complex search criteria, which can be applied in scenarios like marketing analysis, sales reporting, or dynamic promotion management.

Use Case Examples

  1. Retrieve the first page of promotion sales channels with a limit of 10 items per page.
  2. Search promotion sales channels filtered by specific criteria such as active status or date range.
  3. Sort promotion sales channels by creation date or name.
  4. Apply aggregations and groupings to analyze promotion sales channel data.

Properties

Name Meaning
Page The page number of the search result to retrieve, used for pagination.
Limit The number of items to return per page in the search result.
Filter A JSON array of filters to restrict the search results based on specific conditions.
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 fields to group the search results by.
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 only).
Ids JSON array of specific IDs to search for.
Includes JSON object specifying fields to include for given entities, used to control returned data at the API level.
Request Options Node-level settings for request behavior such as batching, SSL validation, proxy, and timeout.

Output

JSON

  • data - The search results containing promotion sales channel records matching the query.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access promotion sales channel 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', expect slower response times for large datasets; consider using 'next-pages' or 'none' for performance.
  • Check network settings if using proxy or if SSL validation issues occur, especially when 'Ignore SSL Issues' is disabled.

Links

Discussion