Order

• 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.

• 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 lấy danh sách đơn hàng.

Khi có đơn hàng mới

Key	Type	Description
event	string	event webhooks, giá trị: orderAdd
businessId	int	ID doanh nghiệp trên Nhanh.vn
data	array	Mảng dữ liệu đơn hàng, xem data bên dưới

{
    "event": "orderAdd",
    "businessId": int, // ID doanh nghiệp trên Nhanh.vn
    "data": array // Xem data bên dưới
}

Khi cập nhật đơn hàng

Key	Type	Description
event	string	event webhooks, giá trị: orderUpdate
businessId	int	ID doanh nghiệp trên Nhanh.vn
data	array	Mảng dữ liệu đơn hàng, xem data bên dưới

{
    "event": "orderUpdate",
    "businessId": int, // ID doanh nghiệp trên Nhanh.vn
    "data": array // Xem data bên dưới
}

Khi xóa đơn hàng

Key	Type	Description
event	string	event webhooks, giá trị: orderDelete
businessId	int	ID doanh nghiệp trên Nhanh.vn
data	array	Mảng ID đơn hàng đã xóa

{
    "event": "orderDelete",
    "businessId": int, // ID doanh nghiệp trên Nhanh.vn
    "data": [
      "orderId1",
      "orderId2",
      ...
    ]
}

Data

Một mảng thông tin đơn hàng bao gồm:

{
    "depot": {
      "id": int, // ID kho hàng trên Nhanh.vn
      "name": string, // Tên kho hàng
      "mobile": string, // Số điện thoại kho hàng
      "address": string, // Địa chỉ kho hàng
      "pickupDepot": {
        "id": int, // ID kho nhận hàng
        "name": string, // Tên kho nhận hàng
        "mobile": string, // Số điện thoại kho nhận hàng
        "address": string // Địa chỉ kho nhận hàng
      }
    },
    "sender": {
      "name": string, // Tên người gửi hàng
      "email": string, // Email người gửi hàng
      "mobile": string, // Số điện thoại người gửi hàng
      "address": string, // Địa chỉ người gửi hàng
      "locations": {
        "cityId": int, // Thành phố người gửi hàng
        "districtId": int, // Quận huyện người gửi hàng
        "wardId": int, // Phường xã người gửi hàng
      }
    },
    "customer": {
      "id": int, // ID người nhận hàng
      "name": string, // Tên người :nhận hàng
      "email": string, // Email người :nhận hàng
      "mobile": string, // Số điện thoại người nhận hàng
      "address": string, // Địa chỉ người nhận hàng
      "locations": {
        "cityId": int, // Thành phố người nhận hàng
        "districtId": int, // Quận huyện người nhận hàng
        "wardId": int, // Phường xã người nhận hàng
      }
    },
    "info": {
      "id": int, // ID đơn hàng trên Nhanh
      "type": int, // Loại đơn hàng
      "returnFromOrderId": int, // ID đơn trả
      "status": int, // Trạng thái đơn hàng
      "discount": double, // Tiền chiết khấu đơn hàng
      "couponCode": string, // Mã coupon
      "usedPoints": {
        "points": double, // Số điểm đã tiêu
        "amount": double // Số tiền quy đổi từ điểm
      },
      "vat": {
        "percent": double, // Phần trăm VAT
        "amount": double // Giá trị VAT
      },
      "paymentMethod": int, // Phương thức thanh toán
      "createdBy": {
        "id": int, // ID người tạo đơn hàng
        "name": string // Tên người tạo đơn hàng
      },
      "sale": {
        "id": int, // ID nhân viên bán hàng
        "name": string // Tên nhân viên bán hàng
      },
      "technicalStaff": {
        "id": int, // ID nhân viên kỹ thuật
        "name": string // Tên nhân viên kỹ thuật
      },
      "customerCare": {
        "id": int, // ID nhân viên chăm sóc khách hàng
        "name": string // Tên nhân viên chăm sóc khách hàng
      },
      "createdAt": int, // Thời gian tạo đơn hàng (định dạng timestamp)
      "updatedAt": int, // Thời gian cập nhật đơn hàng (định dạng timestamp)
      "confirmedAt": int, // Thời gian xác nhận đơn hàng (định dạng timestamp)
      "packedAt": int, // Thời gian đóng gói đơn hàng (định dạng timestamp)
      "description": string, // Ghi chú đơn hàng
      "orderPartDeliveries": [ // Giao hàng 1 phần
        {
          "id": int, // Id đơn hàng
          "type": int, // Loại đơn hàng
          "totalQuantity": double, // Số lượng sản phẩm trong đơn
          "totalProductAmount": double, // Tổng tiền sản phẩm trong đơn
          "status": int // Trạng thái đơn
        }
      ]
    },
    "products": [
      {
        "id": int, // ID sản phẩm
        "typeId": int, // ID loại sản phẩm
        "code": string, // Mã sản phẩm
        "name": string, // Tên sản phẩm
        "avatar": string, // Ảnh đại diện sản phẩm
        "weight": double, // Khối lượng sản phẩm
        "quantity": double, // Số lượng sản phẩm
        "price": double, // Giá sản phẩm
        "discount": {
          "percent": double, // Phần trăm khuyến mại sản phẩm
          "amount": double // Giá trị khuyến mại sản phảm
        },
        "available": double, // Số lượng có thể bán
        "avgCost": double, // Giá vốn sản phẩm
        "vat": {
          "percent": double, // Phần trăm VAT sản phẩm
          "amount": double // Giá trị VAT sản phẩm
        },
        "description": string, // Ghi chú sản phẩm
        "imei": string, // IMEI sản phẩm
        "batch": { // Lô sản phẩm
          "id": int, // ID lô sản phẩm
          "name": string, // Tên lô sản phẩm
          "manufactureDate": string, // Ngày sản xuất
          "expiredDate": string // Hạn sử dụng
        },
        "combos": [ // Sản phẩm combo
          {
            "id": int, // ID sản phẩm combo
            "name": string, // Tên sp combo
            "quantity": double // Số lượng sản phẩm combo
          } 
        ],
        "unit": { // Sản phẩm đơn vị tính
          "id": int, // ID đơn vị tính
          "name": string, // Tên đơn vị tính
          "quantity": double // Số lượng quy đổi
        },
        "gifts": [ // Quà tặng
          {
            "id": int, // ID quà tặng
            "name": string, // Tên quà tặng
            "quantity": double // Số lượng quà tặng
          }
        ]
      }
    ],
    "carrier": {
      "id": int, // ID hãng vận chuyển
      "name": string, // Tên hãng vận chuyển
      "service": {
        "name": string, // Tên dịch vụ
        "code": string // mã dịch vụ
      },
      "carrierCode": string, // Mã vận đơn
      "isPartDelivery": int, // Giao hàng 1 phần
      "sendCarrier": {
        "type": int, // Loại gửi hàng
        "date": string // Ngày gửi hàng
      },
      "deliveryDate": string, // Ngày giao hàng
      "weight": double, // Trọng lượng đơn hàng
      "shipFee" => double, // Phí vận chuyển,
      "codFee" => double, // Phí thu tiền hộ,
      "declaredFee" => double, // Phí bảo hiểm (Nếu đơn có mua bảo hiểm và hãng có thu phí bảo hiểm)
      "returnFee": double, // Phí chuyển hoàn
      "customerShipFee": double, // Phí thu của khách
    },
    "channel": {
        "ecomOrderId": int, // ID đơn sàn TMĐT
        "ecomShopName": string, // Tên gian hàng sàn TMĐT
        "saleChannel": int, // Kênh bán
        "trafficSource": { // Nguồn đơn hàng
          "id": int, // ID nguồn đơn hàng
          "name": string // Tên nguồn đơn hàng
        },
        "facebook": {
          "pageId" => string, // FB page id
          "conversationId" => string, // id hội thoại trên Vpage
          "adId" => string, // id quảng cáo mới nhất của hội thoại tạo ra đơn hàng
          "postId" => string // id bài viết trên FB
        },
        "utmCampaign": string, // utm campaign
        "domain": string // Website phát sinh đơn hàng
    }
}