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 "Delivery" resource. The "Search Delivery" operation enables users to search for delivery records using various filters, sorting options, and pagination controls. This is useful in scenarios where you need to retrieve a list of deliveries based on specific criteria, such as status, date, or other attributes.

Practical examples:

  • Retrieve all deliveries with a specific status (e.g., delivered, pending).
  • Fetch the most recent deliveries by sorting by date.
  • Paginate through large sets of delivery data for reporting or integration purposes.

Properties

Name Type Meaning
Additional Fields Collection A group of optional fields to refine your search. Includes the following sub-fields:
  JSON Search Filter JSON Allows advanced filtering using a JSON object, e.g., { "status": { "eq": 1 } }.
  Sort Field String The field name to sort results by.
  Sort Direction Options Choose between "Ascending" or "Descending" order for sorting.
  Page Number The page number to retrieve (minimum value: 1).
  Limit Number Maximum number of results per page (min: 1, max: 100).

Output

  • The output is an array of JSON objects, each representing a delivery record matching the search criteria.
  • If an error occurs and "Continue On Fail" is enabled, the output will include an object with an error property containing the error message.
  • No binary data is produced by this operation.

Example output:

[
  {
    "id": 123,
    "status": "delivered",
    "date": "2024-06-01T12:00:00Z",
    // ...other delivery fields
  },
  {
    "id": 124,
    "status": "pending",
    "date": "2024-06-02T09:30:00Z"
    // ...other delivery fields
  }
]

Dependencies

  • External Service: Requires access to the Red Stage API.
  • Credentials: You must configure the redStageApi credential in n8n for authentication.

Troubleshooting

  • Common Issues:

    • Invalid Resource/Operation: If the resource or operation is misspecified, the node will throw an error like:
      "The resource \"<resource>\" is not known!"
      Ensure you select the correct resource and operation.
    • API Authentication Errors: If credentials are missing or incorrect, API requests will fail. Double-check your redStageApi credentials.
    • Malformed JSON in Filters: If the "JSON Search Filter" is not valid JSON, the request may fail. Always use proper JSON syntax.

  • Error Handling:

    • If "Continue On Fail" is enabled, errors for individual items will be returned in the output as { "error": "<message>" }.
    • Otherwise, the workflow execution will stop on the first error.

Links and References

  • n8n Documentation
  • Consult your Red Stage API documentation for details on available fields and filter formats.

Discussion