Shopware icon

Shopware

Shopware

Actions778

Order Management → Order Transaction State Transition

AI-generated

Overview

This node operation handles the state transition of an order transaction within an order management system. It allows users to change the state of an order transaction by specifying the transition action name, such as moving the order from 'open' to 'in progress'. This is useful in workflows where order processing stages need to be updated programmatically, for example, when an order moves through different processing steps or when notifying customers about order status changes.

Use Case Examples

  1. Transition an order transaction state from 'open' to 'in progress' by specifying the 'process' transition action.
  2. Send an email notification to the customer when the order transaction state changes.
  3. Attach relevant documents or media to the order transaction during the state transition.

Properties

Name Meaning
Order Transaction Id Identifier of the order transaction to be transitioned.
Transition The action name of the state machine transition to apply to the order transaction, e.g., 'process' to change the 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 transaction during the transition.
Media Ids A list of media identifiers to attach to the order transaction during the transition.
State Field Name The database column name representing the state in the order transaction table; usually left as default.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings.

Output

JSON

  • orderTransactionId - The identifier of the order transaction that was transitioned.
  • transition - The transition action applied to the order transaction.
  • sendMail - Indicates if an email 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 transition.

Dependencies

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

Troubleshooting

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

Discussion