VitePOS BridgeInstall

Summary

Lists customers from a VitePOS site by sending a GET request to the bridge's /wp-json/vtab/v1/customers endpoint. Optional filters narrow and sort the results, and the response is paginated.

Inputs

• Customer Filters — Optional collection of filters. Only the filters you add are sent as query parameters, and empty values are skipped. Available filters: Email, External ID, Customer Name (matches first, last, display or billing name, email, or phone), First Name, Last Name, Phone, Search (general search across name, email, login, billing name, and phone), Include IDs (comma-separated, e.g. 12,34,56), Role (default 'all'; use 'all' for VitePOS customers stored as WordPress subscribers), Order (asc/desc), Order By (registered, display_name, email, id, login), Page, and Per Page. The UI defaults are page 1, per page 50, order desc, order by registered. These apply only if you add the filter. Otherwise the server's defaults apply.

Output shape

One output item per input item. Its JSON is the bridge API response with an added human-readable response string at the top, such as 'Customer list returned N rows out of M.'. The list itself is typically in data.rowdata, with a record count in data.records, going by how the node builds that summary.

Pagination is manual: raise Page and set Per Page to fetch more rows. The node does not loop through pages itself. If the API returns status/success false, the response text carries the API's error message. With Continue On Fail enabled, a failed item returns {error: message}. Requires the VitePOS Bridge API credential, which supplies the site URL.

Examples

Example 1: Find a customer by phone number

Resource: Customer, Operation: List Customers. Add the Phone filter with the number, and set Per Page to 10.

Example 2: Fetch the newest registered customers

Add the Order By filter set to Registered and the Order filter set to Descending. Set Per Page to 100 and Page to 1.

Example 3: Look up specific customers by ID

Add the Include IDs filter with the value 12,34,56.

Links

• n8n community nodes installation guide