OMSĐơn hàng
Danh sách đơn hàng
Trả về danh sách đơn hàng theo các bộ lọc (ngày, trạng thái, cửa hàng, khách hàng...).
Endpoint
GET /v1/orders
Headers
| Tên | Bắt buộc | Mô tả |
|---|---|---|
Authorization | Có | <JWT> của người dùng có quyền xem đơn hàng (order.view) |
Query Parameters
| Tên | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_id | int | Có | ID công ty (tenant), phải trùng với công ty của phiên đăng nhập |
page | int | Trang hiện tại (mặc định 1) | |
limit | int | Số bản ghi mỗi trang (mặc định và tối đa 50) | |
sort_by | string | Sắp xếp theo id (mặc định), date_created, date_modified | |
sort_type | string | ASC (mặc định) hoặc DESC | |
id | int | ID đơn hàng cụ thể | |
notid | int | Loại trừ ID đơn hàng | |
ids | string | Danh sách ID (tối đa 1000, ngăn cách bằng dấu phẩy) | |
id_from | int | ID từ (khoảng ID) | |
id_to | int | ID đến (khoảng ID) | |
uuid | string | UUID đơn hàng | |
source | int | Nguồn đơn hàng (xem constant SOURCE_*, vd 11 Shopee, 13 Lazada, 15 TikTok Shop) | |
external_id | string | ID từ hệ thống bên ngoài (với đơn từ sàn: mã đơn trên sàn) | |
external_id_list | string | Danh sách external_id (ngăn cách bằng dấu phẩy) | |
store_id | int | ID cửa hàng | |
shift_id | int | ID ca làm việc | |
warehouse_id | int | ID kho | |
ids_warehouse | string | Danh sách ID kho (tối đa 50, ngăn cách bằng dấu phẩy) | |
customer_id | int | ID khách hàng | |
sale_id | int | ID nhân viên bán hàng | |
price_shipping_min | int | Phí ship tối thiểu (VNĐ) | |
price_shipping_max | int | Phí ship tối đa (VNĐ) | |
price_discount_min | int | Chiết khấu tối thiểu (VNĐ) | |
price_discount_max | int | Chiết khấu tối đa (VNĐ) | |
price_final_min | int | Tổng tiền tối thiểu (VNĐ) | |
price_final_max | int | Tổng tiền tối đa (VNĐ) | |
price_return_fulfilled_min | int | Tiền hàng trả lại tối thiểu (VNĐ) | |
price_return_fulfilled_max | int | Tiền hàng trả lại tối đa (VNĐ) | |
price_deposit_min | int | Tiền cọc tối thiểu (VNĐ) | |
price_deposit_max | int | Tiền cọc tối đa (VNĐ) | |
promotion_coupon | string | Mã khuyến mãi | |
billing_region_id | int | ID tỉnh/thành phố billing | |
payment_method | int | Phương thức thanh toán | |
payment_status | int | Trạng thái thanh toán | |
fulfillment_status | int | Trạng thái xử lý (fulfillment) | |
tax_invoice_status | int | Trạng thái hóa đơn thuế | |
shipping_type | int | Loại hình vận chuyển | |
shipping_status | int | Trạng thái vận chuyển | |
shiping_address_id | int | ID địa chỉ giao hàng (lưu ý tên tham số viết shiping) | |
shiping_phone | string | SĐT người nhận, khớp chính xác (lưu ý tên tham số viết shiping) | |
shipping_region_id | int | ID tỉnh/thành phố shipping | |
shipping_carrier_id | int | ID đơn vị vận chuyển | |
shipping_code | string | Mã vận đơn | |
status | int | Trạng thái đơn hàng | |
cancel_reason | int | Lý do hủy đơn | |
workflow_id | string | ID workflow | |
invalid_status | int | Trạng thái đơn không hợp lệ | |
invalid_reason | int | Lý do đơn không hợp lệ | |
date_started | int | Thời gian tạo từ (timestamp) | |
date_ended | int | Thời gian tạo đến (timestamp) | |
date_modified_from | int | Thời gian sửa từ (timestamp) | |
date_modified_to | int | Thời gian sửa đến (timestamp) | |
date_ship_committed_from | int | Ngày cam kết giao từ (timestamp) | |
date_ship_committed_to | int | Ngày cam kết giao đến (timestamp) | |
keyword | string | Từ khóa tìm kiếm (mã đơn, external_id, tên/email/SĐT người đặt, tag) | |
picking_list_id | int | ID danh sách lấy hàng | |
is_wait_picking | int | 1: chỉ lấy đơn chưa gắn danh sách lấy hàng | |
has_picking_list_id | int | 1: chỉ lấy đơn đã gắn danh sách lấy hàng | |
tag | string | Tag (ngăn cách bằng dấu phẩy) | |
tag_operator | string | Toán tử tag (AND/OR, mặc định AND) |
Lưu ý
Nếu tài khoản chỉ được phân quyền xem đơn ở một số cửa hàng, kết quả tự động giới hạn trong các cửa hàng đó. total chỉ được đếm chính xác khi số bản ghi trả về bằng limit; ở trang cuối, total được suy ra từ số bản ghi của trang.
Response Schema
HTTP 200 - JSON Object
{
"total": 35,
"currentpage": 1,
"limit": 50,
"items": [
// Array of Order objects (see Order structure above)
]
}Error Codes
| HTTP | Code | Mô tả |
|---|---|---|
| 401 | error_jwt_is_required | Thiếu token xác thực |
| 403 | error_role_not_available | Tài khoản không có quyền order.view |