Shopware icon

Shopware

Shopware

Actions778

Product Visibility → Search Product Visibility

AI-generated

Overview

This node performs a search operation on Product Visibility data within the Shopware platform. It allows users to query product visibility records with various parameters such as pagination, filtering, sorting, and field selection. This is useful for scenarios where you need to retrieve specific product visibility information based on complex search criteria, for example, to display product availability on different sales channels or to analyze visibility settings across products.

Use Case Examples

  1. Retrieve the first page of product visibility records with a limit of 20 items per page.
  2. Search product visibility with specific filters to find products visible in a particular sales channel.
  3. Sort product visibility results by a certain field and include only selected fields in the output.

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 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 only).
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.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • data - The main search result data containing product visibility records.
  • total - The total number of matching product visibility records found.
  • aggregations - Aggregation results if any aggregations were requested.

Dependencies

  • Requires Shopware API credentials for authentication.

Troubleshooting

  • Ensure the Shopware API credentials are correctly configured and have the necessary permissions to access product visibility 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 slow for large datasets.
  • Check network settings such as proxy and SSL options if requests fail due to connectivity issues.

Links

Discussion