Shopware icon

Shopware

Shopware

Actions778

Order Management → Order State Transition

AI-generated

Overview

This node operation allows transitioning the state of an order within an order management system. It is useful for automating order workflows, such as moving an order from 'open' to 'in progress' or other states defined in the system's state machine. For example, it can be used to programmatically update order status after payment confirmation or shipment.

Use Case Examples

  1. Transition an order state from 'open' to 'in progress' by specifying the order ID and the transition action name 'process'.
  2. Send a notification email to the customer when the order state changes by enabling the 'Send Mail' option.
  3. Attach relevant documents or media to the order during the state transition by providing their IDs.

Properties

Name Meaning
Order Id Identifier of the order to be transitioned.
Transition The action name of the state machine transition to apply to the order, e.g., 'process' to change the order state from open to in progress.
Send Mail Controls whether an email should be sent to the customer upon state transition.
Document Ids A list of document identifiers to attach to the order during the transition.
Media Ids A list of media identifiers to attach to the order during the transition.
State Field Name The database column name representing the order state; usually 'stateId' and typically does not need to be changed.
Request Options Additional request settings such as batching, SSL validation, proxy, and timeout configurations.

Output

JSON

  • orderId - The identifier of the order that was transitioned.
  • transition - The transition action applied to the order state.
  • sendMail - Indicates if a mail was sent to the customer.
  • documentIds - List of document IDs attached during the transition.
  • mediaIds - List of media IDs attached during the transition.
  • stateFieldName - The state field name used in the order database table.

Dependencies

  • Requires API authentication credentials to connect to the order management system's backend.

Troubleshooting

  • If an invalid transition is specified, the node will throw an error listing possible valid transitions for the current order state. Verify the transition action name is correct and applicable.
  • Ensure the order ID is valid and exists in the system to avoid errors.
  • If emails are not sent despite enabling 'Send Mail', check the email service configuration and permissions.
  • If attaching documents or media fails, verify the provided IDs are correct and accessible.

Discussion