RedStage icon

RedStage

Consume Red Stage API

Actions20

Overview

The RedStage node for n8n allows you to interact with the Red Stage API, specifically targeting the "Order" resource. The Search Order operation enables users to search for orders using various filters, sorting options, and field selection. This is useful in scenarios where you need to retrieve a list of orders based on specific criteria, such as order status, customer details, or date ranges.

Practical examples:

  • Retrieve all orders with a specific status (e.g., pending, shipped).
  • Fetch only certain fields (like shipping address) for each order.
  • Paginate through large sets of orders.
  • Sort orders by creation date or other fields.

Properties

Name Type Meaning
Additional Fields collection A group of optional parameters to refine your search. See below for sub-fields.
└ Field to Show json Specify which fields should be included in the response (e.g., ["*", "shipping_address"]).
└ JSON Search Filter json JSON object specifying filter conditions (e.g., { "status": { "eq": 1 } }).
└ Sort Field string The field name to sort results by.
└ Sort Direction options Choose ascending (asc) or descending (desc) sort order.
└ Page number The page number to retrieve (minimum: 1).
└ Limit number Maximum number of results to return per page (1–100, default: 50).

Output

The output is an array of JSON objects, each representing an order that matches the search criteria. The structure of each order object depends on the fields selected via "Field to Show". Typical fields may include:

{
  "order_id": "...",
  "customer_name": "...",
  "status": "...",
  "shipping_address": { ... },
  ...
}

If an error occurs and "Continue On Fail" is enabled, the output will include an object like:

{
  "error": "Error message here"
}

Dependencies

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

Troubleshooting

Common Issues:

  • Invalid Resource/Operation: If the resource or operation is not recognized, the node will throw an error indicating the unknown resource.
  • API Authentication Errors: Ensure that the redStageApi credentials are correctly configured.
  • Malformed Filters: Incorrect JSON in "JSON Search Filter" or "Field to Show" can cause errors. Always provide valid JSON.
  • Pagination Limits: Setting "Limit" outside the allowed range (1–100) may result in errors or unexpected behavior.

Error Messages:

  • "The resource \"...\" is not known!"
    Cause: An unsupported resource was selected.
    Solution: Choose a valid resource from the dropdown.
  • "Cannot read property ..."
    Cause: Likely due to malformed input or missing required fields.
    Solution: Double-check your input values and ensure all required fields are set.

Links and References

Discussion