Shopware icon

Shopware

Shopware

Actions778

Flow → Create Flow

AI-generated

Overview

This node operation allows users to create a new Flow in the Shopware system. It is useful for automating and managing event-driven workflows within Shopware, such as triggering actions based on specific events or conditions. For example, a user can create a flow to automate notifications or updates when an order is placed or a customer registers.

Use Case Examples

  1. Creating a flow to automate email notifications when a new customer signs up.
  2. Setting up a flow to update inventory levels automatically after a sale.

Properties

Name Meaning
Response Data format for the response, either basic or detailed.
Id Unique identifier for the flow to be created.
Name Name of the flow.
Event Name Name of the event that triggers the flow.
Priority Priority level of the flow.
Invalid Indicates if the flow is invalid.
Active Indicates if the flow is active.
Description Description of the flow.
Custom Fields Custom fields in JSON format for additional flow data.
App Flow Event Id Identifier for the associated app flow event.
Created At Timestamp when the flow was created.
Updated At Timestamp when the flow was last updated.
Sequences JSON structure defining the sequences within the flow.
App Flow Event JSON structure defining the app flow event details.
Request Options Settings for request behavior such as batching, SSL handling, proxy, and timeout.

Output

JSON

  • id - Unique identifier of the created flow.
  • name - Name of the created flow.
  • eventName - Event name that triggers the flow.
  • priority - Priority of the flow.
  • invalid - Indicates if the flow is invalid.
  • active - Indicates if the flow is active.
  • description - Description of the flow.
  • customFields - Custom fields associated with the flow.
  • appFlowEventId - Identifier for the associated app flow event.
  • createdAt - Creation timestamp of the flow.
  • updatedAt - Last update timestamp of the flow.
  • sequences - Sequences defined within the flow.
  • appFlowEvent - Details of the app flow event.

Dependencies

  • Shopware API with appropriate credentials

Troubleshooting

  • Ensure all required fields (Id, Name, Event Name) are provided to avoid validation errors.
  • Check API credentials and endpoint URL if authentication errors occur.
  • Verify JSON format for customFields, sequences, and appFlowEvent to prevent parsing errors.
  • Adjust request options like timeout and proxy settings if network issues arise.

Discussion