Lấy danh sách đơn hàng

API này chỉ lấy danh sách đơn hàng, không trả về danh sách chi tiết các sản phẩm trong đơn hàng. Để lấy danh sách chi tiết các sản phẩm trong đơn hàng, bạn có thể sử dụng API lấy chi tiết đơn hàng.

Request

  • URL: /orders
  • Method: GET

Query Parameter

Key Mô tả Kiểu dữ liệu Mặc định
company_id ID công ty Interger (Bắt buộc)  
page Trang cần lấy dữ liệu (để phân trang) Interger 1
limit Số dữ liệu lấy mỗi trang Integer 50
sort_by Tiêu chí sắp xếp kết quả (xem thêm bên dưới) String id
sort_type Thứ tự lấy kết quả String (ASC hoặc DESC) ASC
keyword Tìm kiếm từ khóa theo billing fullname, id, invoice id, , contact email, billing phone, tag, note String  
delivery_status Trạng thái giao hàng. (Xem danh sách bên dưới) Integer  
status Trạng thái đơn hàng. (Xem danh sách bên dưới) Integer  
customer_id ID của khách hàng Integer  
store_id ID cửa hàng Integer  
invoice_id Invoice ID của đơn hàng String  
invoiceid_simple Phiên bản không có ký tự đặc biệt của Invoice ID String  
billing_region_id ID tỉnh, thành phố của địa chỉ người mua Integer  
shipping_service ID nhà vận chuyển Integer  
shipping_tracking_code Mã vận đơn String  
is_return Đây là đơn hàng trả (có 2 giá trị là 0 hoặc 1) Integer  
has_return Đơn hàng này có đơn hàng trả hay không (Có 2 giá trị là 0 hoặc 1) Integer  
tag Thẻ (tag) của đơn hàng. Cách nhau dấu phẩy String  
origin ID nguồn đơn hàng Integer  
date_arrived Ngày nhận hàng Integer - Unix timestamp  
date_created Ngày tạo đơn hàng Integer - Unix timestamp  
date_started Ngày tạo đơn hàng nhỏ nhất Integer Unix timestamp  
date_ended Ngày tạo đơn hàng lớn nhất Integer Unix timestamp  
date_arrived_started Ngày nhận hàng nhỏ nhất Integer Unix timestamp  
date_arrived_ended Ngày nhận hàng lớn nhất Integer Unix timestamp  
not_status Tìm kiếm đơn hàng không thuộc các trạng thái này Integer  
status_list  Tìm kiếm đơn hàng thuộc các trạng thái này Integer  

 

Các tiêu chí sắp xếp ‹sort_by›

Giá trị Mô tả
id Sắp xếp theo ID của đơn hàng
date_created Ngày tạo đơn hàng
date_arrived Ngày nhận hàng
date_modified Ngày chỉnh sửa đơn hàng

 

Response

Success response

Nếu request thành công, bạn nhận được response với các thông tin sau

Đối tượng JSON trả về (Content-Type: application/json) - 200 OK
Tên Mô tả Kiểu dữ liệu
total Tổng số đơn hàng tìm thấy Integer
currentpage Số trang hiện tại đang lấy kết quả Integer
limit Số dòng dữ liệu lấy trong một trang Integer
items Danh sách đơn hàng trả về Order[]

Cấu trúc JSON của đối tượng ‹Order›
Tên Mô tả Kiểu dữ liệu
company_id ID công ty Integer
creator_id ID người tạo đơn hàng Integer
customer_id ID của khách hàng Integer
customer_code Mã khách hàng String
customer_point Điểm tích lũy cho khách hàng có được từ đơn hàng Integer
store_id ID cửa hàng Integer
id ID đơn hàng Integer
local_pos_identifier Mã định danh riêng khi bán từ POS Integer
invoice_id Invoice ID của đơn hàng String
invoiceid_simple Phiên bản không có ký tự đặc biệt của Invoice ID String
price_cost Giá vốn đơn hàng Float
price_sell Giá bán (subtotal) Float
price_shipping Phí vận chuyển Float
price_handling Phí khác Float
price_tax Tiền thuế Float
tax_ratio Thuế suất (từ 0 đến 100) Integer
price_discount Giảm giá, khuyến mãi Float
price_final Tổng tiền khách hàng phải thanh toán Float
price_deposit Số tiền đặt cọc Float
price_debt Số tiền còn thiếu Float
promotion_id ID chương trình khuyến mãi Integer
contact_email Email liên hệ String
billing_gender Giới tính người mua. (0: nữ, 1: nam) Integer
billing_full_name Họ tên người mua String
billing_phone Số điện thoại người mua String
billing_address Địa chỉ người mua String
billing_company Công ty người mua String
billing_sub_region_id ID quận, huyện của địa chỉ người mua Integer
billing_region_id ID tỉnh, thành phố của địa chỉ người mua Integer
billing_country Quốc gia của địa chỉ người mua String
billing_zipcode ZIP của địa chỉ người mua String
shipping_full_name Họ tên người nhận String
shipping_phone Số điện thoại người nhận String
shipping_address Địa chỉ người nhận String
shipping_company Công ty người nhận String
shipping_country Quốc gia của địa chỉ người nhận String
shipping_zipcode Zipcode của địa chỉ người nhận String
shipping_sub_region_id ID quận, huyện của địa chỉ người nhận Integer
shipping_region_id ID tỉnh, thành phố của địa chỉ người nhận Integer
shipping_lat Vĩ độ (Latitude) của địa chỉ nhận hàng - Chưa hỗ trợ Float
shipping_lng Kinh độ (Longitude) của địa chỉ nhận hàng - Chưa hỗ trợ Float
shipping_service ID nhà vận chuyển Integer
shipping_tracking_code Mã vận đơn String
related_order_id ID của các đơn hàng liên quan. String
product_receipt ID của các phiếu nhập, xuất kho liên quan đến đơn hàng này. Cách nhau dấy phẩy. String
cashflow_id ID của các phiếu thu, chi liên quan đến đơn hàng này. Cách nhau dấu phẩy. String
quantity Tổng số lượng của các sản phẩm chi tiết trong đơn hàng Integer
delivery_status Trạng thái giao hàng. (Xem danh sách bên dưới) Integer
note Ghi chú cho đơn hàng này String
cod_amount Tiền COD Float
random_code Mã ngẫu nhiên định danh đơn hàng này trên toàn hệ thống String
status Trạng thái đơn hàng. (Xem danh sách bên dưới) Integer
cancel_reason ID lý do hủy đơn hàng Integer
is_return Đây là đơn hàng trả (có 2 giá trị là 0 hoặc 1) Integer
has_return Đơn hàng này có đơn hàng trả hay không (Có 2 giá trị là 0 hoặc 1) Integer
tag Thẻ (tag) của đơn hàng. Cách nhau dấu phẩy String
origin ID nguồn đơn hàng Integer
origin_id Định danh từ nguồn đơn hàng String
employee_id User ID của nhân viên bán hàng Integer
ip_address Địa chỉ IP đã tạo đơn hàng String
date_arrived Ngày nhận hàng Integer - Unix timestamp
date_created Ngày tạo đơn hàng Integer - Unix timestamp
date_modified Ngày cập nhật cuối của đơn hàng Integer - Unix timestamp
date_completed Ngày hoàn thành đơn hàng Integer - Unix timestamp
weight Khối lượng (gram) của đơn hàng Integer

Các trạng thái giao hàng ‹delivery_status›

Giá trị Mô tả
1 NEW - Mới
3 PENDING - Chờ xử lý
5 PACKAGING - Đã đóng gói
7 WAITFORPICKING - Chờ lấy hàng
9 PICKED - Đối tác đã lấy
11 PROCESSING - Đang xử lý
13 SHIPPING - Đang giao hàng
15 SHIPPED - Đã giao hàng
17 WAITFORPAYMENT - Chờ thành toán
19 RETURNING - Đang trả hàng
21 SUCCESS - Giao thành công
23 FAIL - Giao thất bại
25 CANCEL - Hủy vận đơn

 

Các trạng thái đơn hàng ‹status›

Giá trị Mô tả
13 OPEN - Đơn hàng mới
15 PROCESSING - Đang xử lý
17 SHIPPING - Đang giao hàng
18 SHIPPED - Đã giao hàng
19 COMPLETE - Hoàn thành
21 CANCEL - Hủy bỏ

 


Ví dụ một response json object:
{ "total": 8913, "currentpage": 1, "limit": 1, "items": [ { "company_id": 1, "creator_id": 1, "customer_id": 45328, "customer_code": "", "customer_point": 0, "store_id": 1082, "id": 1574826, "local_pos_identifier": 1520998361, "invoice_id": "TH-180314-1032-E6A7", "invoiceid_simple": "TH1803141032E6A7", "price_cost": 0, "price_sell": 180000, "price_shipping": 0, "price_handling": 0, "price_tax": 0, "tax_ratio": 0, "price_discount": 0, "price_final": 180000, "price_deposit": 0, "price_debt": 180000, "promotion_id": 68, "contact_email": "", "billing_gender": 0, "billing_full_name": "Thành Liêm", "billing_phone": "098764534", "billing_address": "124 Lê lợi, p4", "billing_company": "", "billing_sub_sub_region_id": 0, "billing_sub_region_id": 822, "billing_region_id": 3, "billing_country": "", "billing_zipcode": 0, "shipping_full_name": "Thành Liêm", "shipping_phone": "098764534", "shipping_address": "124 Lê lợi, p4", "shipping_company": "", "shipping_country": "", "shipping_zipcode": 0, "shipping_sub_sub_region_id": 0, "shipping_sub_region_id": 822, "shipping_region_id": 3, "shipping_lat": 0, "shipping_lng": 0, "shipping_service": 0, "shipping_tracking_code": "", "related_order_id": "", "product_receipt": "12345,12346", "cashflow_id": "23082", "quantity": 1, "delivery_status": 0, "note": "", "cod_amount": 180000, "random_code": "1972f1a7e12c96aab50673ddd49e4389", "status": 13, "cancel_reason": 0, "is_return": 0, "has_return": 0, "tag": "", "origin": 0, "origin_id": "", "employee_id": 1, "ip_address": "0.0.0.14", "date_arrived": 0, "date_created": 1520998361, "date_modified": 1520998364, "weight": 500 } ] } 

Error response

Nếu response có lỗi thì có thể tham khảo bảng bên dưới để biết các lỗi có thể xuất hiện khi gửi request này:

HTTP Status Mã lỗi Mô tả
403 error_not_permission Không có quyền truy cập