Actions32
- Analytics Actions
- Batch Actions
- Customer Actions
- Order Actions
- Product Actions
- Purchase Actions
- Raw Request Actions
- System Actions
- Vendor Actions
- WhatsApp Actions
Batch → List Batches
AI-generatedSummary
Lists batch (stock lot) records from a VitePOS site via GET /wp-json/vtab/v1/batches, with filters for product, outlet, availability, global outlet, archived status, and pagination.
Inputs
- productId — Only sent as product_id when non-empty; restricts batches to one product.
- outletId — Only sent as outlet_id when non-empty; restricts batches to one outlet.
- availableOnly — Sent as available_only=1/0. Default true, so only batches with available stock are returned.
- includeGlobal — Sent as include_global=1/0. Default true; includes global-outlet batches alongside the chosen outlet.
- includeArchived — Sent as include_archived=1/0. Default false.
- batchLimit — Sent as limit (page size). Default 200.
- batchPage — Sent as page. Default 1. Use it to fetch later pages. Run the node again with a higher value to page through results.
Output shape
One output item per input item. Its JSON is the bridge API response, with a human-readable response string added at the top.
For List Batches the
responsestring is the generic 'Batch request completed.' (the batch summary text applies only to the Status operation). The batch rows come from the API response and their exact shape isn't defined in this node. If the API reports status/success false,responseholds its message. If continue-on-fail is enabled, a failed item returns {error}. Requires the viteposBridgeApi credential (site URL).
Examples
Example 1: Fetch all in-stock batches for one product at a given outlet
Product ID=123, Outlet ID=2, Available Only=true, Include Global Outlet=true, Limit=200, Page=1
Example 2: Audit every batch including depleted and archived ones
Available Only=false, Include Archived=true, Limit=200; increment Page to continue