RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

This node interacts with the Red Stage API, specifically targeting the "Delivery" resource and performing the "Void Delivery" operation. It is designed to void (cancel) a delivery based on its unique increment ID. This can be useful in scenarios where a previously scheduled or processed delivery needs to be invalidated due to errors, customer requests, or logistical changes.

Practical Example:
If an e-commerce order's shipment was created by mistake or needs to be stopped before dispatch, this node allows you to void that delivery programmatically within your n8n workflow.

Properties

Name Type Meaning
Delivery Increment ID String The unique identifier for the delivery you wish to void. Required to target the correct delivery record.

Output

The output will be a JSON object (or array of objects) representing the response from the Red Stage API after attempting to void the specified delivery. The exact structure depends on the API's response, but typically includes status information and possibly details about the voided delivery.

  • If the operation is successful, the output contains the API's confirmation of the void action.
  • If there is an error and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output:

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

Or, in case of error:

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

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 will likely return an error such as "Delivery not found."
    • Authentication Errors: If credentials are missing or incorrect, you may see errors related to authorization.
    • Unknown Resource/Operation: If the resource or operation parameters are set incorrectly, the node will throw an error like The resource "X" is not known!.

  • Error Handling:

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

Links and References

  • n8n Documentation
  • Consult your Red Stage API documentation for specific details on the "void delivery" endpoint and expected responses.

Discussion