RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

The RedStage node for n8n enables interaction with the Red Stage API, specifically targeting the "Delivery" resource and its "Labels" operation. This node is designed to generate or manage delivery labels based on a provided Delivery Increment ID and optional label data fields. It is useful in automated workflows where you need to programmatically handle shipping labels, such as printing package labels, retrieving address information for deliveries, or integrating with logistics systems.

Practical examples:

  • Automatically generating shipping labels for new orders.
  • Retrieving destination or origin address labels for delivery tracking.
  • Integrating with warehouse management systems to print package labels.

Properties

Name Type Meaning
Delivery Increment ID String The unique identifier for the delivery whose labels are being managed or generated.
Additional Fields Collection Optional extra parameters for the label operation.
└─ Label Data Multi-Options Specifies which types of label data to include (Packages, Destination Address, Origin Address).

Output

The output is a JSON object (or array of objects) representing the result of the "Labels" operation for the specified delivery. The structure of the output depends on the response from the Red Stage API, but typically includes details about the generated or retrieved labels. If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.

Example output:

[
  {
    "labelId": "12345",
    "deliveryId": "DEL-001",
    "labels": [
      {
        "type": "package",
        "content": "Base64EncodedLabelData"
      }
    ]
  }
]

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

If binary data (such as PDF label files) is returned, it will be included in the output as a binary property.

Dependencies

  • External Service: Requires access to the Red Stage API.
  • API Key/Credentials: Needs valid redStageApi credentials configured in n8n.
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

  • Common Issues:

    • Invalid Delivery Increment ID: If the provided ID does not exist, the API may return an error.
    • Missing Required Fields: Omitting the Delivery Increment ID will cause the node to fail.
    • Unknown Resource/Operation: If the resource or operation is misspelled or unsupported, an error will be thrown.

  • Error Messages:

    • "The resource \"<resource>\" is not known!"
      Resolution: Ensure the resource name is exactly "delivery".
    • API-specific errors (e.g., authentication failures, invalid parameters) will appear in the error field if "Continue On Fail" is enabled.

Links and References

  • n8n Documentation
  • Red Stage API documentation: (Contact your Red Stage administrator or refer to internal docs for API specifics.)

Discussion