Ploomes CRMInstall

Summary

Retrieves order stage records from the Ploomes CRM API (GET https://api2.ploomes.com/Orders@Stages) using OData query options ($top, $skip, $select, $orderby, $filter, $expand), with optional in-memory caching. Returns one n8n item per stage.

Inputs

• $top (Limit) — Maximum records to return. Defaults to 1, so raise it to get more than one stage. Minimum 1.
• $skip (Offset) — Number of records to skip, for paging. Default 0.
• $select (Fields) — Comma-separated fields to return. Defaults to "Id", so only the Id is returned unless you add fields such as Id,Name.
• $orderby (Sort) — Sort field with optional asc/desc. Default "Id".
• Use Filter Builder — Default true. Switches between the visual filter builders and a raw $filter string.
• $filter (Raw) — Raw OData $filter expression, e.g. Id eq 123. Shown and used only when Use Filter Builder is off.
• Filter Conditions — Builder rows with field, operator (eq, ne, gt, ge, lt, le, contains, startswith, endswith), value, value type (auto, string, number, boolean, date, null) and an AND/OR connector to the next row.
• Custom Property Filters — Filter on custom field values (OtherProperties) by field ID, value property, operator and value. Rows are joined with AND and ANDed with the other filters.
• Navigation Property Filters — Filter on navigation properties, either collection (Prop/any(...)) or direct (Prop/Field). Rows combine with AND/OR and are ANDed with the main filter.
• Use Expand Builder — Default true. Switches between the visual expand builder and a raw $expand string.
• $expand (Raw) — Raw OData $expand expression. Used only when Use Expand Builder is off.
• Expand Relations — Navigation properties to expand, each with an optional nested $select, nested $filter and nested $expand.
• Expand Nested Filters — Visual nested filter conditions that attach to an expansion by matching its property name in Expand Relations. They are ANDed with any manual nested filter.
• Cache Strategy — Disabled (default), Cache First (serve a valid cached response without calling the API) or Fallback Only (always call the API and use the cache only if the request fails).
• Cache TTL (Seconds) — Cache lifetime in seconds. Default 300. Shown only when caching is enabled.

Output shape

A list of items on the Success output, one per order stage record. If the API response has a value array, each element becomes an item. Otherwise the whole response becomes a single item.

The node has three outputs: Success, Error and Timeout. Failures yield an item with error, statusCode, isTimeout, resource, operation and timestamp. HTTP 408/504 go to Timeout and do not stop the workflow. Other errors go to Error and stop the workflow unless Continue On Fail is set. Items served from cache carry _fromCache: true, and cache served after a failed request also carries _fallback: true. Because $top defaults to 1 and $select defaults to "Id", output is minimal until you change them. There is no automatic pagination, so use $skip and $top to page. The cache lives in n8n process memory and is keyed by URL and query string.

Examples

Example 1: List all order stages with their names, sorted by name.

$top = 100, $select = "Id,Name", $orderby = "Name asc", no filters.

Example 2: Look up a specific order stage by name.

$top = 1, $select = "Id,Name", Filter Conditions: Name eq "Approved" (Value Type String).

Example 3: Repeatedly resolve stage IDs in a high-volume workflow without hitting the API each time.

$top = 100, $select = "Id,Name", Cache Strategy = Cache First, Cache TTL = 600.

Links

• n8n community nodes installation guide