Shopware icon

Shopware

Shopware

Actions778

Flow → Update Flow

AI-generated

Overview

This node operation updates an existing Flow in the Shopware system. It allows users to modify various attributes of a Flow such as its identifier, name, event name, priority, status (active or invalid), description, custom fields, sequences, and associated app flow event data. This operation is useful for managing and maintaining workflow automations or event-driven processes within Shopware, enabling users to keep their flows up-to-date with changing business requirements.

Use Case Examples

  1. Updating the name and priority of a flow to reflect new business logic.
  2. Changing the active status of a flow to disable or enable it without deleting.
  3. Modifying the sequences or custom fields of a flow to adjust its behavior in response to specific events.

Properties

Name Meaning
Id Identifier for the flow, required to specify which flow to update.
Response Data format for the response, used to specify how the response should be returned.
Name The new name for the flow.
Event Name The event name associated with the flow.
Priority The priority level of the flow, influencing its execution order.
Invalid Boolean flag indicating if the flow is invalid.
Active Boolean flag indicating if the flow is active.
Description Description of the flow.
Custom Fields Custom JSON fields for additional flow data.
App Flow Event Id Identifier for the associated app flow event.
Created At Timestamp of when the flow was created.
Updated At Timestamp of the last update to the flow.
Sequences JSON array representing the sequences within the flow.
App Flow Event JSON object representing the app flow event details associated with the flow.

Output

JSON

  • id - Identifier of the updated flow.
  • name - Name of the updated flow.
  • eventName - Event name associated with the updated flow.
  • priority - Priority level of the updated flow.
  • invalid - Indicates if the updated flow is invalid.
  • active - Indicates if the updated flow is active.
  • description - Description of the updated flow.
  • customFields - Custom fields data of the updated flow.
  • appFlowEventId - Identifier of the associated app flow event.
  • createdAt - Creation timestamp of the updated flow.
  • updatedAt - Last update timestamp of the updated flow.
  • sequences - Sequences data of the updated flow.
  • appFlowEvent - App flow event details of the updated flow.

Dependencies

  • An API key credential for Shopware Admin API

Troubleshooting

  • Ensure the 'Id' property is correctly set to the flow you want to update; otherwise, the update will fail.
  • Verify that the JSON format for 'Custom Fields', 'Sequences', and 'App Flow Event' is valid to avoid parsing errors.
  • Check API credentials and permissions to ensure the node can successfully authenticate and update flows.
  • If the response format is not as expected, verify the '_response' property and API endpoint compatibility.

Discussion