NinjaPipe icon

NinjaPipe

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

Product → List Product

AI-generated

Summary

List all products with optional pagination, filtering, and query parameters

Inputs

  • showAdvanced — Show path override and raw JSON fields for special cases
  • resourcePathOverride — Only use this if your NinjaPipe workspace exposes a different endpoint path
  • returnAll — If true, fetch all pages instead of a single page
  • page — Page number to retrieve (starting at 1)
  • limit — Maximum number of items per page (1‑100)
  • search — Keyword or phrase to search within products
  • statusFilter — Filter products by their status value
  • ownerFilter — Filter products by the owner identifier
  • queryParams — Collection of query parameters; each entry defines a field name, type and value
  • advancedQueryJson — Optional raw query parameters merged after other filters
  • flattenCustomFields — When true, copies custom fields into the output and adds cf_* keys

Output shape

an array of product objects

If returnAll is true all pages are concatenated; otherwise only the requested page (up to limit) is returned. Fields may be flattened according to flattenCustomFields setting.

Examples

Example 1: List first page of products with default settings

resource=Product, operation=List Product, limit=20, page=1

Example 2: Retrieve all products matching a keyword

resource=Product, operation=List Product, search='widget', returnAll=true, limit=100

Example 3: List products from a custom endpoint path

resource=Product, operation=List Product, resourcePathOverride='/api/v1/products'

Links

Discussion