Lấy danh sách vận đơn

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ố vận đơn 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ề	ShippingOrder[]

Cấu trúc JSON của đối tượng ‹ShippingOrder›
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
id	ID của vận đơn	Integer
route_id	ID của lượt giao hàng	Integer
random_code	Mã vận đơn / Tracking code vận đơn	String
type	Loại vận đơn (Xem danh sách bên dưới)	Integer
from_location	Giao từ địa điểm nào (thường là tên bưu cục xuất phát)	String
from_warehouse_id	ID kho lấy hàng của đối tác	Integer
merchant_id	ID của đối tác	Integer
office_id	ID bưu cục xuất phát	Integer
office_id_to	ID bưu cục đích (có trong loại luân chuyển nộ bộ)	Integer
foreign_id	ID của hệ thống bên ngoài, có được từ gọi API, không phải từ app movecrop	Integer
invoice_id	Mã đơn hàng của đối tác	String
cod	Giá trị COD cần thu của khách hàng	Float
shipping_type	ID loại dịch vụ giao hàng	Integer
product_type	Loại hàng hóa (Xem danh sách bên dưới)	Integer
order_price_sell	Thông tin giá bán (trước khuyến mãi) của đơn hàng cần giao (chỉ có khi tạo bằng API)	Float
order_price_discount	Thông tin giá khuyến mãi của đơn hàng cần giao (chỉ có khi tạo bằng API)	Float
order_price_shipping	Thông tin phí giao hàng của đơn hàng cần giao (chỉ có khi tạo bằng API)	Float
order_price_tax	Thông tin thuế của đơn hàng cần giao (chỉ có khi tạo bằng API)	Float
order_price_final	Giá trị đơn hàng cần giao	Float
order_note	Ghi chú cho đơn hàng	String
order_customer_fullname	Họ tên người nhận hàng	String
order_customer_email	Email người nhận hàng	String
order_customer_phone	Điện thoại của người nhận hàng	String
order_shipping_address	Địa chỉ giao hàng	String
order_shipping_country	Quốc gia của địa chỉ giao hàng (chỉ có khi tạo bằng API)	String (2)
order_shipping_region	ID Tỉnh thành phố của địa chỉ giao hàng	Integer
order_shipping_subregion	ID quận huyện của địa chỉ giao hàng	Integer
order_shipping_lat	Vĩ độ của địa chỉ giao hàng	Float
order_shipping_long	Kinh độ của địa chỉ giao hàng	Float
order_detail	Thông tin chi tiết đơn hàng	String
order_length	Chiều dài kiện hàng (đơn vị: cm)	Integer
order_width	Chiều rộng kiện hàng (đơn vị: cm)	Integer
order_height	Chiều cao kiện hàng (đơn vị: cm)	Integer
order_weight	Khối lượng của đơn hàng (đơn vị: gram)	Integer
price_sell	Phí giao hàng (trước khuyến mãi) tính cho đối tác (chỉ có khi tạo bằng API)	Float
price_discount	Giá trị khuyến mãi tính cho đối tác (chỉ có khi tạo bằng API)	Float
price_tax	Giá trị thuế tính cho đối tác (chỉ có khi tạo bằng API)	Float
price_final	Phí giao hàng sẽ thu của đối tác	Float
source	Nguồn tạo vận đơn này (Xem danh sách bên dưới)	Integer
pickup_status	Trạng thái lấy hàng (Xem danh sách bên dưới)	Integer
return_status	Trạng thái trả hàng (Xem danh sách bên dưới)	Integer
cod_status	Trạng thái thu COD(Xem danh sách bên dưới) (chưa hỗ trợ)	Integer
display_order	Thứ tự hiển thị vận đơn trong danh sách lượt giao hàng	Integer
status	Trạng thái vận đơn (Xem danh sách bên dưới)	Integer
date_created	Ngày tạo vận đơn	Integer Unix timestamp
date_modified	Ngày cập nhật thông tin vận đơn	Integer Unix timestamp
file_id_list	Mảng ID của tập tin đính kèm (hình ảnh) vận đơn	Integer[]
files	Mảng chi tiết thông tin tập tin đính kèm	File[]

 

Các giá trị của trạng thái lấy hàng ‹pickup_status›

Giá trị	Mô tả
1	NOPICKUP - Chưa lấy hàng
3	PENDING - Chờ lấy hàng
5	INPROGRESS - Đang lấy hàng
7	PACKAGING - Đang đóng gói
9	COMPLETE - Đã lấy hàng
11	FAIL - Lấy hàng thất bại

 

Các giá trị của trạng thái trả hàng ‹return_status›

Giá trị	Mô tả
1	NO - Không chuyển hoàn
3	PENDING - Chờ chuyển hoàn
5	INPROGRESS - Đang chuyển hoàn
7	COMPLETE - Chuyển hoàn thành công
9	FAIL - Chuyển hoàn thất bại

 

Các giá trị của trạng thái COD ‹cod_status›

Giá trị	Mô tả
1	EMPTY - Không có COD
3	ONHOLD - Đang giữ tiền COD của đối tác
5	RETURN - Đã hoàn tiền COD cho đối tác

 

Các giá trị của trạng thái vận đơn ‹status›

Giá trị	Mô tả
1	NEW - Mới
3	PENDING - Chờ xử lý
5	INPROGRESS - Đang giao hàng
7	SUCCESS - Giao thành công
9	FAIL - Thất bại

 

Các giá trị của loại vận đơn ‹type›

Giá trị	Mô tả
0	CUSTOMER - Giao hàng cho khách
1	INTERNAL - Luân chuyển hàng hóa nội bộ

 

Các giá trị của loại hàng hóa ‹product_type›

Giá trị	Mô tả
1	NORMAL - Hàng thông thường
3	FOOD - Thực phẩm
5	FROZENFOOD - Thực phẩm đông lạnh
7	FRAGILE - Hàng dễ vỡ

 

Các giá trị của nguồn tạo vận đơn ‹source›

Giá trị	Mô tả
1	MANUAL - Tạo bằng tay (từ admin)
3	API - Tạo thông qua gọi API

 

Ví dụ một response json object:

{ "total": 1, "currentpage": 1, "limit": 50, "items": [ { "company_id": 1, "creator_id": 1, "id": 88, "route_id": 0, "random_code": "88481357", "type": 0, "from_location": "BC Ho Chi Minh", "from_warehouse_id": 0, "merchant_id": 25, "office_id": 643, "office_id_to": 0, "foreign_id": 0, "invoice_id": "ORDER-180805-2202-5D", "cod": 0, "shipping_type": 0, "product_type": 1, "order_price_sell": 0, "order_price_discount": 0, "order_price_shipping": 0, "order_price_tax": 0, "order_price_final": 0, "order_note": "", "order_customer_fullname": "abc", "order_customer_email": "", "order_customer_phone": "", "order_shipping_address": "125 Điện Biên Phủ, Phường 15, Bình Thạnh, Hồ Chí Minh, Vietnam", "order_shipping_country": "", "order_shipping_region": 3, "order_shipping_subregion": 819, "order_shipping_lat": 10.796833, "order_shipping_long": 106.703054, "order_detail": "", "order_length": 0, "order_width": 0, "order_height": 0, "order_weight": 0, "price_sell": 0, "price_discount": 0, "price_tax": 0, "price_final": 0, "source": 0, "pickup_status": 9, "return_status": 0, "cod_status": 0, "display_order": 0, "status": 3, "date_created": 1533481357, "date_modified": 1533870744, "file_id_list": [ 19 ], "files": [ { "is_directory": 0, "creator_id": 1, "id": 19, "parent_id": 0, "md5_hash": "dd1b5532196a54adfd7b84a030e55401", "url": "http://cropcdn.net/2018/August/7/19-603741533638744-1533638744.png", "thumbnail": "http://cropcdn.net/2018/August/7/19-603741533638744-1533638744.png", "file_preview": "http://cropcdn.net/2018/August/7/19-603741533638744-1533638744.png", "file_path": "2018/August/7/19-603741533638744-1533638744.png", "width": 554, "height": 421, "randomcode": "11213112", "title": "myfile.png", "description": "", "extension": "png", "size_in_byte": 10527, "count_view": 0, "status": 1, "ip_address": "127.0.0.1", "date_created": 1533638744, "date_modified": 1533638744, "parents": [] } ] } ] } 

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