Danh sách đơn hàng mua
Endpoint: GET /api/v6.1/purchase_orders
Mô tả: API này được sử dụng để lấy danh sách các đơn hàng mua từ hệ thống CRM, bao gồm thông tin khách hàng, chi tiết sản phẩm, trạng thái đơn hàng, người phụ trách và các trường tuỳ chỉnh.
Yêu cầu
Phương thức: GET
Headers:
X-API-KEY: <api-key-của-bạn>
Cookie: <session-cookie-của-bạn>
Query Parameters:
Tham số | Kiểu | Mô tả |
---|---|---|
fields | string | Danh sách trường muốn lấy, phân cách bằng dấu phẩy |
filtering[status:eq] | int | Lọc theo trạng thái đơn hàng, ví dụ 1 là đã xác nhận |
limit | int | Số lượng bản ghi muốn lấy |
offset | int | Vị trí bắt đầu (để phân trang) |
sort | string | Trường muốn sắp xếp theo, ví dụ order_date |
direction | string | Hướng sắp xếp: asc hoặc desc |
Phản hồi
Trạng thái: 200 OK
{
"data": [
{
"id": 123,
"order_code": "PO001",
"real_amount": 1000000,
"f_amount": 1000000,
"discount": 0,
"discount_amount": 0,
"vat_amount": 0,
"account_id": null,
"account_code": "",
"account_email": "",
"account_phone": "",
"account_address": "",
"order_date": "2025-05-12 00:00:00",
"created_at": "2025-05-12 09:10:48",
"updated_at": "2025-05-12 09:10:48",
"status": 1,
"assigned_user": 2,
"assigned_user_name": "Người phụ trách",
"contact_name": "",
"contact_phone": "",
"contact_email": "",
"detail_custom_fields": {
"ma_phu": "",
"ghi_chu_rieng": ""
},
"custom_fields": [],
"order_details": [
{
"id": 456,
"product_id": 789,
"product_name": "Tên sản phẩm A",
"product_code": "SP123",
"quantity": 2,
"price": 500000,
"amount": 1000000,
"unit_name": "Chiếc",
"product_avatar": "https://example.com/image.png"
}
]
}
],
"has_more": true,
"offset": 1,
"limited": 2,
"sorted": {
"order_date": "DESC"
}
}
Mô tả các trường chính
Thông tin đơn hàng:
Trường | Kiểu | Mô tả |
---|---|---|
id | integer | ID nội bộ của đơn hàng |
order_code | string | Mã đơn hàng duy nhất |
real_amount | number | Tổng giá trị thanh toán thực tế |
f_amount | number | Giá trị đơn hàng ban đầu |
discount , discount_amount | number | Chiết khấu (%) và số tiền |
vat_amount | number | Số tiền thuế VAT |
order_date , created_at , updated_at | datetime | Ngày đặt, tạo và cập nhật đơn |
status | int | Trạng thái đơn hàng |
Thông tin khách hàng:
Trường | Kiểu | Mô tả |
---|---|---|
account_id , account_code | int, string | ID và mã khách hàng |
account_email , account_phone , account_address | string | Thông tin liên hệ khách hàng |
contact_name , contact_phone , contact_email | string | Người nhận hàng hoặc liên hệ chính |
Người phụ trách:
Trường | Kiểu | Mô tả |
---|---|---|
assigned_user | int | ID nhân viên phụ trách |
assigned_user_name | string | Tên nhân viên phụ trách |
Chi tiết sản phẩm (order_details
):
Trường | Mô tả |
---|---|
product_id , product_name , product_code | Thông tin định danh sản phẩm |
quantity , price , amount | Số lượng, đơn giá, tổng tiền |
unit_name , product_avatar | Đơn vị tính và ảnh đại diện |
Trường mở rộng (detail_custom_fields
):
Là object chứa các trường tùy chỉnh như:
ma_phu
: mã đơn phụghi_chu_rieng
: ghi chú nội bộ hoặc mở rộng