Đơn hàng

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

  • Cấu trúc dữ liệu sẽ giống với thông tin 1 đơn hàng khi bạn gọi API lấy danh sách đơn hàng.

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

  • Xem cấu trúc chung của webhooks tại đây.

Order add

{
    "event": "orderAdd",
    "businessId": 10000,
    "data": {}
}

Order update

{
    "event": "orderUpdate",
    "businessId": 10000,
    "data": {}
}

Order delete

  • data sẽ chứa mảng orderId đã bị xóa.

{
    "event": "orderDelete",
    "businessId": 10000,
    "data": [12345, 12346]
}

Order information

  • Thông tin đơn hàng

{
  "depot": {
    "id": "(int) ID kho hàng",
    "name": "(string) Tên kho",
    "mobile": "(string) Số điện thoại",
    "address": "(string) Địa chỉ",
    "location": "(string) Phường Thổ Quan, Quận Đống Đa, Hà Nội",
    "pickup": {
      "id": "(int) ID kho lấy hàng",
      "name": "(string) Tên kho lấy hàng",
      "mobile": "(string) Số điện thoại kho lấy hàng",
      "address": "(string) Địa chỉ kho lấy hàng",
      "location": "(string) Phường xã, Quận/huyện, Tỉnh/Thành phố lấy hàng"
    }
  },
  "info": {
    "id": "(int) ID đơn hàng",
    "type": "(int) Loại đơn",
    "mope": "(int) Loại giá bán",
    "exportType": "(int) Đánh dấu đơn hàng đã xuất kho thủ công hay chưa",
    "originalOrderId": "(int) ID đơn đền bù mất hàng",
    "returnFromId": "(int) Hoàn từ ID đơn hàng",
    "idReturn": "(int) Trả từ ID đơn hàng",
    "createdByName": "(string) Người tạo",
    "createdById": "(int) ID người tạo",
    "saleName": "(string) Nhân viên bán hàng",
    "saleId": "(int) ID nhân viên bán hàng",
    "packedByName": "(string) Nhân viên đóng gói",
    "packedById": "(string) ID nhân viên đóng gói",
    "customerCareId": "(int) ID nhân viên chăm sóc",
    "customerCareName": "(string) Nhân viên chăm sóc",
    "createdAt": "(int) Ngày tạo đơn hàng",
    "updatedAt": "(int) Ngày giờ cập nhật thông tin cuối cùng",
    "confirmedAt": "(int) Ngày giờ xác nhận",
    "packedAt": "(int) Ngày giờ đóng gói",
    "description": "(string) Ghi chú dơn hàng",
    "privateDescription": "(string) Ghi chú của chăm sóc khách hàng",
    "orderIndex": "(int) Số thứ tự đơn trong ngày",
    "status": "(int) Trạng thái đơn hàng",
    "reason": "(int) Lý do hủy đơn hàng",
    "handoverIds": "(array) Mảng ID biên bản bàn giao",
    "tags": [
      {
        "id": "(int) ID nhãn",
        "name": "(string) Tên nhãn",
        "textColor": "(string) Màu chữ",
        "bgColor": "(string) Màu nền",
        "status": "(int) Trạng thái"
      }
    ]
  },
  "channel": {
    "appOrderId": "(string) ID website tích hợp",
    "saleChannel": "(int) Kênh bán",
    "trafficSource": "(string) Nguồn đơn hàng",
    "pageId": "(string) Tạo từ pageId",
    "conversationId": "(string) Tạo từ cuộc trò chuyện",
    "fbAdsId": "(int) Facebook ads ID",
    "fbPsid": "(int) Facebook PSID",
    "domain": "(string) Tên miền",
    "shopName": "(string) Tên gian hàng",
    "shopId": "(string) ID gian hàng",
    "affiliate": {
      "code": "(string) Mã affiliate",
      "value": "(double) Giá trị affiliate",
      "bonus": "(double) Hoa hồng affiliate",
      "bonusRate": "(double) Phần trăm Hoa hồng affiliate"
    },
    "marketting": {
      "utmSource": "(string) Utm Source",
      "utmMedium": "(string) Utm Medium",
      "utmCampaign": "(string) Utm Campaign"
    }
  },
  "shippingAddress": {
    "id": "(int) ID khách hàng",
    "code": "(string) Mã khách hàng",
    "name": "(string) Tên khách hàng",
    "mobile": "(string) Số điện thoại khách hàng",
    "email": "(string) Email khách hàng",
    "address": "(string) Địa chỉ khách hàng",
    "birthday": "(string) Ngày sinh khách hàng",
    "cityId": "(int) ID tỉnh/thành phố",
    "districtId": "(int) ID quận/huyện",
    "wardId": "(int) ID phường/xã",
    "location": "(string) Phường xã, Quận/huyện, Tỉnh/Thành phố"
  },
  "products": [
    {
      "id": "(int) ID sản phẩm",
      "typeId": "(int) Loại sản phẩm",
      "code": "(string) Mã sản phẩm",
      "name": "(string) Tên sản phẩm",
      "appProductId": "(string) ID sản phẩm website tích hợp",
      "weight": "(int) Trọng lượng",
      "quantity": "(double) Số lượng",
      "originalQuantity": "(double) Số lượng ban đầu đã mua",
      "price": "(double) Giá bán",
      "discount": "(double) Chiết khấu",
      "avgCost": "(double) Giá vốn",
      "vat": "(double) Giá trị VAT",
      "description": "(string) Ghi chú",
      "imeiId": "(int) ID IMEI sản phẩm đã bán",
      "imei": "(string) IMEI đã bán",
      "priceListName": "(string) Tên bảng giá áp dụng",
      "transactionFee": "(double) Phí giao dịch",
      "paymentStatus": "(int) Trạng thái thanh toán",
      "partialReturnStatus": "(int) Trạng thái trả hàng giao một phần",
      "usedPoints": "(int) Số điểm đã tiêu",
      "usedPointAmount": "(double) Số tiền tương ứng số điểm đã tiêu",
      "batch": {
        "id": "(int) ID lô hàng",
        "name": "(string) Tên lô hàng",
        "manufactureDate": "(string) Ngày sản xuất",
        "expiredDate": "(string) Ngày hết hạn"
      },
      "unit": {
        "id": "(int) ID đơn vị tính",
        "name": "(string) Tên đơn vị tính",
        "quantity": "(double) Số lượng",
        "originalQuantity": "(double) Số lượng ban đầu đã mua",
        "price": "(double) Giá bán"
      },
      "gifts": [
        {
          "id": "(int) ID sản phẩm",
          "name": "(string) Tên sản phẩm",
          "quantity": "(double) Số lượng",
          "originalQuantity": "(double) Số lượng ban đầu đã tặng"
        }
      ],
      "combos": [
        {
          "id": "(int) ID sản phẩm",
          "code": "(string) Mã sản phẩm",
          "name": "(string) Tên sản phẩm",
          "quantity": "(double) Số lượng"
        }
      ]
    }
  ],
  "carrier": {
    "id": "(int) ID Hãng vận chuyển",
    "name": "(string) Tên hãng vận chuyển",
    "service": {
      "id": "(int) ID dịch vụ vận chuyển",
      "name": "(string) Tên dịch vụ vận chuyển",
      "code": "(string) Mã dịch vụ vận chuyển",
      "type": "(int) Loại dịch vụ vận chuyển"
    },
    "carrierCode": "(string) Mã vận đơn",
    "fullCarrierCode": "(string) Mã vận đơn đầy đủ",
    "carrierSortCode": "(string) Mã chia vận đơn",
    "packageCode": "(string) Mã gói hàng",
    "checkGoods": "(string) Kiểm tra hàng hóa",
    "sendCarrierType": "(int) Hình thức kết nối vận chuyển",
    "sendCarrierAt": "(string) Ngày gửi vận chuyển",
    "deliveryAt": "(string) Ngày giao hàng thành công",
    "isPartDelivery": "(int) 1: Đơn giao hàng một phần, 0: Không giao hàng một phần",
    "isDeclaredFee": "(int) 1: Khai giá, 0: Không khai giá",
    "declaredValue": "(double) Giá trị khai giá",
    "declaredFee": "(double) Phí khai giá",
    "carrierPromotionCode": "(string) Mã khuyến mại vận chuyển",
    "weight": "(int) Trọng lượng đơn hàng khai báo",
    "carrierWeight": "(int) Trọng lượng hãng vận chuyển trả về",
    "shipFee": "(double) Phí vận chuyển trả hãng vận chuyển",
    "codFee": "(double) Phí thu tiền hộ",
    "overWeightShipFee": "(double) Phí vượt cân",
    "returnFee": "(double) Phí chuyển hoàn",
    "customerShipFee": "(double) Phí ship báo khách",
    "ecomFee": "(double) Tổng các loại phí trên sàn",
    "carrierPaymentStatus": "(int) Trạng thái đối soát đơn hàng với hãng vận chuyển"
  },
  "payment": {
    "depositAmount": "(double) Tiền đặt cọc",
    "depositAccountId": "(int) ID tài khoản kế toán ứng với tiền đặt cọc",
    "transferAmount": "(double) Tiền chuyển khoản",
    "transferAccountId": "(int) ID tài khoản kế toán ứng với tiền chuyển khoản",
    "installmentAmount": "(double) Tiền trả góp",
    "installmentAccountId": "(int) ID tài khoản kế toán ứng với tiền trả góp",
    "creditAmount": "(double) Tiền quẹt thẻ",
    "creditAccountId": "(int) ID tài khoản kế toán ứng với tiền quẹt thẻ",
    "discount": "(double) Chiết khấu",
    "discountType": "(string) Loại chiết khấu",
    "couponCode": "(string) Mã giảm giá",
    "usedPoints": "(int) Số điểm đã tiêu",
    "usedPointAmount": "(double) Số tiền tương ứng số điểm đã tiêu",
    "vat": "(double) Giá trị VAT",
    "vatAmount": "(double) Số tiền VAT",
    "vatType": "(string) cash: Tiền mặt, percent: Phần trăm",
    "taxCode": "(string) Mã số thuế",
    "taxDate": "(string) Ngày xuất hóa đơn VAT",
    "debtDueDate": "(string) Ngày hẹn thanh toán",
    "paymentMethod": "(int) Hình thức thanh toán",
    "paymentCode": "(string) Mã thanh toán",
    "paymentGateway": "(string) Cổng thanh toán",
    "totalAmount": "(double) Tổng thu khách hàng",
    "payForSend": "(double) Tiền trả Shop",
    "businessPaymentStatus": "(int) Trạng thái thanh toán tiền với doanh nghiệp"
  }
}

Last updated