Actions9
Product → Get Many
AI-generatedSummary
Retrieve a paginated list of products with optional filters and extra fields
Inputs
- additionalFields — Add extra fields to the response (e.g., brand, category)
- page — Page number for pagination (0-based)
- size — Number of items per page
- approved — Filter by approval status
- archived — Include archived products
- brandIds — List products with the specified brand ID (comma-separated)
- barcode — Query a specific barcode
- stockCode — Filter by supplier's stock code
- startDate — Get products created after this timestamp (GMT)
- endDate — Get products created before this timestamp (GMT)
- dateQueryType — Date field for filtering, either CREATED_DATE or LAST_MODIFIED_DATE
- supplierId — Filter by supplier ID
- productMainId — Filter by supplier's product main ID
- onSale — List products currently on sale
- rejected — List rejected products
- blacklisted — List blacklisted products
Output shape
list of product records
Pagination is controlled by page and size; optional filters may reduce results; response contains the items array; no additional metadata is returned; errors are propagated as failures
Examples
Example 1: Fetch the first page of products with 20 items per page, include brand filter and on-sale flag
additionalFields: {page:0, size:20, brandIds:"123", onSale:true}
Example 2: Get products created between two dates using CREATED_DATE filter
startDate:"2023-01-01", endDate:"2023-12-31", dateQueryType:"CREATED_DATE"
Example 3: Retrieve products matching a specific barcode
barcode:"1234567890"