RedStage icon

RedStage

Consume Red Stage API

Overview

The RedStage node for n8n allows you to interact with the Red Stage API, specifically targeting various resources such as Shipment, Order, Delivery, Inventory, and Log.
For the Shipment resource with the Info Shipment operation, this node retrieves detailed information about a specific shipment using its unique identifier.

Common scenarios:

  • Fetching shipment details by ID for tracking or auditing purposes.
  • Integrating shipment status into automated workflows.
  • Triggering downstream actions based on shipment information.

Example use case:
You might use this node in an order fulfillment workflow to look up the current status and details of a shipment after it has been dispatched, using the shipment's unique ID.


Properties

Name Type Meaning
Shipment Unique ID String The unique identifier for the shipment whose information you want to retrieve. This is required.

Output

  • The output will be a JSON object (or array of objects) containing the shipment information as returned by the Red Stage API.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output:

[
  {
    "shipment_id": "12345",
    "status": "Delivered",
    "recipient": "John Doe",
    "address": "123 Main St, City, Country",
    // ...other shipment fields
  }
]

Note: The exact structure depends on the Red Stage API response.


Dependencies

  • External Service: Requires access to the Red Stage API.
  • Credentials: You must configure the redStageApi credential in n8n for authentication.

Troubleshooting

Common issues:

  • Invalid or missing Shipment Unique ID: Ensure the provided ID exists and is correct.
  • Authentication errors: Make sure your redStageApi credentials are set up properly in n8n.
  • Unknown resource/operation: If the resource or operation name is incorrect, the node will throw an error like:
    • "The resource \"<name>\" is not known!"

Error handling:

  • If "Continue On Fail" is enabled, errors will be included in the output under an error property instead of stopping the workflow.

Links and References

  • n8n Documentation
  • (If available) Red Stage API documentation – consult your Red Stage provider for API reference.

Discussion