Thêm đơn hàng
- /api/order/add: Tính năng này dùng để gửi thông tin đơn hàng từ website của bạn sang Nhanh.vn. Khi khách hàng đặt hàng trên website của bạn, sau khi lưu thông tin đơn hàng vào cơ sở dữ liệu, website của bạn gửi thông tin đơn hàng sang Nhanh.vn, sau đó chủ gian hàng có thể xử lý toàn bộ các bước từ việc xác nhận đơn hàng, nhặt hàng và đóng gói, gửi đơn hàng sang hãng vận chuyển, đối soát tình trạng thanh toán (tiền thu hộ) các đơn hàng với hãng vận chuyển bên trong hệ thống Nhanh.vn.
- Đơn hàng tạo từ API nếu có gắn kho hàng (depotId) sẽ áp dụng các logic tính số Tạm giữ và Đang chuyển như đơn tạo từ trang quản trị. VD 1 sản phẩm trên hệ thống đang tồn 10, tạm giữ 1, sau khi API có bắn về thêm 1 đơn hàng trạng thái Mới, số lượng = 1, có gắn depotId, thì hệ thống sẽ tự động tính toán lại số Tạm giữ = 2.
- Nếu đơn hàng không gắn kho hàng (depotId), Nhanh API sẽ có logic tự động gắn kho như sau:
- Nếu doanh nghiệp có 1 kho: gắn luôn kho này cho đơn hàng.
- Nếu doanh nghiệp có nhiều kho, và chỉ có 1 kho chọn loại chuyển hàng, gắn luôn kho này cho đơn hàng.
- Nếu doanh nghiệp có nhiều kho chuyển hàng, ưu tiên gắn đơn hàng cho kho cùng thành phố địa chỉ nhận hàng.
- Mỗi khi trạng thái đơn hàng có sự thay đổi, website của bạn sẽ nhận được 1 webhooks cập nhật trạng thái đơn hàng từ Nhanh.vn.
- Các key của mảng data array dùng để tạo data json string:
Key | Type | Description |
|---|---|---|
id | string(36) (required) | id đơn hàng trên website của bạn |
depotId | int (optional) | id kho hàng trên Nhanh.vn |
type | string (optional) | Loại đơn hàng, giá trị có thể là: “Shipping” (Chuyển hàng) hoặc “Shopping” (Khách tới mua tại cửa hàng) “PreOrder”(Khách đặt hàng trước). Giá trị mặc định là Shipping. |
customerName | string(255) (required) | Tên người nhận hàng |
customerMobile | string(255) (required) | Mobile của người nhận hàng. Hệ thống sẽ dựa vào số điện thoại để kiểm tra khách hàng đã tồn tại hay chưa, nếu chưa tồn tại, hệ thống sẽ tự động tạo khách hàng. |
customerEmail | string(255) (optional) | Địa chỉ email đặt hàng |
customerAddress | string(255) (optional) | Địa chỉ người nhận hàng |
customerCityName | string(255) (optional) | |
customerDistrictName | string(255) (optional) | |
customerWardLocationName | string (optional) | |
moneyDiscount | double (optional) | Tiền chiết khấu |
moneyTransfer | double (optional) | Số tiền khách chuyển khoản |
moneyTransferAccountId | int (optional) | Tài khoản nhận tiền chuyển khoản |
moneyDeposit | double (optional) | Số tiền khách đặt cọc |
moneyDepositAccountId | int (optional) | Tài khoản nhận tiền đặt cọc |
paymentMethod | string (optional) | Các giá trị có thể là: COD //Thanh toán tại nhà Store // Thanh toán tại cửa hàng Gateway // Thanh toán qua cổng thanh toán Online // thanh toán Online |
paymentCode | string(255) (optional) | Mã giao dịch thanh toán |
paymentGateway | string(255) (optional) | Tên cổng thanh toán |
carrierId | int (optional) | |
carrierServiceId | int (optional) | |
customerShipFee | int (optional) | Phí ship báo khách (Bạn có thể điền 0 nếu báo với khách hàng là miễn phí vận chuyển, hoặc điền các giá trị cố định như 20K, 30K, hoặc lấy theo tổng Phí vận chuyển shipFee + phí thu tiền hộ codFee + phí bảo hiểm declaredFee lấy từ /api/shipping/fee) ) |
deliveryDate | date (optional) | Ngày giao hàng của đơn hàng này, định dạng yyyy-mm-dd |
status | string (optional) | Trạng thái của đơn hàng: New (Mới) hoặc Confirmed (Đã xác nhận). |
description | string(255) (optional) | Ghi chú của khách hàng về đơn hàng này |
privateDescription | string(255) (optional) | Ghi chú của chăm sóc khách hàng (Nội bộ) |
trafficSource | string (optional) | Nguồn truy cập đơn hàng, bạn có thể đánh dấu xem đơn hàng đến từ nguồn nào qua referrer hoặc marketing campaign (utm_source, utm_medium, utm_campaign) và gửi kèm thông tin này theo đơn hàng để xem báo cáo thống kê theo nguồn truy cập ở bên Nhanh.vn |
productList | array (optional) | Xem bảng dữ liệu bên dưới. Danh sách sản phẩm của đơn hàng là không bắt buộc, để hỗ trợ cả các đơn đồng bộ từ landing về, CSKH vẫn có số điện thoại để gọi điện tư vấn. |
couponCode | string (optional) | Mã coupon |
allowTest | int (optional) | 1 - Cho xem hàng, không cho thử
2 - Cho phép thử
3 - Không cho xem hàng
4 - Cho xem, không lấy thu ship |
saleId | int (optional) | Nhân viên bán hàng |
autoSend | int (optional) | Biến đánh dấu gửi luôn đơn hàng sang hãng vận chuyển (Dùng trong tình huống bạn có hệ thống xác nhận đơn hàng từ trước, chỉ dùng Nhanh để hỗ trợ vận chuyển). Set value = 1: Gửi luôn đơn hàng sang hãng vận chuyển. Nếu gửi thành công hệ thống sẽ trả về mã vận đơn carrierCode. Chú ý khi có tham số này, hệ thống sẽ phải kết nối sang hãng vận chuyển, nên thời gian phản hồi có thể bị chậm hơn bình thường tùy thuộc vào phản hồi của các hãng vận chuyển. |
sendCarrierType | int (optional) | Biến đánh dấu gửi đơn dùng bảng giá vận chuyển: 1 = Dùng bảng giá của Nhanh.vn, 2 = Dùng bảng giá kết nối tài khoản riêng của doanh nghiệp |
utmCampaign | string (optional) | param khi gắn link đo đếm marketing utm_campaign |
utmSource | string (optional) | param khi gắn link đo đếm marketing utm_source |
utmMedium | string (optional) | param khi gắn link đo đếm marketing utm_medium |
affiliate | array (optional) | |
usedPoints | int (optional) | Tiêu điểm khách hàng |
- Các thuộc tính của 1 sản phẩm trong productList bao gồm:
Key | Type | Description |
|---|---|---|
id | string(20) (required) | id sản phẩm bên website của bạn |
idNhanh | bigint(20) (optional) | id sản phẩm bên Nhanh.vn (tham số này là bắt buộc nếu sản phẩm được đồng bộ từ Nhanh.vn sang website của bạn) |
quantity | int or double (required) | số lượng đặt hàng |
name | string(255) (required) | Bắt buộc để thêm sản phẩm mới trong tình huống sản phẩm chưa tồn tại (giúp cho việc đồng bộ đơn hàng không bị gián đoạn nếu sản phẩm chưa được đồng bộ trước đó) |
code | string(255) (optional) | Mã sản phẩm |
imei | string(255) (optional) | Số IMEI sản phẩm |
type | string(255) (optional) | Loại sản phẩm (Product, Voucher, IMEI) |
price | int (required) | Giá của sản phẩm. Bắt buộc để thêm sản phẩm mới trong tình huống sản phẩm chưa tồn tại |
weight | int (optional) | Khối lượng sản phẩm |
importPrice | int (optional) | Giá nhập của sản phẩm |
description | string (optional) | Mô tả riêng của từng sản phẩm trong đơn hàng |
gifts | Array (optional) | Quà tặng của sản phẩm trong đơn hàng [ 0 => [ Id => id sản phẩm trên website , productStoreId => id sản phẩm trên Nhanh , quantity => Số lượng, value => Giá sản phẩm quà tặng ], 1 => [ Id => id sản phẩm trên website, productStoreId => id sản phẩm trên Nhanh, quantity => Số lượng, value => Giá sản phẩm quà tặng ] ... ] |
[
"code" => string, // mã giới thiệu
"discount" => double, // Tiền chiết khấu cho đơn hàng theo mã affiliate
"bonus" => double // Tiền hoa hồng nhận được theo mã affiliate
]
{
"code": 1, // 1 is success, 0 is error
"messages": [ ], // error messages if code is 0
"data": [
"orderId": 125123098, // int ID đơn hàng trên Nhanh.vn
// Các trường bên dưới chỉ có giá trị khi đơn hàng có dùng chức năng gửi sang hãng vận chuyển (autoSend=1)
"shipFee": 20000, // int: Phí vận chuyển
"codFee": 13000, // int: Phí thu tiền hộ
"declaredFee": 10000, // int: Phí bảo hiểm (tùy theo giá trị đơn hàng và dịch vụ bạn lựa chọn sẽ có loại phí này)
"carrierCode": string // Mã vận đơn, Nếu gửi đơn hàng thành công sang hãng vận chuyển hệ thống sẽ trả về carrierCode (mã vận đơn)
]
}
Last modified 3mo ago