Khi có đơn hàng mới hoặc trạng thái đơn hàng có thay đổi, Nhanh.vn sẽ bắn webhooks về cho hệ thống của bạn.
Khác với bản 1.0 chỉ hỗ trợ webhooks với các đơn hàng bắn qua API, bản 2.0 hệ thống đã hỗ trợ gửi webhooks cho tất cả đơn hàng (cả đơn tự tạo ở trang quản trị, đơn từ các sàn Lazada, Tiki, Shopee, Sendo, và đơn từ các ứng dụng khác bắn về Nhanh.vn).
Trên trang quản trị Nhanh.vn, bạn có thể vào trang chi tiết của 1 đơn hàng, tab API để xem lịch sử webhooks của đơn hàng đó.
Để nhận được webhooks thêm, sửa, xóa đơn hàng, app phải có quyền Danh sách đơn hàng
Khi có đơn hàng mới
{"event": "orderAdd","businessId": int,// ID doanh nghiệp trên Nhanh.vn"webhooksVerifyToken": string,// Key xác minh khi nhận dữ liệu, tương ứng với webhooks verify token trong app của bạn"data": {"orderId": int,// ID đơn hàng trên Nhanh.vn"shopOrderId": string,// shop order ID nếu đơn được bắn từ các hệ thống khác sang Nhanh.vn"typeId": int,//mã loại đơn hàng"type": string,// Loại đơn hàng (Shipping | Shopping,...)"shippingTypeId": int,//Mã loại chuyển hàng"shippingType": string,// Loại chuyển hàng (Chuyển hàng tận nhà | khách trả hàng,....)"moneyDiscount": double,// Tiền chiết khấu"moneyDeposit": double,// Tiền đặt cọc"moneyTransfer": double,// Tiền chuyển khoản"shipFee": double,// Phí vận chuyển"codFee": double,// Phí thu tiền hộ"customerShipFee": double,// Phí thu của khách,"calcTotalMoney": double,// Tổng thu của khách,"description": string,// ghi chú của khách hàng"customerId": int,// Mã khách hàng"customerName": string,// Tên khách hàng"customerMobile": string,// Họ tên khách hàng"customerEmail": string,// Email khách hàng"customerAddress": string,// Địa chỉ khách hàng"shipToCityLocationId": int,// Mã thành phố"shipToDistrictLocationId": int,// Mã quận/huyện"shipToWardLocationId": int,// Mã phường/xã"customerCity": string,// Thành phố"customerDistrict": string,// Quận huyện"customerWard": string,// phường xã"createdById": int,// ID người tạo đơn"couponCode": string,// Mã coupon,"status": string,// trạng thái đơn hàng. VD: New | Confirming | CustomerConfirming,..."statusDescription": string,// status description. VD: Mới | Đang xác nhận | Chờ khách xác nhận,..."depotId": int // ID kho hàng trên Nhanh.vn"trackingUrl": string // Lịch trình đơn hàng"products": [ {"id": int,// ID sản phẩm trên Nhanh.vn"quantity": int,// số lượng sản phẩm đặt hàng"price": double,// giá sản phẩm"discount": double,// giá trị khuyến mại của sản phẩm"weight": int // trọng lượng của đơn hàng (tính bằng gram) do doanh nghiệp khai báo. }, {... },... ] }}
Khi cập nhật đơn hàng
Sự kiện khi người dùng sửa đơn, đổi trạng thái đơn hàng.
{"event": "orderUpdate","businessId": int,// ID doanh nghiệp trên Nhanh.vn"webhooksVerifyToken": string,// Key xác minh khi nhận dữ liệu, tương ứng với webhooks verify token trong app của bạn"data": {"businessId": int,//ID doanh nghiệp trên Nhanh.vn"orderId": int,// ID đơn hàng trên Nhanh.vn"shopOrderId": string,// shop order ID nếu đơn được bắn từ các hệ thống khác sang Nhanh.vn"status": string,// trạng thái đơn hàng. VD: New | Confirming | CustomerConfirming,..."statusDescription": string,// status description. VD: Mới | Đang xác nhận | Chờ khách xác nhận,..."depotId": int,// ID kho hàng trên Nhanh.vn,"reason": string // lý do đổi trạng thái đơn hàng. VD: Không gọi được khách | Sản phẩm lỗi,..."deliveryDate": string // Ngày giao hàng, định dạng: Y-m-d, VD: 2024-04-23,"trackingUrl": string // Lịch trình đơn hàng }}
Khi xóa đơn hàng
{"event": "orderDelete","businessId": int,// ID doanh nghiệp trên Nhanh.vn"webhooksVerifyToken": string,// Key xác minh khi nhận dữ liệu, tương ứng với webhooks verify token trong app của bạn"data": {"orderId1",// ID đơn hàng trên Nhanh"orderId2",// ID đơn hàng trên Nhanh... }}
