Shopware icon

Shopware

Shopware

Actions778

Order Management → Order Delivery State Transition

AI-generated

Overview

This node operation allows transitioning the state of an order delivery within an order management system. It is useful for automating order processing workflows, such as moving an order delivery from 'open' to 'in progress' or other states defined in the system's state machine. For example, it can be used to update the delivery status when an order is shipped or delivered, and optionally send notification emails to customers.

Use Case Examples

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

Properties

Name Meaning
Order Delivery Id Identifier of the order delivery to be transitioned.
Transition The action name of the state machine transition to apply, e.g., 'process' to change the order state from open to in progress. Must be a valid transition for the current state.
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 delivery during the state transition.
Media Ids A list of media identifiers to attach to the order delivery during the state transition.
State Field Name The database column name representing the state in the order delivery table. Usually left as default 'stateId'.
Request Options Additional request settings such as batching, SSL validation, proxy, and timeout configurations.

Output

JSON

  • id - The identifier of the order delivery after the state transition.
  • state - The new state of the order delivery after the transition.
  • success - Indicates whether the state transition was successful.
  • message - Additional information or error messages related to the state transition.

Dependencies

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

Troubleshooting

  • If an invalid transition action name is provided, the node will return an error listing possible valid transitions for the current state. Verify the transition name matches one of the allowed actions.
  • Ensure the 'Order Delivery Id' is correct and exists in the system to avoid not found errors.
  • If emails are not sent despite enabling 'Send Mail', check the email service configuration and permissions in the backend system.
  • Timeout errors may occur if the server is slow to respond; adjust the 'Timeout' request option accordingly.
  • SSL certificate validation errors can be bypassed by enabling 'Ignore SSL Issues', but this should be used cautiously due to security risks.

Discussion