Nâng cấp lên v3.0

  • API v3.0 chuẩn bị ra mắt, v3.0 thay đổi lại cấu trúc dữ liệu giúp đọc các params và response rõ ràng hơn, bổ sung thêm nhiều API và webhooks mới.

  • Sau khi chính thức ra mắt v3.0, hệ thống sẽ ngừng hỗ trợ bản 2.0 sau 12 tháng.

Các thay đổi cần chú ý

Access Token

  • Các accessToken và quyền đã được cấp ở v2 sẽ vẫn được dùng cho v3 Alpha. Bản chính thức có thể sẽ tách hoàn toàn accessToken 2 bản v2.0, v3.0.

  • Cài đặt app sẽ có thêm 1 mục webhooks version: Bạn có thể chọn nhận webhooks v2 hoặc v3.

Request

  • Khác với v2.0 dùng Body form-data, v3.0 dùng Body raw. Xem cách tạo request params v3.0.

  • v3.0 đã hỗ trợ mở CORS, không còn chặn gọi bằng Javascript như v2.0

Response

  • API v3.0 đã thay đổi hoàn toàn cấu trúc dữ liệu response data.

    • Xem Response chung tại đây.

    • Bạn chú ý đọc kỹ tài liệu ở từng API sẽ có thể có thêm các data response riêng.

Các API có thay đổi

Thay đổi chung

  • Thay đổi về Paginator giúp hỗ trợ nhiều điều kiện sort hơn.

  • 1 số API trước đó có giới hạn 10 ngày, nay sẽ tăng lên 31 ngày để bạn dễ dàng lấy được dữ liệu theo từng tháng.

  • Khi Nhanh bắn webhooks cho app, cấu trúc dữ liệu sẽ tương tự như khi gọi API, giúp giảm việc gọi API để lấy thêm thông tin. VD:

    • Webhooks đơn hàng mới, sẽ có cấu trúc giống với 1 đơn hàng trong mảng khi gọi API lấy danh sách đơn hàng.

    • Webhooks sản phẩm mới, sẽ có cấu trúc giống với 1 sản phẩm trong mảng khi gọi API lấy danh sách sản phẩm.

Order Add

  • v2: hỗ trợ truyền id (là productId của web / app) và idNhanh (id sản phẩm trên Nhanh).

  • v3: bỏ id (productId của web / app), chỉ sử dụng id sản phẩm trên Nhanh.

Các API mới

  • Dự kiến API v3 sẽ hỗ trợ thêm các mục sau:

POS

  • Sản phẩm:

    • Danh sách sản phẩm đã xóa.

  • Bán hàng:

    • Thêm hóa đơn bán lẻ, bán sỉ

    • Lấy danh sách hóa đơn đã bị xóa

  • Đơn hàng:

    • Lấy danh sách đơn hàng đã bị xóa

  • Kho hàng: Thêm 1 số loại phiếu xuất nhập kho

  • Khuyến mại:

    • Tặng điểm, trừ điểm khách hàng

    • Tặng coupon

  • Webhooks:

Vpage

Các Webhooks mới

  • Đang cập nhật.

Last updated