RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

The RedStage node for n8n allows you to interact with the Red Stage API, specifically to update an existing order. The "Update Order" operation enables users to modify details of an order by providing its unique identifier and any fields that need updating (such as customer information, shipping method, or additional metadata). This is useful in scenarios where order details change after creation—such as correcting addresses, updating contact info, or changing shipping preferences.

Practical examples:

  • Correcting a customer's address after an order is placed.
  • Changing the shipping method before fulfillment.
  • Adding internal notes or custom greetings to an order.
  • Updating priority or delivery instructions for time-sensitive shipments.

Properties

Name Type Meaning
Order Unique ID String The unique identifier for the order to be updated. Required to specify which order to modify.
Firstname String Customer's first name associated with the order.
Lastname String Customer's last name associated with the order.
Company String Company name for the order's recipient.
Street String Street address for delivery.
City String City for the delivery address.
Region String State, province, or region for the delivery address.
Postcode String Postal or ZIP code for the delivery address.
Country String Country for the delivery address.
Classification String Classification or type of the order.
Is Valid ? Boolean Indicates if the order is valid. Used for validation purposes.
Telephone String Contact telephone number for the order.
Email String Contact email address for the order.
Shipping Methods Options Selects the shipping method for the order from a comprehensive list (e.g., Amazon, FedEx, UPS, USPS, OnTrac, Cheapest options, etc.).
Additional Fields Collection A set of optional fields for further customization, including:
- Store Code
- Unique ID (optional override)
- Order Ref
- Custom Greeting
- Note
- Signature Required
- Saturday Delivery
- Reason for Export
- Declared Value Service
- Declared Value
- Customs Value
- Overbox
- Priority
- Requested Ship Date
- Delayed Ship Date
- Desired Delivery Date
- Hold Indefinitely

Output

The node returns a JSON object (or array of objects) representing the updated order as received from the Red Stage API. The structure of this output depends on the API response but typically includes all relevant order fields after the update.

  • If the operation succeeds, the output will contain the updated order data.
  • 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",
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "shipping_method": "fedex_FEDEX_2_DAY",
    // ...other updated fields...
  }
]

If binary data is ever returned (not typical for this operation), it would represent files or documents related to the order.

Dependencies

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

Troubleshooting

Common Issues:

  • Missing or Invalid Order Unique ID: If the "Order Unique ID" is missing or incorrect, the API will not know which order to update and may return an error.
  • Invalid Field Values: Providing values in the wrong format (e.g., invalid date strings, unsupported shipping methods) can cause the API to reject the request.
  • Authentication Errors: If the redStageApi credentials are not set up correctly, requests will fail with authentication errors.

Error Messages:

  • "The resource \"order\" is not known!"
    • Cause: The resource parameter is set incorrectly.
    • Solution: Ensure "Order" is selected as the resource.
  • "Order not found" or similar (from API):
    • Cause: The provided Order Unique ID does not match any existing order.
    • Solution: Double-check the unique ID.
  • "Field X is required" (from API):
    • Cause: A required field is missing.
    • Solution: Provide all mandatory fields as per API documentation.

Links and References

Discussion