RedStage icon

RedStage

Consume Red Stage API

Overview

The RedStage node for n8n enables you to interact with the Red Stage API, specifically to create new orders. This node is useful in automation scenarios where you need to programmatically submit order data from various sources (e.g., e-commerce platforms, CRMs, or custom forms) into the Red Stage system. For example, you could use this node to automatically create an order when a customer completes a purchase on your website, or to batch-import orders from a CSV file.

Properties

Name Type Meaning
Firstname String The first name of the person placing the order.
Lastname String The last name of the person placing the order.
Company String The company name associated with the order, if applicable.
Street String The street address for delivery.
City String The city for delivery.
Region String The region or state for delivery.
Postcode String The postal code for delivery.
Country String The country for delivery.
Classification String A classification value for the order, purpose not further specified.
Is Valid ? Boolean Indicates whether the order is valid. Defaults to true.
Telephone String Contact telephone number for the order.
Email String Contact email address for the order.
Use JSON Items Boolean If true, allows specifying order items as a raw JSON array; otherwise, use structured input fields.
JSON Items JSON Raw JSON array of order items. Required if "Use JSON Items" is true. Each item should include SKU, quantity, unit declared value, and unit customs value.
Order Items Fixed Collection Structured list of order items. Used if "Use JSON Items" is false. Each item includes SKU, quantity, optional reference, unit declared value, and unit customs value.
Shipping Methods Options Selects the shipping method for the order from a comprehensive list (e.g., Amazon, FedEx, UPS, USPS, OnTrac, etc.).
Additional Fields Collection Optional extra fields such as store code, unique ID, order reference, custom greeting, note, signature requirements, Saturday delivery, export reason, declared/customs values, priority, dates, etc.

Output

  • The node returns a JSON object (or an array of objects) representing the result of the order creation operation.
  • The structure of the output depends on the response from the Red Stage API, but typically includes details about the created order, such as order ID, status, and any additional information returned by the API.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.

Example output:

[
  {
    "order_id": "12345",
    "status": "created",
    "message": "Order successfully created"
  }
]

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

Dependencies

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

Troubleshooting

  • Common Issues:

    • Invalid or missing credentials: Ensure that the redStageApi credential is correctly configured in n8n.
    • Incorrect property values: Supplying invalid data types or missing required fields (such as order items) may cause the API to reject the request.
    • Unknown resource/operation: If the resource or operation is misspecified, the node will throw an error indicating the resource is not known.
  • Error Messages:

    • "The resource \"<resource>\" is not known!"
      Cause: The selected resource is not supported.
      Resolution: Double-check the resource selection; only "order", "shipment", "delivery", "inventory", and "log" are valid.
    • API-specific errors (e.g., validation errors, authentication failures) will be passed through in the output if "Continue On Fail" is enabled.

Links and References

  • n8n Documentation
  • Red Stage API documentation (contact your Red Stage representative or refer to your organization's developer resources for API details)

Discussion