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
See common request params​
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
statuses
array
No
Trạng thái đơn hàng xem tại đây​
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
carrierId
int
No
id hãng vận chuyển (Lấy từ /api/shipping/fee)
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
customerCityId
int
No
Mã thành phố của người nhận hàng (Lấy từ /api/shipping/location)
customerDistrictId
int
No
Mã quận huyện của người nhận hàng (Lấy từ /api/shipping/location)
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
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
        [
            // Đơn hàng 1
            "id": int, // ID đơn hàng
            "privateId": string, // ID website tích hợp
            "depotId": int, // Mã kho
            "depotName": string, // Tên Cửa hàng
            "typeId": int, //mã loại đơn hàng
            "type": string, // Loại đơn hàng (Shipping | Shopping)
            "shippingTypeId": int, //Mã loại chuyển hàng
            "shippingType": string, // Loại chuyển hàng
            "moneyDiscount": double, // Tiền chiết khấu
            "moneyDeposit": double, // Tiền đặt cọc
            "moneyTransfer": double, // Tiền chuyển khoản
            "serviceId": int, // Mã dịch vụ vận chuyển
            "carrierId": int, // ID hãng vận chuyển
            "carrierCode": string, // Mã hãng vận chuyển
            "carrierName": string, // Tên hãng 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,
            "carrierServiceName": string, // Dịch vụ vân chuyển
            "description": string, // ghi chú của khách hàng
            "privateDescription" string, // ghi chú của CSKH
            "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
            "deliveryDate": string, // Thời gian giao đơn hàng
            "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,
            "products": array, // Xem bảng Order product bên dưới,
            "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
            "channel" : int // Kênh bán,
            "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, // Xem bảng Order tags bên dưới,
            "saleChannel": string // Kênh bán hàng
        ],
        [
            // Đơn hàng 2
        ],
        // ...
    ]
]
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
        "discount": double, // Chiết khấu theo sản phẩm
        "description": string, // Mô tả sản phẩm
    ],
    [
        // Sản phẩm 2
    ],
    // ...
]
Order tags
    [
        'Nhãn 1'
    ],
    [
        'Nhãn 2'
    ],
    [
        // Nhãn 3
    ]
    // ...

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
statuses	array	No	Trạng thái đơn hàng xem tại đây
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
carrierId	int	No	id hãng vận chuyển (Lấy từ /api/shipping/fee)
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
customerCityId	int	No	Mã thành phố của người nhận hàng (Lấy từ /api/shipping/location)
customerDistrictId	int	No	Mã quận huyện của người nhận hàng (Lấy từ /api/shipping/location)
handoverId	int	No	ID biên bản bàn giao

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

Last modified 5d ago