Giới thiệu v2.0

• API v3.0 đã mở bản Beta.

• Sau khi v3.0 chính thức ra mắt, bản v2.0 sẽ được hỗ trợ thêm 12 tháng sau đó chính thức ngừng hoàn toàn.

• Xem các thay đổi từ v2.0 lên 3.0.

Khởi tạo ứng dụng

• Xem cách khởi tạo ứng dụng tại đây.

• Xem cách đăng nhập cấp quyền và lấy accessToken tại đây.

Request params

• Sau khi lấy được accessToken, bạn có thể bắt đầu gọi các API tới pos.open.nhanh.vn, bản 2.0 sẽ dùng POST method, body form-data và các params bắt buộc như sau:

  Chú ý: Nếu param type có dấu $^{{\color{red}*}}$ là param bắt buộc (required), nếu không có là param không bắt buộc (optional).

Postman sample

• Dùng Postman lấy danh sách sản phẩm có phân trang.

• Lấy danh sách địa chỉ vận chuyển

Postman collection

• Bạn có thể dùng NhanhAPI Postman Collection tham khảo params cho 1 số API hay dùng.

• Để sử dụng: Bạn click vào collection mình cần -> click Fork

• Ở phần Create Fork: điền Fork label (Tên collection ở Workspace của bạn), Workspace (Chọn một không gian làm việc mà bạn muốn phân nhánh), xong click Fork Collection

Code sample

Lỗi thường gặp

Invalid data

• Khi bạn gửi request và nhận được response là invalid data: Lỗi này do data không phải là 1 chuỗi json string hợp lệ, thường do bạn không dùng các hàm json encode mà gõ thủ công gây thừa thiếu dấu hoặc không encode các kí tự đặc biệt. Bạn có thể kiểm tra chuỗi data json string bằng cách vào https://jsonformatter.org copy paste chuỗi của bạn vào textarea và click Validate.

Error ERR_PAGE_403

• Khi bạn gửi request và nhận được response có errorCode = ERR_PAGE_403, messsages = The app or accessToken is not authorized for this feature: Lỗi này là do user đăng nhập cấp quyền chưa chọn quyền hoặc không có quyền thao tác với hành động đó. VD: user đăng nhập cấp quyền, chỉ có quyền xem danh sách sản phẩm, nên sẽ không hiện ra quyền danh sách đơn hàng, hoặc user có quyền nhưng không chọn ở bước đăng nhập cấp quyền, thì sau đó bạn sẽ không thể dùng accessToken để gọi API /api/order/index.

• Cách sửa: Báo user đăng nhập đúng tài khoản có quyền thao tác với dữ liệu và chọn quyền ở bước đăng nhập cấp quyền.

API Rate Limit

• Rate Limit là số lệnh gọi API mà ứng dụng của bạn có thể thực hiện trong khoảng thời gian nhất định. Nếu vượt quá giới hạn này thì ứng dụng có thể bị giới hạn tốc độ. Các lệnh gọi API do ứng dụng đang bị giới hạn tốc độ sẽ không thành công. Lỗi này thường gặp phải khi ứng dụng không lưu dữ liệu mà luôn gọi API (VD liên tục gọi API lấy danh sách sản phẩm, danh sách đơn hàng...). Khuyến cáo: Bạn cần lưu dữ liệu ở hệ thống của bên bạn, cập nhật dữ liệu mới từ webhooks, khi gọi API chỉ nên lấy các dữ liệu có thay đổi, không lấy toàn bộ dữ liệu cũ (các API có hỗ trợ lọc theo updatedDateTimeFrom - updatedDateTimeTo hoặc updatedAtFrom - updatedAtTo).

• Rate Limit sẽ được kết hợp từ appId + businessId + API URL, nên ứng dụng của bạn có thể sẽ bị giới hạn ở 1 URL này, nhưng vẫn có thể gọi URL khác nếu URL đó không bị giới hạn, hoặc nếu ứng dụng của bạn dùng cho nhiều doanh nghiệp, thì bạn có thể bị giới hạn với businessId 1, nhưng vẫn có thể dùng được với businessId 2. Chú ý: Nếu bạn cố tình dùng nhiều ứng dụng để gọi liên tục API, hệ thống sẽ khóa toàn bộ các ứng dụng. Các ứng dụng bị khóa, sẽ không thể gọi bất kì API nào nữa.

• Rate Limit sẽ có mức chung mặc định là: 150 requests / 30 giây. Nếu 1 API có mức riêng, thì tài liệu của API đó sẽ có mô tả riêng.

• Khi vượt quá Rate Limit, bạn sẽ nhận được errorCode = 429. Bạn cần tạm ngừng gọi API tới URL này cho tới khi quá thời gian unlockedAt. Nếu vẫn tiếp tục phát sinh gọi API khi đang bị Rate Limit, lockedSeconds và unlockedAt sẽ bị tăng lên.

{
  "code": 0,
  "message": "Your app exceeded the API Rate Limit",
  "errorCode": 429,
  "data": {
    "lockedSeconds": 10,
    "unlockedAt": 1733387520
  }
}

Thuật ngữ

Trạng thái sản phẩm

Order

Các thuật ngữ của đơn hàng online

• shippingWeight: bao gồm cân nặng thực tế của sản phẩm và toàn bộ cân nặng của các phụ kiện và vỏ hộp đóng gói đi kèm. Shipping weight được sử dụng để tính phí vận chuyển của đơn hàng. VD: Sản phẩm “Samsung Galaxy S2” nặng 300gr, Sản phẩm fullbox còn bao gồm 1 sạc (30gr), 1 tai nghe (10gr) and vỏ hộp đóng gói (30gr), vậy thì shippingWeight để tính phí vận chuyển sẽ là: 300 + 30 + 10 + 30 = 370 gr.

• COD: Cash on delivery (Collect on delivery) là 1 loại giao dịch mà người mua hàng sẽ trả tiền khi nhận được hàng. Nếu người mua không đồng ý thanh toán khi nhận hàng, đơn hàng sẽ được chuyển trả lại cho người bán. Phí thu tiền hộ codFee tùy thuộc vào số tiền cần thu của đơn hàng.

• shipFee: Phí vận chuyển, được tính dựa vào trọng lượng đơn hàng, địa chỉ gửi hàng và địa chỉ nhận hàng.

• customerShipFee: Phí thu của khách, là mức phí mà website thông báo cho khách đặt hàng, thường sẽ lấy bằng shipFee + codFee. Tình huống website có chương trình miễn phí vận chuyển cho khách thì set customerShipFee = 0.

• Order Status:

  Trạng thái đơn hàng

• Order Reason

  Lý do theo trạng thái đơn hàng

Inventory

Các thuật ngữ về kho hàng

• Phiếu XNK, Sản phẩm XNK có 2 loại (type) là phiếu nhập, phiếu xuất và nhiều kiểu (mode) XNK khác nhau:

• Loại XNK:

• Kiểu XNK: