Chi Nhánh KiotViet icon

Chi Nhánh KiotViet

Quản lý chi nhánh từ KiotViet
Join our community

Actions5

Overview

This node manages branches ("Chi Nhánh") in the KiotViet system, a popular retail management platform. It supports creating new branches, retrieving branch details by ID, listing multiple branches with optional filters, updating existing branches, and deleting branches.

Typical use cases include:

  • Automating branch creation when expanding retail locations.
  • Fetching detailed information about a specific branch for reporting or integration.
  • Listing all active branches or filtering them by status or search terms.
  • Updating branch information such as address or phone number.
  • Removing branches that are no longer operational.

For example, you might use this node to automatically sync your branch data from KiotViet into another system or update branch addresses based on external inputs.

Properties

Name Meaning
Thao Tác (operation) The action to perform: Create, Delete, Get by ID, Get Many, or Update a branch.
ID Chi Nhánh (branchId) The unique identifier of the branch. Required for Get by ID, Update, and Delete operations.
Lấy Toàn Bộ (returnAll) Boolean flag to return all results or limit the number of branches returned (used in Get Many).
Tên Chi Nhánh (name) The name of the branch. Required for Create and Update operations.
Địa Chỉ (address) The address of the branch. Required for Create and Update operations.
Trường Bổ Sung (additionalFields) Optional additional fields for Create and Update: Phone Number, Branch Code, Notes.
Bộ Lọc (filters) Filters for listing branches (Get Many): Search term (by name or code), Status (Active or Inactive).
Limit (limit) Maximum number of branches to return when not returning all (used in Get Many).

Output

The node outputs an array of JSON objects representing branch data returned from KiotViet API calls. The structure depends on the operation:

  • Create: Returns the created branch object with its details.
  • Get by ID: Returns the branch object matching the specified ID.
  • Get Many: Returns a list of branch objects, optionally filtered and limited.
  • Update: Returns the updated branch object.
  • Delete: Returns confirmation of deletion or related response.

No binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the KiotViet API.
  • Uses an internal KiotViet API helper class to handle requests.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Invalid branch ID errors: Ensure the branchId provided is a valid integer corresponding to an existing branch.
  • Authentication failures: Verify that the API key credential is correctly configured and has necessary permissions.
  • Empty results on Get Many: Check filter parameters and ensure branches exist matching those criteria.
  • Rate limits or API errors: Handle errors gracefully; consider enabling "Continue On Fail" to process multiple items without stopping.
  • Required fields missing: For create and update operations, ensure mandatory fields like name and address are provided.

Links and References

Discussion