Shopware Admin icon

Shopware Admin

Consume Shopware Admin API

Actions10

Overview

This node integrates with the Shopware Admin API to manage various resources such as orders, products, and customers. Specifically, for the Order resource with the Update State operation, it allows users to change the status of an existing order by transitioning it to a new state like "in progress," "completed," "cancelled," or "open."

Common scenarios where this node is beneficial include:

  • Automating order processing workflows by programmatically updating order statuses.
  • Integrating order management with other systems, e.g., marking orders as completed after shipment.
  • Handling cancellations or reopens based on external triggers or business logic.

Example: Automatically set an order's status to "completed" once payment confirmation is received from a payment gateway.

Properties

Name Meaning
Transition The new state to transition the order to. Options:
- Process: Set order status to "in progress"
- Complete: Set order status to "completed"
- Cancel: Set order status to "cancelled"
- Reopen: Set order status to "open"

Output

The node outputs JSON data representing the response from the Shopware Admin API after attempting to update the order state. This typically includes details about the updated order or confirmation of the state change.

If an error occurs during execution, the output will contain an error object with a message describing the issue.

The node does not output binary data.

Dependencies

  • Requires connection to the Shopware Admin API.
  • Needs an API authentication credential configured in n8n (an API key or token) to authorize requests.
  • The base URL for the Shopware API must be provided via the credential configuration.

Troubleshooting

  • Common issues:

    • Invalid or missing order ID: Ensure the order ID provided exists in Shopware.
    • Insufficient permissions: Verify that the API credentials have rights to update order states.
    • Network or connectivity problems: Check API endpoint accessibility and network settings.
  • Error messages:

    • "Unknown error": Generic fallback if the API response is unexpected; check API logs and credentials.
    • API-specific errors returned in the response body will be passed through; review these messages for guidance.
  • Resolution tips:

    • Double-check the order ID and transition value.
    • Confirm API credentials are valid and have necessary scopes.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch operations.

Links and References

Discussion