RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

The RedStage node for n8n integrates with the Red Stage API, allowing users to perform various operations on resources such as Delivery, Inventory, Log, Order, and Shipment.
For the Delivery → Cancel Delivery operation, this node enables users to cancel a delivery by providing its unique increment ID. This is useful in scenarios where a previously scheduled or created delivery needs to be voided or stopped due to changes in order status, customer requests, or logistical issues.

Example use cases:

  • Automatically canceling deliveries when an order is refunded or canceled.
  • Integrating with customer service workflows to void shipments upon request.
  • Managing logistics exceptions by programmatically stopping certain deliveries.

Properties

Name Type Meaning
Delivery Increment ID String The unique identifier (increment ID) of the delivery you wish to cancel. Required field.

Output

The output will be a JSON object (or array of objects) representing the response from the Red Stage API after attempting to cancel the specified delivery. The structure of this output depends on the API's response, but typically includes fields indicating the success or failure of the cancellation request.

If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output:

[
  {
    "success": true,
    "message": "Delivery cancelled successfully",
    "deliveryId": "123456"
  }
]

Or, in case of error:

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

Note: The actual fields depend on the Red Stage API's response.

Dependencies

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

Troubleshooting

Common Issues:

  • Invalid Delivery Increment ID: If the provided ID does not exist, the API may return an error such as "Delivery not found."
  • Authentication Errors: Missing or incorrect API credentials will result in authentication failures.
  • Unknown Resource/Operation: If the resource or operation is misspelled or unsupported, the node will throw an error like The resource "..." is not known!.

Error Handling:

  • If "Continue On Fail" is enabled, errors are returned in the output as an error field.
  • Otherwise, execution stops and the error is thrown.

How to resolve:

  • Double-check the Delivery Increment ID for accuracy.
  • Ensure that the redStageApi credentials are correctly configured in n8n.
  • Verify that the selected resource and operation match supported values.

Links and References

  • n8n Documentation
  • Consult your Red Stage API documentation for details on expected responses and error codes.

Discussion