Shopware icon

Shopware

Shopware

Actions778

Product Stream Filter → Create Product Stream Filter

AI-generated

Overview

This node operation creates a new Product Stream Filter in the Shopware system. It is useful for users who want to programmatically add filters to product streams, enabling dynamic and automated product categorization or filtering based on various criteria. For example, an e-commerce manager can use this node to add filters that segment products by type, price, or custom attributes to tailor product listings for different sales channels or marketing campaigns.

Use Case Examples

  1. Creating a filter to include only products of a certain type in a product stream.
  2. Adding a filter that targets products with specific custom fields for a promotional campaign.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the product stream filter.
Product Stream Id Identifier of the product stream to which the filter belongs.
Parent Id Identifier of the parent filter, if this filter is nested.
Type Type of the filter.
Field Field on which the filter operates.
Operator Operator used in the filter condition.
Value Value used in the filter condition.
Parameters Additional parameters for the filter in JSON format.
Position Position of the filter in the product stream filter list.
Custom Fields Custom fields associated with the filter in JSON format.
Created At Timestamp when the filter was created.
Updated At Timestamp when the filter was last updated.
Product Stream JSON object representing the product stream details associated with the filter.
Parent JSON object representing the parent filter details.
Queries JSON array representing queries related to the filter.
Request Options Settings for request behavior such as batching, SSL handling, proxy, and timeout.

Output

JSON

  • id - Unique identifier of the created product stream filter.
  • productStreamId - Identifier of the product stream to which the filter belongs.
  • parentId - Identifier of the parent filter if nested.
  • type - Type of the filter.
  • field - Field on which the filter operates.
  • operator - Operator used in the filter condition.
  • value - Value used in the filter condition.
  • parameters - Additional parameters for the filter.
  • position - Position of the filter in the list.
  • customFields - Custom fields associated with the filter.
  • createdAt - Creation timestamp.
  • updatedAt - Last update timestamp.
  • productStream - Details of the associated product stream.
  • parent - Details of the parent filter.
  • queries - Queries related to the filter.

Dependencies

  • An API key credential for Shopware Admin API authentication.

Troubleshooting

  • Ensure all required fields (Id, Product Stream Id, Type) are provided to avoid validation errors.
  • Check the JSON format for fields like Parameters, Custom Fields, Product Stream, Parent, and Queries to prevent parsing errors.
  • Verify API credentials and endpoint URL to avoid authentication or connection issues.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option or check the SSL certificate validity.
  • Use the batching options to manage large data sets and avoid request throttling or timeouts.

Discussion