VitePOS Bridge icon

VitePOS Bridge

Use VitePOS automation bridge and analytics APIs

Order → List Orders

AI-generated

Summary

Lists orders from a VitePOS site by sending a GET request to the bridge's /wp-json/vtab/v1/orders endpoint. Every filter is optional and is passed as a query-string parameter.

Inputs

  • Order Filters (collection) — Holds all filters. Only the ones you add are sent, and empty values are skipped.
  • Status — Order status string, for example completed,processing,vt_served.
  • Date From / Date To — Date range filter. Values are trimmed to YYYY-MM-DD, so any time of day is dropped.
  • Customer ID, Customer Search, Email, Phone, Billing Email, Billing Phone, First Name, Last Name — Customer filters. Customer Search matches billing name, email, phone or registered display name.
  • Product ID, Variation ID, Product SKU, Product Search — Line-item filters. Product Search matches line item names.
  • External ID — Filters by the external ID stored on the order.
  • Include IDs — Comma-separated order IDs to restrict the results to.
  • Include Items — Boolean, sent as include_items=1 or 0. Asks the bridge to include line items in each row.
  • Include Batch Data — Boolean, sent as include_batch_data=1 or 0. Asks the bridge to include batch data.
  • Order By / Order — Sort by date, id, modified or total. Direction is asc or desc. The UI defaults are date and desc.
  • Page / Per Page — Pagination. The UI defaults are page 1 and 50 per page.

Output shape

One output item per input item. It holds the bridge's JSON response, usually with a rowdata array of orders and a records total, plus a response field with a short readable summary.

The response text reads like 'Order list returned N rows out of M.' and can name up to 3 orders with customer and matched line items. If the API response already has a response key, the original is placed under raw. Each call returns a single page, so use Page and Per Page to fetch more. With Continue On Fail enabled, errors become {error: message} items.

Examples

Example 1: Fetch yesterday's completed orders with their line items

Resource Order, Operation List Orders. Order Filters: Status=completed, Date From and Date To set to yesterday, Include Items=true.

Example 2: Find orders containing a given product for a customer

Order Filters: Product Search=Maxi, Customer Search=John, Order By=total, Order=desc.

Example 3: Page through all orders

Order Filters: Per Page=100, Page=2 (increase Page in a loop).

Links

Discussion