- Giới thiệu
API Documentation
Đăng đơn hàng
Khởi tạo đơn hàng
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Danh sách hàng hóa.
Thông tin đặt hàng.
String - mã đơn hàng thuộc hệ thống của đối tác.
String - Tên người liên hệ lấy hàng hóa.
Integer - Số tiền CoD. Nếu bằng 0 thì không thu tiền CoD. Tính theo VNĐ.
String - ID địa điểm lấy hàng của shop trong trang quản lý đơn hàng dành cho khách hàng. Nếu trường này khác rỗng sẽ được ưu tiên sử dụng.
String - Địa chỉ ngắn gọn để lấy nhận hàng hóa. Ví dụ: nhà số 5, tổ 3, ngách 11, ngõ 45.
String - Tên tỉnh/thành phố nơi lấy hàng hóa.
String - Tên quận/huyện nơi lấy hàng hóa.
String - Tên phường/xã nơi lấy hàng hóa .
String - Tên đường/phố nơi lấy hàng hóa.
String - Số điện thoại liên hệ nơi lấy hàng hóa.
String - Email liên hệ nơi lấy hàng hóa.
String - tên người nhận hàng.
String - Địa chỉ chi tiết của người nhận hàng, ví dụ: Chung cư CT1, ngõ 58, đường Trần Bình.
String - Tên tỉnh/thành phố của người nhận hàng hóa.
String - Tên quận/huyện của người nhận hàng hóa.
String - Tên phường/xã của người nhận hàng hóa (Bắt buộc khi không có đường/phố).
String - Tên đường/phố của người nhận hàng hóa (Bắt buộc khi không có phường/xã).
String - Tên thôn/ấp/xóm/tổ/… của người nhận hàng hóa. Nếu không có, vui lòng điền “Khác”.
String - Số điện thoại người nhận hàng hóa.
String - Ghi chú đơn hàng. Vd: Khối lượng tính cước tối đa: 1.00 kgTừ 24/2/2020 ghi chú tối đa cho phép là 120 kí tự.
String - Email người nhận hàng hóa.
Integer - mặc định là 0. Field này có thể truyền vào một trong hai giá trị 0 hoặc 1. Bằng 0 nghĩa là địa chỉ trả hàng giống địa chỉ lấy hàng nên các field địa chỉ trả hàng không cần truyền qua. Bằng 1 nghĩa là sử dụng địa chỉ trả hàng khác địa chỉ lấy hàng và cần truyền vào giá trị cho các field tiếp theo.
String - tên người nhận hàng trả.
String - Địa chỉ chi tiết của người nhận hàng, ví dụ: nhà A, ngõ 100.
String - Tên tỉnh/thành phố của người nhận hàng hóa.
String - Tên quận/huyện của người nhận hàng hóa.
String - Tên phường/xã của người nhận hàng hóa.
String - Tên đường/phố của người nhận hàng hóa.
String - Số điện thoại người nhận hàng hóa.
String - Email người nhận hàng hóa.
Integer - Freeship cho người nhận hàng. Nếu bằng 1 COD sẽ chỉ thu người nhận hàng số tiền bằng pick_money, nếu bằng 0 COD sẽ thu tiền người nhận số tiền bằng pick_money + phí ship của đơn hàng, giá trị mặc định bằng 0.
String - nhận một trong hai giá trị gram và kilogram, mặc định là kilogram, đơn vị khối lượng của các sản phẩm có trong gói hàng.
String - tên người nhận hàng trả.
Integer - Nếu set bằng 3 đơn hàng sẽ lấy vào buổi tối. 2: buồi chiều. 1: buổi sáng. Giá trị mặc định GHTK set theo ca tự tính.
Integer - Nếu set bằng 3 đơn hàng sẽ được giao vào buổi tối. 2: buồi chiều. 1: buổi sáng. Giá trị mặc định GHTK set theo ca tự tính.
String - Mã vận đơn được cấp trước cho đối tác - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
String YYYY/MM/DD - Hẹn ngày lấy hàng - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
String YYYY/MM/DD - Hẹn ngày giao hàng - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
String YYYY/MM/DD hh:mm:ss - thời gian tự động - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
nterger (VNĐ) - Giá trị đóng bảo hiểm, là căn cứ để tính phí bảo hiểm và bồi thường khi có sự cố..
Interger (VNĐ) - 1. đơn chỉ thu tiền, 0. default.
String - Nhận một trong hai giá trị cod và post, mặc định là cod, biểu thị lấy hàng bởi COD hoặc Shop sẽ gửi tại bưu cục.
String - Trường này lưu đường vận chuyển của đơn hàng, mặc định là đường bay (fly). Nếu đơn hàng được chuyển bằng đường bộ (road), bạn sẽ nhận được thông báo của GHTK.
String - Phương thức vâng chuyển road ( bộ ) , fly (bay). Nếu phương thức vận chuyển không hợp lệ thì GHTK sẽ tự động nhảy về PTVC mặc định.
String - Gía trị là xteam nếu lựa chọn phương thức vận chuyển xfast.
String - Giá trị lấy từ response của API check dịch vụ XFAST (phiên lấy xfast).
Array - Gắn nhãn cho đơn hàng, truyền lên mảng , mô tả tham số của nhãn đơn hàng trong bảng tiếp theo.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Danh sách hàng hóa.
Tên hàng hóa.
Double - Khối lượng hàng hóa Tính theo đơn vị KG.
Integer - Số lượng hàng hóa.
Integer - Mã sản phẩm được lấy từ api lấy danh sách thông tin sản phẩm.
Thông tin đặt hàng.
String - mã đơn hàng thuộc hệ thống của đối tác.
String - Tên người liên hệ lấy hàng hóa.
Integer - Số tiền CoD. Nếu bằng 0 thì không thu tiền CoD. Tính theo VNĐ.
String - ID địa điểm lấy hàng của shop trong trang quản lý đơn hàng dành cho khách hàng. Nếu trường này khác rỗng sẽ được ưu tiên sử dụng.
String - Địa chỉ ngắn gọn để lấy nhận hàng hóa. Ví dụ: nhà số 5, tổ 3, ngách 11, ngõ 45.
String - Tên tỉnh/thành phố nơi lấy hàng hóa.
String - Tên quận/huyện nơi lấy hàng hóa.
String - Tên phường/xã nơi lấy hàng hóa .
String - Tên đường/phố nơi lấy hàng hóa.
String - Số điện thoại liên hệ nơi lấy hàng hóa.
String - Email liên hệ nơi lấy hàng hóa.
String - tên người nhận hàng.
String - Địa chỉ chi tiết của người nhận hàng, ví dụ: Chung cư CT1, ngõ 58, đường Trần Bình.
String - Tên tỉnh/thành phố của người nhận hàng hóa.
String - Tên quận/huyện của người nhận hàng hóa.
String - Tên phường/xã của người nhận hàng hóa (Bắt buộc khi không có đường/phố).
String - Tên đường/phố của người nhận hàng hóa (Bắt buộc khi không có phường/xã).
String - Tên thôn/ấp/xóm/tổ/… của người nhận hàng hóa. Nếu không có, vui lòng điền “Khác”.
String - Số điện thoại người nhận hàng hóa.
String - Ghi chú đơn hàng. Vd: Khối lượng tính cước tối đa: 1.00 kgTừ 24/2/2020 ghi chú tối đa cho phép là 120 kí tự.
String - Email người nhận hàng hóa.
Integer - mặc định là 0. Field này có thể truyền vào một trong hai giá trị 0 hoặc 1. Bằng 0 nghĩa là địa chỉ trả hàng giống địa chỉ lấy hàng nên các field địa chỉ trả hàng không cần truyền qua. Bằng 1 nghĩa là sử dụng địa chỉ trả hàng khác địa chỉ lấy hàng và cần truyền vào giá trị cho các field tiếp theo.
String - tên người nhận hàng trả.
String - Địa chỉ chi tiết của người nhận hàng, ví dụ: nhà A, ngõ 100.
String - Tên tỉnh/thành phố của người nhận hàng hóa.
String - Tên quận/huyện của người nhận hàng hóa.
String - Tên phường/xã của người nhận hàng hóa.
String - Tên đường/phố của người nhận hàng hóa.
String - Số điện thoại người nhận hàng hóa.
String - Email người nhận hàng hóa.
Integer - Freeship cho người nhận hàng. Nếu bằng 1 COD sẽ chỉ thu người nhận hàng số tiền bằng pick_money, nếu bằng 0 COD sẽ thu tiền người nhận số tiền bằng pick_money + phí ship của đơn hàng, giá trị mặc định bằng 0.
String - nhận một trong hai giá trị gram và kilogram, mặc định là kilogram, đơn vị khối lượng của các sản phẩm có trong gói hàng.
String - tên người nhận hàng trả.
Integer - Nếu set bằng 3 đơn hàng sẽ lấy vào buổi tối. 2: buồi chiều. 1: buổi sáng. Giá trị mặc định GHTK set theo ca tự tính.
Integer - Nếu set bằng 3 đơn hàng sẽ được giao vào buổi tối. 2: buồi chiều. 1: buổi sáng. Giá trị mặc định GHTK set theo ca tự tính.
String - Mã vận đơn được cấp trước cho đối tác - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
String YYYY/MM/DD - Hẹn ngày lấy hàng - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
String YYYY/MM/DD - Hẹn ngày giao hàng - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
String YYYY/MM/DD hh:mm:ss - thời gian tự động - mặc định không sử dụng được field này, cấu hình riêng cho từng gói dịch vụ.
nterger (VNĐ) - Giá trị đóng bảo hiểm, là căn cứ để tính phí bảo hiểm và bồi thường khi có sự cố..
Interger (VNĐ) - 1. đơn chỉ thu tiền, 0. default.
String - Nhận một trong hai giá trị cod và post, mặc định là cod, biểu thị lấy hàng bởi COD hoặc Shop sẽ gửi tại bưu cục.
String - Trường này lưu đường vận chuyển của đơn hàng, mặc định là đường bay (fly). Nếu đơn hàng được chuyển bằng đường bộ (road), bạn sẽ nhận được thông báo của GHTK.
String - Phương thức vâng chuyển road ( bộ ) , fly (bay). Nếu phương thức vận chuyển không hợp lệ thì GHTK sẽ tự động nhảy về PTVC mặc định.
String - Gía trị là xteam nếu lựa chọn phương thức vận chuyển xfast.
String - Giá trị lấy từ response của API check dịch vụ XFAST (phiên lấy xfast).
Array - Gắn nhãn cho đơn hàng, truyền lên mảng , mô tả tham số của nhãn đơn hàng trong bảng tiếp theo.
Response
Request thành công hoặc thất bại
message