RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

The RedStage node for n8n enables integration with the Red Stage API, specifically allowing you to update an existing delivery. This operation is useful in scenarios where you need to modify the contents or metadata of a delivery after it has been created—such as adding/removing items, updating tracking information, or changing delivery status. Practical examples include synchronizing warehouse management systems, automating order fulfillment updates, or integrating shipping workflows.

Properties

Name Type Meaning
Delivery Increment ID String The unique identifier (increment ID) of the delivery to be updated.
Use JSON Items Boolean Determines whether to provide item changes as raw JSON or via structured fields.
JSON Add Items JSON List of items (as JSON array) to add to the delivery. Used if "Use JSON Items" is true.
JSON Remove Items JSON List of items (as JSON array) to remove from the delivery. Used if "Use JSON Items" is true.
Delivery Add Items Fixed Collection Structured list of items to add (SKU and quantity). Used if "Use JSON Items" is false.
Delivery Remove Items Fixed Collection Structured list of items to remove (SKU and quantity). Used if "Use JSON Items" is false.
Additional Fields Collection Optional extra properties to update on the delivery, such as state, status, comments, tracking numbers, etc.

Additional Fields (selected options)

  • Delivery ID: Internal delivery ID (number).
  • Warehouse ID: Internal warehouse ID (number).
  • Increment ID: The "Increment ID" property (number).
  • State: Delivery state (options: Canceled, Complete, Holded, New, Pending Commit, Processing, Putting Away).
  • Status: Delivery status (multiple options).
  • Progress: Progress percentage (0–100).
  • Sender Name: Name of the sender.
  • Carrier Name: Name of the carrier.
  • Comments: Any comments related to the delivery.
  • Tracking Numbers: Array of tracking numbers (JSON).
  • Total Product Weight: Total weight of products.
  • Total Product Weight Unit: Unit for total product weight.
  • Special Requirements: Special requirements for the delivery.
  • Num Labels: Number of labels.
  • Total Skus: Total number of SKUs.

Output

  • The output is a JSON object (or array of objects) representing the updated delivery as returned by the Red Stage API.
  • If an error occurs and "Continue On Fail" is enabled, the output will contain an error field with the error message.
  • No binary data is produced by this operation.

Example Output

[
  {
    "delivery_id": 123,
    "increment_id": "DEL-0001",
    "state": "processing",
    "status": "accepted",
    "items": [
      { "sku": "product1", "qty": 2 },
      { "sku": "product2", "qty": 1 }
    ],
    "tracking_numbers": ["TRACK123"],
    // ...other fields
  }
]

Dependencies

  • External Service: Requires access to the Red Stage API.
  • API Credentials: You must configure the redStageApi credential in n8n.
  • Environment: Ensure network access to the Red Stage API endpoint.

Troubleshooting

  • Common Issues:

    • Invalid Increment ID: If the provided Delivery Increment ID does not exist, the API may return an error.
    • Malformed JSON: When using JSON input for items, ensure the JSON is valid and matches the expected structure.
    • Missing Required Fields: Omitting required fields like Delivery Increment ID will result in errors.
    • Permission Denied: Incorrect or missing API credentials will prevent successful requests.

  • Error Messages:

    • "The resource \"delivery\" is not known!": Indicates an invalid resource selection; ensure "Delivery" is chosen.
    • error: <message> in output: If "Continue On Fail" is enabled, errors are returned in the output array under the error key.

Links and References

Discussion