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 và toDate hoặc customerId hoặc customerMobile, 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)

Request

Param
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)
Trạng thái đơn hàng xem tại đây
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)
id hãng vận chuyển (Lấy từ /api/shipping/fee)
carrierCode
string(36) (optional)
Mã vận đơn hãng vận chuyển
type
string (optional)
Loại đơn hàng, giá trị có thể là: “Shipping” (Chuyển hàng) hoặc “Shopping” (Khách tới mua tại cửa hàng).“PreOrder”(Khách đặt hàng trước).Giá trị mặc định là Shipping.
shippingType
string (optional)
Loại chuyển hàng: - [G] Chuyển hàng tận nhà - [Đ] Đổi sản phẩm - [T] Khách trả lại hàng
customerCityId
int (optional)
Mã thành phố của người nhận hàng (Lấy từ /api/shipping/location)
customerDistrictId
int (optional)
Mã quận huyện của người nhận hàng (Lấy từ /api/shipping/location)
handoverId
int (optional)
ID biên bản bàn giao
depotId
int (optional)
ID kho hàng trên Nhanh.vn

Response

JSON decode the response to get the structure:
Param
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
1
data =
2
[
3
"totalPages" => int, // Tổng số trang
4
"totalRecords" => int, // Tổng số bản ghi tất cả các trang
5
"page" => int, // Trang hiện tại
6
"orders" => [ // Danh sách đơn hàng trang hiện tại
7
"orderId" => [
8
// Đơn hàng 1
9
"id" => int, // Id đơn hàng
10
"privateId" => string, // Id website tích hợp (deprecated, nên dùng key mới là shopOrderId)
11
"shopOrderId" => string, // Id website tích hợp
12
"depotId" => int, // Id kho hàng
13
"depotName" => string, // Tên kho hàng
14
"typeId" => int, // mã loại đơn hàng
15
"type" => string, // Loại đơn hàng (Shipping | Shopping)
16
"shippingTypeId" => int, //Mã loại chuyển hàng
17
"shippingType" => string, // Loại chuyển hàng
18
"moneyDiscount" => double, // Tiền chiết khấu
19
"moneyDeposit" => double, // Tiền đặt cọc
20
"moneyTransfer" => double, // Tiền chuyển khoản
21
"serviceId" => int, // Mã dịch vụ vận chuyển
22
"carrierId" => int, // Id hãng vận chuyển
23
"carrierCode" => string, // Mã hãng vận chuyển
24
"carrierName" => string, // Tên hãng vận chuyển
25
"carrierServiceName" => string, // Dịch vụ vân chuyển
26
"shipFee" => double, // Phí vận chuyển,
27
"codFee" => double, // Phí thu tiền hộ,
28
"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)
29
"customerShipFee" => double,// Phí thu của khách,
30
"returnFee" => double,// Phí chuyển hoàn,
31
"overWeightShipFee" => double,// Phí vượt cân,
32
"description" => string, // ghi chú của khách hàng
33
"privateDescription" string, // ghi chú nội bộ
34
"customerId" => int, // Mã khách hàng
35
"customerName" => string, // Tên khách hàng
36
"customerMobile" => string, // Họ tên khách hàng
37
"customerEmail" => string, // Email khách hàng
38
"customerAddress" => string, // Địa chỉ khách hàng
39
"customerCityId" => int, // Mã tỉnh
40
"customerCity" => string, // Thành phố
41
"customerDistrictId" => int, // Mã quận/huyện
42
"customerDistrict" => string, // Quận huyện
43
"createdById" => int, // ID người tạo đơn
44
"createdByName" => string,// Người tạo đơn
45
"createdDateTime" => string, // Thời gian tạo đơn hàng VD 2021-12-22 09:30:21
46
"deliveryDate" => string, // Ngày giao hàng, VD 2021-12-24
47
"statusCode" => string, // Mã trạng thái
48
"statusName" => string, // Trạng thái đơn hàng
49
"calcTotalMoney" => double, // Tổng thu của khách
50
"trafficSourceId" => int, // Id nguồn đơn hàng
51
"trafficSourceName" => string, // Tên nguồn đơn hàng
52
"saleId" => int, // ID nhân viên bán hàng
53
"saleName" => string, // Tên nhân viên bán hàng,
54
"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
55
"affiliateCode" => string, // mã giới thiệu
56
"affiliateBonusCash" => int, // tiền hoa hồng được hưởng theo mã giới thiệu
57
"affiliateBonusPercent" => int, // phần trăm hoa hồng được hưởng theo mã giới thiệu,
58
"tags" => array, // [tagName1, tagName2...] mảng các nhãn của đơn hàng
59
"saleChannel" => int, // Kênh bán hàng: 1 = Admin, 2 = Website, 10 = API, 20 = Facebook, 21 = Instagram, 40 = Vật Giá, 41 = Lazada, 42 = Shopee, 43 = Sendo, 44 = Adayroi, 45 = Tiki, 46 = Zalo, 47 = 1Landing.vn
60
"couponCode" => string, // Mã coupon,
61
"products" => array, // Xem bảng Order product bên dưới
62
],
63
"orderId" => [
64
// Đơn hàng 2
65
],
66
// ...
67
]
68
]
Copied!

Order product

1
[
2
"productId" => int, // ID sản phẩm
3
"productName" => string, // Tên sản phẩm
4
"productCode" => int, // Mã sản phẩm
5
"productBarcode" => string, // Mã vạch sản phẩm
6
"price" => double, // Giá sản phẩm
7
"quantity" => double, // Số lượng sản phẩm
8
"weight" => int , // Trọng lượng sản phẩm
9
"imei" => string, // IMEI của sản phẩm
10
"discount" => double, // Chiết khấu theo sản phẩm
11
"description" => string, // Mô tả sản phẩm
12
],
13
[
14
// Sản phẩm 2
15
],
16
// ...
Copied!