NinjaPipe icon

NinjaPipe

Production-ready NinjaPipe node with one action interface, safer validation, Databin webhook support, and update-friendly UX

Order → List Order

AI-generated

Summary

List orders with optional filters, pagination, and custom field flattening.

Inputs

  • showAdvanced — Toggle display of advanced options such as path override and raw JSON fields.
  • resourcePathOverride — Override the default API path for the resource.
  • returnAll — If true, fetches all pages up to the limit; otherwise only the current page is returned.
  • page — Page number to request (starting at 1).
  • limit — Maximum number of items per page (1‑100).
  • search — General search term applied to the list.
  • statusFilter — Filter orders by status value.
  • ownerFilter — Filter orders by owner identifier.
  • queryParams — Fixed collection of additional query parameters.
  • advancedQueryJson — Raw JSON string of advanced query parameters merged after other filters.
  • flattenCustomFields — If true, copies custom_fields into output and adds cf_* keys.

Output shape

an array of order records

Pagination is controlled by limit, page, and returnAll; the response may be limited to a page unless returnAll is true; optional fields may be omitted.

Examples

Example 1: Retrieve first 10 open orders owned by alice, flattening custom fields.

statusFilter=open&ownerFilter=alice&limit=10&flattenCustomFields=true

Example 2: Iterate through paginated results, fetching page 2 with 20 items per page.

page=2&limit=20&returnAll=false

Example 3: Use a custom endpoint path for the order resource.

resourcePathOverride=/custom/orders&showAdvanced=true

Links

Discussion