Danh sách đơn hàng
- /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. 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.
- 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:
/api/order/index Postman sample
- Các key của mảng data array dùng để tạo data json string:
Key | Type | Description |
|---|---|---|
page | int (optional) | Phân trang (giá trị mặc định là 1) |
fromDate | string (optional) | Ngày tạo đơn hàng: Định dạng y-m-d. |
toDate | string (optional) | Ngày tạo đơn hàng: Định dạng y-m-d. |
id | int (optional) | ID đơn hàng trên Nhanh.vn |
customerMobile | string (optional) | điện thoại của người nhận hàng |
customerId | int (optional) | Tìm kiếm theo ID khách hàng |
statuses | array (optional) | |
fromDeliveryDate | string (optional) | Định dạng: Y-m-d. Ngày giao hàng |
toDeliveryDate | string (optional) | Định dạng: Y-m-d. Ngày giao hàng |
carrierId | int (optional) | |
carrierCode | string(36) (optional) | Mã vận đơn hãng vận chuyển |
type | int (optional) | 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 (optional) | |
customerDistrictId | int (optional) | |
handoverId | int (optional) | ID biên bản bàn giao |
depotId | int (optional) | ID kho hàng trên Nhanh.vn |
updatedFromDateTime | string (optional) | Đị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 |
updatedToDateTime | string (optional) | Đị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 (optional) | 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 |
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
"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
"serviceId" => int, // Mã dịch vụ vận chuyển
"carrierId" => int, // Id hãng vận chuyển
"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
"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
},
"orderId" => {
// Đơn hàng 2
},
// ...
}
]
[
"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
"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
],
[
// Sản phẩm 2
],
// ...
- 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 |
Last modified 2mo ago