Nhanh.vn Open API
Trang chủHướng dẫn sử dụngApps
v2
v2
  • Giới thiệu
  • Change log
  • Product
    • Danh sách sản phẩm
    • Thêm sản phẩm
    • Chi tiết sản phẩm
    • Danh mục sản phẩm
    • Danh mục nội bộ
    • Quà tặng sản phẩm
    • Danh sách IMEI
    • Tra cứu IMEI bán ra theo ngày
    • Lịch sử IMEI
    • Hạn sử dụng sản phẩm
    • Thêm ảnh sản phẩm
  • Order
    • Danh sách đơn hàng
    • Thêm đơn hàng
    • Cập nhật đơn hàng
    • Gửi khiếu nại đơn hàng
    • Lịch sử đơn hàng
    • Nguồn đơn hàng
  • Shipping
    • Hãng vận chuyển
    • Thành phố, quận huyện
    • Tính phí vận chuyển
  • Bill
    • Phiếu xuất nhập kho
    • Sản phẩm xuất nhập kho
    • Sản phẩm xuất nhập kho nháp
  • Customer
    • Danh sách khách hàng
    • Thêm khách hàng
  • Website
    • Tin tức
    • Danh mục tin tức
    • Thêm subscriber
    • Thêm liên hệ
  • Supplier
    • Nhà cung cấp
  • Promotion
    • Danh sách coupon
  • Store
    • Kho hàng
    • Nhân viên
  • Accounting
    • Bút toán
    • Công nợ khách hàng
  • Zalo
    • Gửi tin Zalo ZNS
  • Ecommerce
    • Danh sách gian hàng
  • Webhooks
    • Giới thiệu
    • Đơn hàng
    • Sản phẩm
    • Tồn kho
Powered by GitBook
On this page
  • Request
  • Response
  • Order product
  • Sale channels

Was this helpful?

  1. Order

Danh sách đơn hàng

PreviousThêm ảnh sản phẩmNextThêm đơn hàng

Last updated 2 days ago

Was this helpful?

  • /api/order/index: Tính năng này dùng để lấy danh sách đơn hàng.

  • Chú ý:

    • Hệ thống chỉ hỗ trợ lấy đơn hàng trong 10 ngày.

    • Hệ thống đang hỗ trợ lọc dữ liệu theo 3 loại ngày:

      • fromDate, toDate: Lọc theo ngày tạo đơn hàng.

      • fromDeliveryDate, toDeliveryDate: Lọc theo ngày giao hàng.

      • updatedDateTimeFrom, updatedDateTimeTo: Lọc theo ngày cập nhật đơn hàng.

    • Nếu bạn không truyền param fromDate mặc định sẽ lấy 10 ngày gần nhất. Nếu bạn muốn lấy dữ liệu các ngày cũ hơn, xin vui lòng truyền fromDate và toDate trong khoảng 10 ngày (VD: 2020-09-01 => 2020-09-10, 2020-09-11 => 2020-09-20).

    • Nếu bạn lọc theo id hoặc customerId hoặc customerMobile thì có thể bỏ qua việc bắt buộc lọc fromDate, toDate.

    • Nếu bạn hay thường xuyên cần gọi toàn bộ đơn hàng, bạn nên lưu giá trị thời gian lần cuối cùng quét toàn bộ, sau đó dùng 2 request params là updatedDateTimeFrom và updatedDateTimeTo để chỉ lấy về các đơn hàng có cập nhật mới, không cần gọi lại toàn bộ đơn cũ không có thay đổi gì. updatedDateTimeFrom và updatedDateTimeTo cũng bị giới hạn trong vòng 10 ngày, khi bạn lọc theo updatedDateTimeFrom và updatedDateTimeTo sẽ không bị bắt buộc có fromDate và toDate nữa.

Request

  • Xem các

  • VD dùng Postman lấy đơn hàng tạo trong ngày 2022-06-16, có phân trang, lấy dữ liệu ở trang 2:

  • Các key của mảng data array dùng để tạo data json string:

Key
Type
Description

page

int

Phân trang (giá trị mặc định là 1)

icpp

int

Số lượng đơn hàng trên 1 trang. Mặc định là 100. Tối đa 100.

fromDate

string

Ngày tạo đơn hàng: Định dạng y-m-d.

toDate

string

Ngày tạo đơn hàng: Định dạng y-m-d.

id

int

ID đơn hàng trên Nhanh.vn

customerMobile

string

điện thoại của người nhận hàng

customerId

int

Tìm kiếm theo ID khách hàng

statuses

array

fromDeliveryDate

string

Định dạng: Y-m-d. Ngày giao hàng

toDeliveryDate

string

Định dạng: Y-m-d. Ngày giao hàng

carrierId

int

carrierCode

string(36)

Mã vận đơn hãng vận chuyển

type

int

Loại đơn hàng: 1 = Giao hàng tận nhà. 12 = Đổi sản phẩm. 14 = Khách trả lại hàng. 15 = Hàng chuyển kho. 16 = Đơn hoàn một phần. 17 = Đền bù mất hàng. 2 = Mua tại quầy. 3 = Đặt trước. 4 = Dùng thử. 5 = Đổi quà. 10 = Xin báo giá.

customerCityId

int

customerDistrictId

int

handoverId

int

ID biên bản bàn giao

depotId

int

ID kho hàng trên Nhanh.vn

updatedDateTimeFrom

string

Định dạng: Y-m-d H:i:s, Vd: 2022-05-25 00:00:00 Ngày cập nhật đơn hàng từ ngày

updatedDateTimeTo

string

Định dạng: Y-m-d H:i:s, Vd: 2022-05-30 23:59:00 Ngày cập nhật đơn hàng đến ngày

dataOptions

array

Lựa chọn dữ liệu cần lấy thêm, VD "dataOptions":["giftProducts"]. Các giá trị: - giftProducts: Lấy thông tin quà tặng của sản phẩm trong đơn hàng. - marketingUtm: Lấy thông tin utmSource, utmMedium, utmCampaign. - productBatchs: Lấy thông tin sản phẩm lô: Tên lô, ngày hết hạn lô.

Response

JSON decode the response to get the structure:

Key
Type
Description

code

int

1 = success or 0 = failed

messages

[ ]

is an array of error messages if code = 0

data

[ ]

Mảng danh sách đơn hàng

data =
[
    "totalPages" => int, // Tổng số trang
    "totalRecords" => int, // Tổng số bản ghi tất cả các trang
    "page" => int, // Trang hiện tại
    "orders" => { // Danh sách đơn hàng trang hiện tại
         "orderId" => {
            // Đơn hàng 1
            "id" => int, // Id đơn hàng
            "privateId" => string, // Id website tích hợp (deprecated, nên dùng key mới là shopOrderId)
            "shopOrderId" => string, // Id website tích hợp
            "merchantTrackingNumber" => string, // Mã vận đơn web tích hợp
            "handoverId" => int, // Id biên bản
            "depotId" => int, // Id kho hàng
            "depotName" => string, // Tên kho hàng
            "typeId" => int, // mã loại đơn hàng
            "type" => string, // Loại đơn hàng (Shipping | Shopping)
            "moneyDiscount" => double, // Tiền chiết khấu
            "moneyDeposit" => double, // Tiền đặt cọc
            "moneyTransfer" => double, // Tiền chuyển khoản
            "usedPoints" => int, // Số điểm đã tiêu
            "moneyUsedPoints" => double, // Số tiền tiêu điểm đã tiêu
            "usedPointAmount" => int, // Số tiền tiêu điểm đã tiêu
            "serviceId" => int, // Mã dịch vụ vận chuyển
            "carrierId" => int, // Id hãng vận chuyển
            "carrierServiceType" => int, // Giá trị loại dịch vụ (5: Hỏa tốc, 10: Nhanh, 15: Tiết kiệm)
            "carrierServiceTypeName" => string, // Tên loại dịch vụ
            "carrierCode" => string, // Mã vận đơn, đơn hàng đã bắn sang hãng vận chuyển mới có thông tin mã vận đơn.
            "carrierName" => string, // Tên hãng vận chuyển
            "carrierServiceName" => string, // Dịch vụ vân chuyển
            "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)
            "customerShipFee" => double,// Phí thu của khách,
            "returnFee" => double,// Phí chuyển hoàn,
            "overWeightShipFee" => double,// Phí vượt cân,
            "description" => string, // ghi chú của khách hàng
            "privateDescription" string, // ghi chú nội bộ
            "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
            "customerCityId" => int, // Mã tỉnh
            "customerCity" => string, // Thành phố
            "customerDistrictId" => int, // Mã quận/huyện
            "customerDistrict" => string, // Quận huyện
            "createdById" => int, // ID người tạo đơn
            "createdByName" => string,// Người tạo đơn
            "createdDateTime" => string, // Thời gian tạo đơn hàng VD 2021-12-22 09:30:21
            "deliveryDate" => string, // Ngày giao hàng, VD 2021-12-24
            "statusCode" => string, // Mã trạng thái
            "statusName" => string, // Trạng thái đơn hàng
            "calcTotalMoney" => double, // Tổng thu của khách
            "trafficSourceId" => int, // Id nguồn đơn hàng
            "trafficSourceName" => string, // Tên nguồn đơn hàng
            "saleId" => int, // ID nhân viên bán hàng
            "saleName" => string, // Tên nhân viên bán hàng,
            "returnFromOrderId" => int, // với đơn loại trả hàng, có thể có thêm thuộc tính này để biết trả từ đơn hàng nào
            "affiliateCode" => string, // mã giới thiệu
            "affiliateBonusCash" => int, // tiền hoa hồng được hưởng theo mã giới thiệu
            "affiliateBonusPercent" => int, // phần trăm hoa hồng được hưởng theo mã giới thiệu,
            "tags" => array, // [tagName1, tagName2...] mảng các nhãn của đơn hàng
            "saleChannel" => int, // Kênh bán phát sinh đơn hàng. Xem bảng Sale channels bên dưới
            "ecomShopId" => string // ID shop ecommerce
            "couponCode" => string, // Mã coupon,
            "products" => array, // Xem bảng Order product bên dưới
            "utmSource" => string, // utm Source,
            "utmMedium" => string, // utm Medium,
            "utmCampaign" => string, // utm Campaign
            "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
                "psId" => string // FB PSID
            ],
            "updatedAt" => int, // ngày cập nhật đơn hàng, định dạng timestamp
            "packed" => [
                "id" => int, // ID người đóng gói
                "datetime" => string // Thời gian đóng gói
            ],
        },
        "orderId" => {
            // Đơn hàng 2
        },
        // ...
    }
]
  • Chú ý:

    • Phí trả hãng vận chuyển bằng tổng tất cả các loại phí: shipFee + codFee + declaredFee + returnFee + overWeightShipFee.

Order product

    [
        "productId" => int, // ID sản phẩm
        "productName" => string, // Tên sản phẩm
        "productCode" => int, // Mã sản phẩm
        "productBarcode" => string, // Mã vạch sản phẩm
        "price" => double, // Giá sản phẩm
        "quantity" => double, // Số lượng sản phẩm
        "weight" => int , // Trọng lượng sản phẩm
        "imei" => string, // IMEI của sản phẩm
        "vat" => int, // VAT của sản phẩm
        "discount" => double, // Chiết khấu theo sản phẩm
        "description" => string, // Mô tả sản phẩm
        "giftProducts" => array, // thông tin quà tặng sản phẩm
        "batch" => array, // thông tin lô hàng sản phẩm
        "comboItems" => array, // thông tin sản phẩm con của sản phẩm combo
        "productMoney" => int, // Tổng tiền sản phẩm sau khi cộng VAT, trừ chiết khấu
        "priceOriginal" => double // Giá gốc của sản phẩm,
        "avgCost" => double // Giá vốn của sản phẩm
    ],
    [
        // Sản phẩm 2
    ],
    // ...

Sale channels

  • Danh sách các kênh bán

Sale channel ID
Sale channel

1

Admin

2

Website

10

API

20

21

41

Lazada.vn

42

Shopee.vn

43

Sendo.vn

45

Tiki.vn

46

Zalo Shop

47

1Landing.vn

48

Tiktok Shop

49

50

51

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

id hãng vận chuyển (Lấy từ )

Mã thành phố của người nhận hàng (Lấy từ )

Mã quận huyện của người nhận hàng (Lấy từ )

Facebook (Khi tạo đơn hàng từ )

Instagram (Khi tạo đơn hàng từ )

Zalo OA (Khi tạo đơn hàng từ )

Shopee Chat (Khi tạo đơn hàng từ )

Lazada Chat (Khi tạo đơn hàng từ )

/api/shipping/fee
/api/shipping/location
/api/shipping/location
vpage.nhanh.vn
vpage.nhanh.vn
vpage.nhanh.vn
vpage.nhanh.vn
vpage.nhanh.vn
tại đây
common request params
/api/order/index Postman sample