📖KiotViet

KiotViet Public API được phát triển nhằm hỗ trợ tích hợp, trao đổi dữ liệu giữa KiotViet với các website, sàn thương mại điện tử, nền tảng CRM... KiotViet Public API cung cấp cơ chế đọc ghi các đối tượng: Sản phẩm, khách hàng, hóa đơn, phụ phí,. .. Trên trang này, bạn sẽ tìm thấy danh sách các hoạt động mà node KiotViet hỗ trợ và liên kết đến nhiều tài nguyên hơn.

Basic Operations

  1. Product

    • Lấy Chi Tiết Hàng Hóa

    • Thêm Mới Hàng Hóa

    • Cập Nhật Hàng Hóa

    • Xóa Hàng Hóa

    • Danh Sách Hàng Hóa

    • Thêm Mới Danh Sách Hàng Hóa

    • Cập Nhật Danh Sách Hàng Hóa

    • Lấy Danh Sách Hàng Hóa Tồn Kho

  2. Customer

    • Lấy Chi Tiết Khách Hàng

    • Thêm Mới Khách Hàng

    • Cập Nhật Khách Hàng

    • Xóa Khách Hàng

    • Lấy Danh Sách Khách Hàng

  3. Order Product

    • Lấy Chi Tiết Đặt Hàng

    • Thêm Mới Đặt Hàng

    • Cập Nhật Đặt Hàng

    • Xóa Đặt Hàng

    • Lấy Danh Sách Đặt Hàng

  4. Cash Flow

    • Danh Sách Sổ Quỷ

  5. Commodity Group

    • Lấy Chi Tiết Nhóm Hàng

    • Thêm Mới Nhóm Hàng

    • Cập Nhật Nhóm Hàng

    • Xóa Nhóm Hàng

    • Lấy Danh Sách Nhóm Hàng

  6. Surcharge

    • Thêm Mới Thu Khác

    • Cập Nhật Thu Khác

    • Ngừng Hoạt Động Thu Khác

    • Lấy Danh Sách Thu Khác

  7. Invoice

    • Lấy Chi Tiết Hóa Đơn

    • Thêm Hóa Đơn Mới

    • Cập Nhật Hóa Đơn

    • Xóa Hóa Đơn

    • Lấy Danh Sách Hóa Đơn

  8. Sale Channel

    • Lấy Danh Sách Kênh Bán Hàng

  9. Price Books

    • Lấy Chi Tiết Bảng Giá

    • Cập Nhật Chi Tiết Bảng Giá

    • Lấy Danh Sách Bảng Giá

  10. Group

    • Lấy Danh Sách Nhóm Khách Hàng

  11. Purchase Order

    • Lấy Chi Tiết Nhập Hàng

    • Thêm Mới Nhập hàng

    • Cập Nhật Nhập Hàng

    • Xóa Nhập Hàng

    • Lấy Danh Sách Nhập Hàng

  12. Return Product

    • Lấy Danh Sách Trả Hàng

    • Lấy Chi Tiết Phiếu Trả Hàng

  13. Setting

    • Lấy Danh Sách Thiết Lập Cửa Hàng

  14. Transfers

    • Thêm Mới Chuyển Hàng

    • Cập Nhật Chuyển Hàng

    • Xóa Chuyển Hàng

    • Lấy Chi Tiết Chuyển Hàng

    • Lấy Danh Sách Chuyển Hàng

  15. Order Supplier

    • Lấy Danh Sách Đặt Hàng Nhập

    • Lấy Chi Tiết Đặt Hàng Nhâh

  16. Webhook

    • Đăng Ký Webhook

    • Hủy Đăng Ký Webhook

    • Danh Sách Webhook

    • Chi Tiết Webhook

  17. Coupon

    • Cập Nhật Trạng Thái Coupon

  18. Branches

    • Lấy Danh Sách Chi Nhánh

Cách sử dụng

Quy trình sử dụng ví dụ này sẽ sử dụng các nút sau. - Start - KiotViet

1. Start node

  • Start node tồn tại theo mặc định khi bạn tạo một workflow mới.

2. KiotViet node (Append)

  • Nhấn vào nút Click on the Add node or drag to connect và nhập KiotViet trong search nodes box

  • Để sử dụng node này bạn phải tạo credential. (Hướng dẫn có tại KiotViet credentail)

Lấy Chi Tiết Hàng Hóa

  • Chọn Resource là Product và Operation Lấy Chi Tiết Hàng Hóa

  • Chọn loại tìm kiếm phù hợp (code hoặc ID sản phẩm) và sao đó nhập code hoặc ID sản phẩm. Sau đó nhấn Execute node

  • Sau khi hoàn thành kết quả sẽ được hiển thị bên phải

Thêm Mới Hàng Hóa

  • Chọn Resource là Product và Operation Thêm Mới Hàng Hóa

  • Nhập các thông tin cần thiết được yêu cầu của sản phẩm

  • Lưu ý: Hiện tại KiotViet không hỗ trợ cập nhật thông tin cho sản phẩm serial nên vui lòng bỏ chọn Is Product Serial

  • Sau khi hoàn thành nhập dữ liệu thì nhấn nút Execute node để hoàn thành thêm sản phẩm mới

Cập Nhật Hàng Hóa

  • Chọn Resource là Product và Operation Cập Nhật Hàng Hóa

  • Nhập dữ liệu cần được cập nhật

  • Sau khi hoàn tất nhập dữ liệu mới thì nhấn nút Execute node để chạy workflow

Danh Sách Hàng Hóa

  • Chọn Resource là Product và Operation Danh Sách Hàng Hóa

  • Điền trường bạn cần sắp xếp (Ví dụ: Sắp xếp theo id hoặc name), chọn tăng dần hoặc giảm dần và chọn thêm các trường để lọc dữ liệu

  • Lưu ý: Đối với Current Item hoạt động theo cách sau. Nếu bạn lấy 20 sản phẩm và Current Item bằng 1 thì danh sách sẽ lấy sản phẩm từ số 1 đến số 20 nên nếu muốn lấy 20 sản phẩm đầu bạn cần nhập 0. Tương tự nếu sau khi đã lấy 20 sản phẩm và bạn muốn lấy 20 sản phẩm tiếp theo bạn phải nhập 20 thì sẽ lấy từ sản phẩm 20 đến 29.

  • Sau khi hoàn tất nhập dữ liệu mới thì nhấn nút Execute node để chạy workflow

Xóa Hàng Hóa

  • Chọn Resource là Product và Operation Xóa Hàng Hóa

  • Nhập ID sản phẩm cần xóa

  • Sau đó nhấn Execute node để chạy workflow

Thêm Mới Danh Sách Hàng Hóa

  • Chọn Resource là Product và Operation Thêm Mới Danh Sách Hàng Hóa

  • Chọn Add Product để thêm một sản phẩm cần thêm

  • Sau khi đã nhấn vào nút Add Product thì sẽ hiện ra các trường tương tự như Thêm Mới Hàng Hóa

  • Nhập các trường cần thiết và sau đó nhấn nút Execute node để chạy workflow

Cập Nhật Danh Sách hàng Hóa

  • Chọn Resource là Product và Operation Cập Nhật Danh Sách Hàng Hóa

  • Chọn Add Product để thêm một sản phẩm cần thêm

  • Sau khi nhấn nút Add Product thì sẽ hiện ra các trường tương tự như Cập Nhật Hàng Hóa

  • Nhập các trường cần cập nhật sau đó nhấn nút Execute node để chạy workflow

Lấy Hàng Tôn Kho

  • Chọn Resource là Product và Operation Lấy Hàng Tồn Kho

  • Nhập thuộc tính cần được sắp xếp vào trường Order By và thứ tự sắp xếp ở trường Order Direction. Ngoài ra còn có thể chọn các thuộc tính khác để lọc như: Chi nhánh, thời gian cập nhật

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau khi hoàn tất nhập, nhấn nút Execute node để chạy work flow

Thêm Mới Khách Hàng

  • Chọn Resource là Customer và Operation Thêm Mới Khách Hàng

  • Điền các thông tin cần thiết để tạo khách hàng mới

  • Sau khi nhập dữ liệu thành công, nhấn Execute node để chạy workflow

Lấy Chi Tiết Khách Hàng

  • Chọn Resource là Customer và Operation Lấy Chi Tiết Khách Hàng

  • Chọn loại tìm kiếm khách hàng (theo ID hoặc Code khách hàng) sau đó nhập ID hoặc Code khách hàng

  • Sau khi nhập ID hoặc Code thì nhấn Execute node để chạy workflow

Cập Nhật Khách Hàng

  • Chọn Resource là Customer và Operation Cập Nhật Khách Hàng

  • Điền các trường cần thiết để cập nhật thông tin khách hàng

  • Sau khi nhập thông tin cập nhật thì nhấn Execute node để chạy workflow

Lấy Danh Sách Khách Hàng

  • Chọn Resource là Customer và Operation Lấy Danh Sách Khách Hàng

  • Nhập trường cần được sắp xếp (id,name,...), chọn thứ tự trả về của kết quả sau khi đã sắp xếp theo thứ tự tăng hoặc giảm dần, nhập số lượng bản ghi trả về, vị trí lấy thông tin và các thuộc tính cần lọc

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau khi hoàn thành các bước trên hãy nhấn Execute node để chạy workflow

Lấy Danh Sách Nhóm Khách Hàng

  • Chọn Resource là Customer và Operation Lấy Danh Sách Nhóm Khách Hàng

  • Sau đó nhấn Execute node để chạy workflow

Xóa Khách Hàng

  • Chọn Resource là Customer và Operation Xóa Khách Hàng

  • Nhập ID khách hàng cần xóa

  • Sau đó nhấn Execute node để chạy workflow

Thêm Mới Đặt Hàng

  • Chọn Resource là Order Product và Operation Thêm Mới Đặt Hàng

  • Nhập các trường cần thiết để tạo đơn đặt hàng

  • Sau đó, nhấn Execute node để chạy workflow

Cập Nhật Đặt Hàng

  • Chọn Resource là Order Product và Operation Cập Nhật Đặt Hàng

  • Nhập thông tin cần cập nhật của đơn hàng

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Đặt Hàng

  • Chọn Resource là Order Product và Operation Lấy Danh Sách Đặt Hàng

  • Điền các thuộc tính cần lọc để lấy thông tin

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Chi Tiết Đặt Hàng

  • Chọn Resource là Order Product và Operation Lấy Chi Tiết Đặt Hàng

  • Chọn loại tìm kiếm (ID hoặc Code) và nhập ID hoặc Code đơn đặt hàng

  • Sau đó, nhấn Execute node để chạy workflow

Xóa Đơn Đặt Hàng

  • Chọn Resource là Order Product và Operation Xóa Đặt Hàng

  • Nhập ID đơn đặt hàng cần xóa

  • Sau đó, nhấn Execute node để chạy workflow

Danh Sách Sổ Quỹ

  • Chọn Resource là Cash Flow và Operation Danh Sách Sổ Quỹ

  • Nhập các thuộc tính cần thiết để lọc dữ liệu

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Thêm Mới Thu Khác

  • Chọn Resource là Surcharge và Operation Thêm Mới Thu Khác

  • Nhập các trường cần thiết để tạo thu khác

  • Sau đó, nhấn Execute node để chạy workflow

Cập Nhật Thu Khác

  • Chọn Resource là Surcharge và Operation Cập Nhật Thu Khác

  • Nhập thông tin cần được cập nhật

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Thu Khác

  • Chọn Resource là Surcharge và Operation Lấy Danh Sách Thu Khác

  • Điền các thuộc tính cần lọc để lấy danh sách thu khác

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Ngừng Hoạt Động Thu Khác

  • Chọn Resource là Surcharge và Operation Ngừng Hoạt Động Thu Khác

  • Nhập ID thu khác cần ngừng hoạt động

  • Sau đó, nhấn Execute node để chạy workflow

Thêm Hóa Đơn Mới

  • Chọn Resource là Invoice và Operation Thêm Hóa Đơn Mới

  • Nhập các thông tin cần thiết để tạo một hóa đơn mới

  • Sau đó, nhấn Execute node để chạy workflow

Cập Nhật Hóa Đơn

  • Chọn Resource là Invoice và Operation Cập Nhật Hóa Đơn

  • Nhập các thông tin cần cập nhật

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Hóa Đơn

  • Chọn Resource là Invoice và Operation Lấy Danh Sách Hóa Đơn

  • Nhập các thuộc tính cần lọc để lấy dữ liệu

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Chi Tiết Hóa Đơn

  • Chọn Resource là Invoice và Operation Lấy Chi Tiết Hóa Đơn

  • Chọn loại tìm kiếm hóa đơn (ID hoặc Code), nhập ID hoặc Code hóa đơn để lấy thông tin

  • Sau đó, nhấn Execute node để chạy workflow

Xóa Hóa Đơn

  • Chọn Resource là Invoice và Operation Xóa Hóa Đơn

  • Nhập ID hóa đơn cần xóa

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Kênh Bán Hàng

  • Chọn Resource là Sale Channel và Operation Lấy Danh Sách Kênh Bán Hàng

  • Nhập các thuộc tính cần lọc để lấy dữ liệu

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Bảng Giá

  • Chọn Resource là Price Books và Operation Lấy Danh Sách Bảng Giá

  • Điền các thuộc tính cần lọc để lấy thông tin

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Chi Tiết Bảng Giá (Lấy sản phẩm trong bảng giá)

  • Chọn Resource là Price Books và Operation Lấy Chi Tiết Bảng Giá

  • Nhập ID Bảng giá và các thuộc tính cần lọc để lấy sản phẩm thuộc bảng giá

  • Lưu ý: Mục Bảng giá hiện tại có lưu ý giống lưu ý của Current Item trong Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Cập Nhật Chi Tiết Bảng Giá

  • Chọn Resource là Price Books và Operation Cập Nhật Chi Tiết Bảng Giá

  • Nhập ID Bảng giá, ID Sản phẩm Giá sản phẩm

  • Sau đó, nhấn Execute node để chạy workflow

Lấy danh sách nhóm khách hàng

  • Chọn Resource là Group và Operation Lấy Danh Sách Nhóm Khách Hàng

  • Sau đó, nhấn Execute node để chạy workflow

Thêm Mới Hàng Nhập

  • Chọn Resource là Purchase Order và Operation Thêm Mới Nhập Hàng

  • Nhập các thông tin cần thiết để thêm mới nhập hàng

  • Sau đó, nhấn Execute node để chạy workflow

Cập Nhật Nhập Hàng

  • Chọn Resource là Purchase Order và Operation Cập Nhật Nhập Hàng

  • Điền các thông tin cần cập nhật của đơn nhập hàng

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Chi Tiết Nhập Hàng

  • Chọn Resource là Purchase Order và Operation Lấy Chi Tiết Nhập Hàng

  • Nhập ID của đơn nhập hàng cần tiền kiếm

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Nhập Hàng

  • Chọn Resource là Purchase Order và Operation Lấy Danh Sách Nhập Hàng

  • Nhập Page Size, Current Item và có thể chọn thêm các filter để lọc danh sách dữ liệu

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Xóa Nhập Hàng

  • Chọn Resource là Purchase Order và Operation Xóa Nhập Hàng

  • Nhập ID phiếu nhập hàng cần xóa và chọn có muốn hủy phiếu thanh toán không

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Trả Hàng

  • Chọn Resource là Return Product và Operation Lấy Danh Sách Trả Hàng

  • Nhập các thông tin cần thiết như: Sắp xếp theo trường, Page Size, Current Item và các thuộc tính cần filter để lọc dữ liệu

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Chi Tiết Phiếu Trả Hàng

  • Chọn Resource là Return Product và Operation Lấy Chi Tiết Phiếu Trả Hàng

  • Chọn loại tìm kiếm (Code hoặc ID) và nhập Code hoặc ID của phiếu trả hàng

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Thiết Lập Cửa Hàng

  • Chọn Resource là Setting và Operation Lấy Danh Sách Thiết Lập Cửa Hàng

  • Sau đó, nhấn Execute node để chạy workflow

Thêm Mới Chuyển Hàng

  • Chọn Resource là Tranfers và Operation Thêm Mới Chuyển Hàng

  • Nhập các thông tin cần thiết để chuyển hàng

  • Sau đó, nhấn Execute node để chạy workflow

Cập Nhật Chuyển Hàng

  • Chọn Resource là Tranfers và Operation Cập Nhật Chuyển Hàng

  • Nhập thông tin cần cập nhật

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Chi Tiết Phiếu Chuyển Hàng

  • Chọn Resource là Tranfers và Operation Lấy Chi Tiết Phiếu Chuyển Hàng

  • Nhập ID phiếu chuyển hàng cần lấy thông tin

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Phiếu Chuyển Hàng

  • Chọn Resource là Tranfers và Operation Lấy Danh Sách Phiếu Chuyển Hàng

  • Nhập Page Size, Current Item và các filter để lọc dữ liệu

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Xóa Chuyển Hàng

  • Chọn Resource là Tranfers và Operation Xóa Chuyển Hàng

  • Nhập ID phiếu chuyển hàng cần xóa

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Đặt Hàng Nhập

  • Chọn Resource là Order Supplier và Operation Lấy Danh Sách Đặt Hàng Nhập

  • Nhập Page Size, Current Item và các filter để lọc dữ liệu

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Chi Tiết Đặt Hàng Nhập

  • Chọn Resource là Order Supplier và Operation Lấy Chi Tiết Đặt Hàng Nhập

  • Nhập ID đặt hàng nhập cần lấy thông tin

  • Sau đó, nhấn Execute node để chạy workflow

Đăng Ký Webhook

  • Chọn Resource là Webhook và Operation Đăng Ký Webhook

  • Chọn event ở mục "Type" mà bạn muốn đăng ký, dán đường dẫn webhook vào mục "URL", chọn "Is Active" và điền ghi chú vào mục "Description". Cuối cùng nhấn "Execute node"

Danh Sách Webhook

  • Chọn Resource là Webhook và Operation Danh Sách Webhook

  • Sau đó, nhấn Execute node để chạy workflow

Chi Tiết Webhook

  • Chọn Resource là Webhook và Operation Chi Tiết Webhook

  • Nhập ID webhook cần lấy thông tin

  • Sau đó, nhấn Execute node để chạy workflow

Hủy Đăng Ký Webhook

  • Chọn Resource là Webhook và Operation Hủy Đăng Ký Webhook

  • Nhập ID cần hủy đăng ký

  • Sau đó, nhấn Execute node để chạy workflow

Cập nhật trạng thái coupon

  • Chọn Resource là Coupon và Operation Cập Nhật Trạng Thái Coupon

  • Nhập Coupon code cần cập nhật trạng thái

  • Sau đó, nhấn Execute node để chạy workflow

Lấy Danh Sách Chi Nhánh

  • Chọn Resource là Branch và Operation Lấy Danh Sách Chi Nhánh

  • Nhập các thuộc tính cần lọc để lấy dữ liệu

  • Lưu ý: Mục Current Item có lưu ý giống lưu ý của Danh Sách Hàng Hóa

  • Sau đó, nhấn Execute node để chạy workflow

Last updated