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.
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ì.
Request
Xem các common request params
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) |
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 | Trạng thái đơn hàng xem tại đây |
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 | id hãng vận chuyển (Lấy từ /api/shipping/fee) |
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 | Mã thành phố của người nhận hàng (Lấy từ /api/shipping/location) |
customerDistrictId | int | Mã quận huyện của người nhận hàng (Lấy từ /api/shipping/location) |
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 |
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
Sale channels
Danh sách các kênh bán
Sale channel ID | Sale channel |
---|---|
1 | Admin |
2 | Website |
10 | API |
20 | Facebook (Khi tạo đơn hàng từ chat.nhanh.vn) |
21 | Instagram (Khi tạo đơn hàng từ chat.nhanh.vn) |
41 | Lazada.vn |
42 | Shopee.vn |
43 | Sendo.vn |
45 | Tiki.vn |
46 | Zalo Shop |
47 | 1Landing.vn |
48 | Tiktok Shop |
49 | Zalo OA (Khi tạo đơn hàng từ chat.nhanh.vn) |
50 | Shopee Chat (Khi tạo đơn hàng từ chat.nhanh.vn) |
51 | Lazada Chat (Khi tạo đơn hàng từ chat.nhanh.vn) |
Last updated