RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

The "RedStage" node for n8n allows you to interact with the Red Stage API, specifically to manage orders. The "Cancel Order" operation enables users to cancel an existing order by providing its unique ID and optional cancellation parameters. This is useful in scenarios where an order needs to be voided due to customer request, inventory issues, or other business reasons. For example, if a customer changes their mind after placing an order, or if items are no longer available, this node can automate the cancellation process.

Properties

Name Type Meaning
Order Unique ID String The unique identifier of the order to be canceled.
Additional Fields Collection A set of optional parameters to customize the cancellation:
- Backordered Items Boolean If enabled, attempts to cancel backordered items; if all items are backordered, cancels the entire order.
- Unfulfilled Items Boolean Cancels items that have not yet been added to a shipment for picking, including backordered items.
- All Items Boolean Attempts to cancel the entire order, subject to store configuration if the order is processing or complete.
- Cancellation Request Boolean Sends a cancellation request instead of directly canceling the order.
- Field to Show JSON Specifies which fields should be included in the response (e.g., ["*", "shipping_address"]).

Output

  • The output is a JSON object (or array of objects) representing the result of the cancellation request.
  • The structure of the output depends on the fields specified in "Field to Show". By default, it may include order details such as status, affected items, and shipping address.
  • If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.

Example output:

[
  {
    "order_id": "12345",
    "status": "cancelled",
    "shipping_address": { /* ... */ }
  }
]

Or, in case of error:

[
  {
    "error": "Order not found"
  }
]

Dependencies

  • External Service: Requires access to the Red Stage API.
  • Credentials: Must configure the redStageApi credential in n8n.
  • Environment: No additional environment variables are required beyond standard n8n setup.

Troubleshooting

  • Common Issues:

    • Invalid Order Unique ID: If the provided order ID does not exist, the node will return an error message such as "Order not found".
    • Insufficient Permissions: If the API credentials lack permission to cancel orders, the operation will fail.
    • Store Configuration Restrictions: Some orders cannot be canceled depending on their state and store settings (e.g., completed orders).
    • Incorrect Field Names in "Field to Show": Specifying invalid fields may result in incomplete or empty responses.

  • Error Handling:

    • If "Continue On Fail" is enabled, errors are returned in the output as an error field.
    • Otherwise, the workflow execution will stop on error.

Links and References

Discussion