Chuyển tới nội dung chính

Chi tiết đơn hàng bán

1. Thông Tin API​

  • Endpoint: /api/v6.1/sale_order
  • Method: GET
  • Authentication: Yêu cầu X-API-KEY
  • Header:
    • X-API-KEY: <your_api_key>

2. Tham Số Request​

Tham sốLoạiMô tả
fieldsstringDanh sách các trường dữ liệu cần lấy
order_idintegerID đơn hàng cần truy vấn
order_codestringMã đơn hàng cần truy vấn

Ví dụ request:

curl --location 'https://example.com/api/v6.1/sale_order?fields=id,order_code,real_amount,payment_periods&order_code=ORDER123' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Cookie: session_id=YOUR_SESSION_ID'

3. Response​

{
"id": 93,
"order_code": "ORDER123",
"real_amount": 65000,
"f_amount": 0,
"discount": 0,
"discount_amount": 0,
"vat_amount": 0,
"account_id": 12021,
"account_code": "CUSTOMER_2025_001",
"account_email": "",
"account_phone": "",
"account_address": "Địa chỉ A",
"order_date": "2025-02-03",
"created_at": "2025-02-03 08:23:40",
"updated_at": "2025-02-03 08:23:40",
"status": 1,
"status_label": "Chờ duyệt",
"payment_status": "Chưa thanh toán",
"assigned_user": 2,
"assigned_user_name": "Nhân viên A",
"order_details": [
{
"id": 140,
"product_id": 2507,
"product_code": "PRODUCT_2507",
"product_name": "Sản phẩm X",
"unit_name": "Dịch vụ",
"quantity": 1,
"price": 65000,
"amount": 65000,
"product_avatar": "https://example.com/no_image.png"
}
],
"lading_code": "",
"tracking_url": "",
"custom_fields": {
"gui_tin_nhan_xac_nhan_don_hang": 6,
"so_ne": "0"
},
"payment_periods": [
{
"id": 10,
"title": "Đợt 1",
"percent": 50,
"amount": 32500,
"pay_day": "2025-03-20",
"description": "Thanh toán đợt 1",
"status": 0
},
{
"id": 11,
"title": "Đợt 2",
"percent": 50,
"amount": 32500,
"pay_day": "2025-04-20",
"description": "Thanh toán đợt 2",
"status": 0
}
]
}

4. Mô Tả Trường Dữ Liệu​

TrườngLoạiMô tả
idintID của đơn hàng
order_codestringMã đơn hàng
real_amountintTổng tiền thực tế của đơn hàng
account_idintID khách hàng
account_codestringMã khách hàng
account_addressstringĐịa chỉ khách hàng
order_datestring (YYYY-MM-DD)Ngày đặt hàng
statusintMã trạng thái đơn hàng
status_labelstringNhãn trạng thái đơn hàng
payment_statusstringTrạng thái thanh toán
assigned_userintID nhân viên phụ trách
assigned_user_namestringTên nhân viên phụ trách
order_detailsarrayDanh sách sản phẩm trong đơn hàng
lading_codestringMã vận đơn
tracking_urlstringURL theo dõi vận đơn
custom_fieldsobjectCác trường dữ liệu tuỳ chỉnh
attachmentsarrayDanh sách tài liệu đính kèm
contract_idintegerID hợp đồng
payment_periodsarrayDanh sách kỳ thanh toán (cần truyền trong fields)

4.1. Kỳ thanh toán (payment_periods)​

TrườngLoạiMô tả
idintegerID kỳ thanh toán
titlestringTiêu đề
percentfloat% thanh toán
amountfloatSố tiền kỳ
pay_daystringNgày thanh toán
descriptionstringMô tả
statusinteger0: chưa thanh toán, 1: đã thanh toán

5. Ghi Chú​

  • Chỉ cần cung cấp một trong hai: order_id hoặc order_code (không gửi đồng thời).
  • Nếu status = 1, đơn hàng đang ở trạng thái "Chờ duyệt".
  • Trạng thái thanh toán có thể là "Chưa thanh toán", "Đã thanh toán một phần", "Đã thanh toán".
  • Một số trường như lading_code, tracking_url có thể trống nếu chưa cập nhật vận đơn.
  • Các trường dữ liệu trong custom_fields sẽ thay đổi tùy theo cấu hình của hệ thống.
  • Muốn lấy kỳ thanh toán, thêm payment_periods vào query fields.