Shopware icon

Shopware

Shopware

Actions778

Sales Channel Domain → Search Sales Channel Domain

AI-generated

Overview

This node operation allows searching for Sales Channel Domains 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 domain 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 a list of sales channel domains filtered by a specific attribute, such as domain name or language.
  2. Paginate through sales channel domain results to process or display them in batches.
  3. Sort sales channel domains by creation date or other fields to analyze recent additions.

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: none (disabled), exact (slow but accurate), or next-pages (fast for next page).
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 fields.
Request Options Settings for request behavior such as batching, SSL certificate validation, proxy usage, and timeout.

Output

JSON

  • data - The main search result data containing the sales channel domain records matching the query.
  • total - The total number of hits matching the search criteria, if total count mode is enabled.
  • aggregations - Aggregation results if aggregations were requested in the search query.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Invalid JSON in filter, sort, post-filter, associations, aggregations, grouping, fields, ids, or includes properties can cause request failures. Ensure JSON is well-formed.
  • Incorrect pagination values (page or limit) may result in empty or incomplete results.
  • Using 'exact' total count mode may slow down the response time significantly for large datasets.
  • SSL certificate validation errors can be bypassed by enabling 'Ignore SSL Issues' but this is insecure and should be used cautiously.

Links

Discussion