Overview
This node manages customer information from the KiotViet platform. It supports creating new customers, retrieving customer details by ID, fetching multiple customers with optional filters, and updating existing customer data. This node is useful for automating customer management workflows such as syncing customer records, retrieving customer details for order processing, or bulk exporting customer lists.
Practical examples:
- Automatically create a new customer in KiotViet when a form is submitted on your website.
- Retrieve detailed information about a specific customer by their ID to personalize communications.
- Fetch all customers who belong to a certain group or have been modified since a given date.
- Update customer contact details based on changes made in another system.
Properties
| Name | Meaning |
|---|---|
| Thao Tác | Operation to perform: Create, Get by ID, Get Many, or Update customer |
| ID Khách Hàng | Customer identifier (required for "get" and "update" operations) |
| Lấy toàn Bộ | Boolean flag to return all results without limit (only for "getAll" operation) |
| Giới Hạn | Maximum number of results to return (only for "getAll" when not returning all) |
| Tên Khách Hàng | Customer's full name (required for "create" and "update") |
| Trường Bổ Sung | Additional fields for customer such as phone number, email, address, gender, birth date, and group IDs (for "create" and "update") |
| Bộ Lọc | Filters for listing customers including search term, group ID, and last modified date (for "getAll") |
Output
The node outputs JSON data representing customer information returned from KiotViet API calls. The structure varies by operation:
- Create: JSON object of the newly created customer.
- Get by ID: JSON object of the requested customer.
- Get Many: An object containing an array
dataof customer objects, plus pagination info (total,pageSize,currentItem). - Update: JSON object of the updated customer.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the KiotViet API.
- Uses an internal shared KiotViet API helper class to handle requests.
- No additional external dependencies beyond the KiotViet API service.
Troubleshooting
- Failed to fetch customers: Indicates issues connecting to or receiving data from the KiotViet API. Check API credentials, network connectivity, and API service status.
- Update operation is not supported: If the KiotViet API does not support update, the node will throw an error. Verify that the API endpoint is available and credentials have sufficient permissions.
- Invalid customer ID: Ensure the provided customer ID is a valid integer and exists in KiotViet.
- Rate limiting or timeouts: When fetching many customers, the node paginates results with delays. Excessive data or slow responses may cause timeouts or partial data retrieval.
Links and References
- KiotViet Official API Documentation
- n8n Documentation on Creating Custom Nodes