RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

The RedStage node for n8n enables integration with the Red Stage API, specifically allowing users to create new delivery records. The "Create Delivery" operation under the "Delivery" resource is designed to submit detailed delivery information, including items, types, and additional metadata, to the Red Stage backend.

Common scenarios:

  • Automating the creation of delivery records in Red Stage from other systems (e.g., e-commerce platforms, ERPs).
  • Batch processing or synchronizing deliveries based on external triggers.
  • Integrating warehouse management workflows with Red Stage.

Practical example:
When a new order is fulfilled in your e-commerce system, you can use this node to automatically create a corresponding delivery record in Red Stage, specifying the items, quantities, and relevant shipment details.

Properties

Name Type Meaning
Delivery Type options Specifies the type of delivery: ASN, RMA, or Other.
Use JSON Items boolean If true, allows input of delivery items as a raw JSON array; otherwise, use structured fields.
JSON Items json Raw JSON array of items ([{ "sku": "...", "qty": ... }, ...]). Used if "Use JSON Items" is true.
Delivery Items fixedCollection Structured list of items, each with SKU and Quantity. Used if "Use JSON Items" is false.
Additional Fields collection Optional extra properties for the delivery, such as IDs, state, status, sender/carrier info, comments, tracking numbers, weights, special requirements, labels, and total SKUs. See below for details.

Additional Fields sub-properties:

  • Delivery ID (number): Internal delivery identifier.
  • Warehouse ID (number): Internal warehouse identifier.
  • Increment ID (number): Incremental identifier.
  • State (options): Delivery state (e.g., New, Processing, Complete, etc.).
  • Status (options): Delivery status (e.g., Accepted, Canceled, Processed, etc.).
  • Progress (number): Progress percentage (0–100).
  • Sender Name (string): Name of the sender.
  • Carrier Name (string): Name of the carrier.
  • Comments (string): Any comments about the delivery.
  • Tracking Numbers (json): Array of tracking numbers (e.g., ["abc", "def"]).
  • Total Product Weight (number): Total weight of products.
  • Total Product Weight Unit (string): Unit of measure for product weight.
  • Special Requirements (string): Any special requirements for the delivery.
  • Num Labels (number): Number of labels required.
  • Total Skus (number): Total number of SKUs in the delivery.

Output

The node returns an array of JSON objects representing the result of the delivery creation request(s). The structure of each output object depends on the Red Stage API response, but typically includes:

  • Confirmation of the created delivery.
  • Echoed data of the submitted delivery.
  • Any error messages if the operation failed (if "Continue On Fail" is enabled).

Example output:

[
  {
    "delivery_id": 123,
    "status": "new",
    "items": [
      { "sku": "product1", "qty": 1 }
    ],
    // ...other fields returned by the API
  }
]

If an error occurs and "Continue On Fail" is enabled:

[
  {
    "error": "Detailed error message from API"
  }
]

Note: The node does not output binary data.

Dependencies

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

Troubleshooting

Common issues:

  • Invalid credentials: Ensure that the redStageApi credential is correctly set up in n8n.
  • Malformed item data: If using "JSON Items," ensure the JSON is valid and matches the expected schema.
  • Missing required fields: Make sure all required fields (like items) are provided.
  • Unknown resource/operation: If the resource or operation is misspelled or unsupported, the node will throw an error.

Error messages:

  • "The resource \"...\" is not known!"
    Cause: An invalid resource name was specified.
    Resolution: Double-check the selected resource.
  • API error messages (from Red Stage):
    Cause: Issues like validation errors, missing fields, or server problems.
    Resolution: Review the error message, check your input data, and consult the Red Stage API documentation.

Links and References

Discussion