v1
Get data from Nhanh.vn
Send data to Nhanh.vn
Lấy 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
- The search param - (Data array)
Param
Type
Required
Description
page
int
No
Phân trang (giá trị mặc định là 1)
fromDate
string
No
Ngày tạo đơn hàng: Định dạng y-m-d.
toDate
string
No
Ngày tạo đơn hàng: Định dạng y-m-d.
id
int
No
ID đơn hàng trên Nhanh.vn
customerMobile
string
No
điện thoại của người nhận hàng
fromDeliveryDate
string
No
Định dạng: y-m-d. Ngày giao hàng
toDeliveryDate
string
No
Định dạng: y-m-d. Ngày giao hàng
carrierCode
string(36)
No
Mã vận đơn hãng vận chuyển
type
string
No
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
No
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
handoverId
int
No
ID biên bản bàn giao
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
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
[
8
// Đơn hàng 1
9
"id": int, // ID đơn hàng
10
"privateId": string, // ID website tích hợp
11
"depotId": int, // Mã kho
12
"depotName": string, // Tên Cửa hàng
13
"typeId": int, //mã loại đơn hàng
14
"type": string, // Loại đơn hàng (Shipping | Shopping)
15
"shippingTypeId": int, //Mã loại chuyển hàng
16
"shippingType": string, // Loại chuyển hàng
17
"moneyDiscount": double, // Tiền chiết khấu
18
"moneyDeposit": double, // Tiền đặt cọc
19
"moneyTransfer": double, // Tiền chuyển khoản
20
"serviceId": int, // Mã dịch vụ vận chuyển
21
"carrierId": int, // ID hãng vận chuyển
22
"carrierCode": string, // Mã hãng vận chuyển
23
"carrierName": string, // Tên hãng vận chuyển
24
"shipFee": double, // Phí vận chuyển,
25
"codFee": double, // Phí thu tiền hộ,
26
"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)
27
"customerShipFee": double,// Phí thu của khách,
28
"returnFee": double,// Phí chuyển hoàn,
29
"overWeightShipFee": double,// Phí vượt cân,
30
"carrierServiceName": string, // Dịch vụ vân chuyển
31
"description": string, // ghi chú của khách hàng
32
"privateDescription" string, // ghi chú của CSKH
33
"customerId": int, // Mã khách hàng
34
"customerName": string, // Tên khách hàng
35
"customerMobile": string, // Họ tên khách hàng
36
"customerEmail": string, // Email khách hàng
37
"customerAddress": string, // Địa chỉ khách hàng
38
"customerCityId": int, // Mã tỉnh
39
"customerCity": string, // Thành phố
40
"customerDistrictId": int, // Mã quận/huyện
41
"customerDistrict": string, // Quận huyện
42
"createdById" : int, // ID người tạo đơn
43
"createdByName": string,// Người tạo đơn
44
"createdDateTime": string, // Thời gian tạo đơn hàng
45
"deliveryDate": string, // Thời gian giao đơn hàng
46
"statusCode": string, // Mã trạng thái
47
"statusName": string, // Trạng thái đơn hàng
48
"calcTotalMoney" : double, // Tổng thu của khách
49
"trafficSourceId" : int // Id nguồn đơn hàng
50
"trafficSourceName" : string // Tên nguồn đơn hàng
51
"saleId": int // ID nhân viên bán hàng
52
"saleName": string // Tên nhân viên bán hàng,
53
"products": array, // Xem bảng Order product bên dưới,
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
"channel" : int // Kênh bán,
56
"affiliateCode" : string // mã giới thiệu
57
"affiliateBonusCash" : int // tiền hoa hồng được hưởng theo mã giới thiệu
58
"affiliateBonusPercent" : int, // phần trăm hoa hồng được hưởng theo mã giới thiệu
59
"tags": array, // Xem bảng Order tags bên dưới,
60
"saleChannel": string // Kênh bán hàng
61
],
62
[
63
// Đơn hàng 2
64
],
65
// ...
66
]
67
]
Copied!
Order Product
1
[
2
[
3
"productId": int, // ID sản phẩm
4
"productName": string, // Tên sản phẩm
5
"productCode": int, // Mã sản phẩm
6
"productBarcode": string, // Mã vạch sản phẩm
7
"price": double, // Giá sản phẩm
8
"quantity": double, // Số lượng sản phẩm
9
"weight": int , // Trọng lượng sản phẩm
10
"imei": string, // IMEI của sản phẩm
11
"discount": double, // Chiết khấu theo sản phẩm
12
"description": string, // Mô tả sản phẩm
13
],
14
[
15
// Sản phẩm 2
16
],
17
// ...
18
]
Copied!
Order tags
1
[
2
'Nhãn 1'
3
],
4
[
5
'Nhãn 2'
6
],
7
[
8
// Nhãn 3
9
]
10
// ...
Copied!
Copy link