Tạo đơn hàng
API tạo đơn hàng 247
Địa chỉ người nhận
Đối với địa chỉ có cấu trúc 3 cấp (Tỉnh/thành, quận/huyện, phường/xã theo cấu trúc địa giới Việt Nam trước ngày 01.07.2025) truyền thông tin như sau:
ReceiverProvinceName: tên tỉnh/thành người nhận.
ReceiverDistrictName: tên quận/huyện người nhận.
ReceiverWardName: tên phường/xã người nhận.
Đối với địa chỉ có cấu trúc 2 cấp (Tỉnh/thành, phường/xã theo cấu trúc địa giới Việt Nam từ ngày 01.07.2025) truyền thông tin như sau:
ReceiverProvinceName: tên tỉnh/thành người nhận.
ReceiverDistrictName: không truyền.
ReceiverWardName: tên phường/xã người nhận.
CustomerAPICreateOrder
POST:/Api/Customer/CustomerAPICreateOrder
Headers
ClientID
Lấy từ api đăng nhập
Token
Lấy từ api đăng nhập
Body
ClientHubID
number
Mã địa chỉ khách hàng (Bắt buộc khi không truyền CusWareHouseID và KH có địa chỉ gửi cố định)
CusWareHouseID
string
Mã kho/shop (Bắt buộc khi không truyền ClientHubID và KH có địa chỉ gửi cố định)
ContactName
string
Tên người liên hệ gửi hàng
ContactPhone
string
SĐT người liên hệ gửi hàng (bắt buộc khi KH có địa chỉ gửi không cố định)
DirectSenderName
string
Người đi gửi Thư/Hàng (bắt buộc khi KH có địa chỉ gửi không cố định)
SenderAddress
string
Địa chỉ đầy đủ người gửi, bao gồm: số nhà, tên đường, tên xã, tên huyện, tên tỉnh. (bắt buộc khi KH có địa chỉ gửi không cố định)
ReceiverPhone*
string
Số điện thoại người nhận
ReceiverName
string
Tên người nhận
ReceiverAddress*
string
Địa chỉ đầy đủ của người nhận (Cấu trúc địa chỉ 3 cấp: số nhà, tên đường, tên xã, tên huyện, tên tỉnh/ Cấu trúc địa chỉ 2 cấp: Số nhà, tên đường, tên xã, tên tỉnh)
ReceiverProvinceName*
string
Tên Tỉnh/Thành phố người nhận
ReceiverDistrictName*
string
Tên Quận/Huyện người nhận (null nếu sử dụng địa chỉ 2 cấp Tỉnh/thành phố, Phường/xã)
ReceiverWardName
string
Tên Phường/Xã người nhận
RealWeight
number
Trọng lượng thực tế (kg)
Length
number
Chiều dài (cm)
Width
number
Chiều rộng (cm)
Height
number
Chiều cao (cm)
Quantity
number
Số lượng kiện
Note
string
Ghi chú
ServiceTypeID*
string
Mã dịch vụ
MailerType
string
Mã loại hàng hóa vận chuyển: HH - Hàng hóa. TL - Tài liệu.
CODAmount
number
Tiền thu người nhận
ExternalCode
string
Mã vận đơn khách hàng
ReferenceCode
string
Mã tham chiếu khách hàng
SpecialInstructionId
number
Mã ghi chú đặc biệt chỉ đối với đơn hàng COD: 1 - Cho xem hàng. 0 - Không cho xem hàng.
InformFee
string
Giá trị kê khai. Các trường hợp lưu ý khi kê khai: 1 - Trọng lượng tính giá >= 2.5kg bắt buộc chọn Loại hình = HH(hàng hóa) 2 - Loại hình = HH bắt buộc nhập giá trị kê khai 3 - Đơn chọn DVBH (Dịch vụ bảo hiểm) thì bắt buộc nhập giá trị kê khai.
ExtraServices
array
Danh sách các dịch vụ gia tăng
Packages
array
{
"PackageID": "", //Mã kiện,
"Length": 100, // Kích thước (Dài - bắt buộc khi có nhập Rộng, Cao)(cm),
"Width": 50, // Kích thước (Rộng - bắt buộc khi có nhập Dài, Cao)(cm),
"Height": 80,// Kích thước (Cao - Bắt buộc khi có nhập Dài, Rộng)(cm),
"RealWeight": 25// Trọng lượng thực của kiện (kg)
}(*)Số lượng Packages phải khớp với Quantity. Trường hợp Quantity = 1 thì Packages = []
COPAmt
number
Tiền COP (Cash on pickup)
Response
{
"Errors": [],
"ErrorCode": "0",
"OrderInfo": {
"OrderCode": "HD000003",
"ReferenceCode": "HD000003",
"ExternalCode": "HD000003",
"TotalServiceCost": 44176,
"ExtraServices": [
{
"ServiceName": "Chuyển phát nhanh",
"ServiceID": "DE",
"Cost": 16800
},
{
"ServiceName": "Hàng đông lạnh",
"ServiceID": "HDL",
"Cost": 15000
},
{
"ServiceName": "Báo phát",
"ServiceID": "BP",
"Cost": 5000
},
{
"ServiceName": "Phí xăng dầu",
"ServiceID": "Fuel",
"Cost": 3360
},
{
"ServiceName": "Phí VAT",
"ServiceID": "VAT",
"Cost": 4016
}
],
"DeliveryType": "1"
},
"ErrorMessage": ""
}Errors
array object
Mảng các lỗi trả về
ErrorCode
string
Mã lỗi
ErrorMessage
string
Thông báo lỗi
OrderInfo
object
Thông tin đơn hàng tạo thành công
OrderCode
string
Mã đơn hàng
ReferenceCode
string
Mã tham chiếu khách hàng
ExternalCode
string
Mã đơn hàng khách hàng
TotalServiceCost
number
Tổng phí
ExtraService
array object
Danh sách các dịch vụ của đơn hàng
ServiceName
string
Tên dịch vụ
ServiceID
string
Mã dịch vụ
Cost
number
Phí dịch vụ
DeliveryTimeType
string
Đơn vị thực hiện phát: "1" - 247 phát "2" - Bên thứ 3 phát
Mẫu ví dụ
{
"OrderInfo":{
"ClientHubID":11583,
"CusWareHouseID":"30984",
"ContactName": "Trần Văn B",
"ContactPhone": "0332318317",
"DirectSenderName": "Nguyễn Văn A",
"SenderAddress": "145/6C Trần Bá Giao, Phường 5, Gò Vấp, HCM",
"ReceiverPhone":"0345555777",
"ReceiverName":"Trương Chí Nhân",
"ReceiverAddress":"326 Võ Văn Kiệt, phường Cầu Ông Lãnh, Hồ Chí Minh, Việt Nam",
"ReceiverProvinceName":"Hồ Chí Minh",
"ReceiverDistrictName": null,
"ReceiverWardName":"Phường Cầu Ông Lãnh",
"RealWeight":1,
"Length":0,
"Width":0,
"Height":0,
"Quantity":1,
"Note":"Tài liệu",
"ServiceTypeID":"DE",
"MailerType":"TL",
"CODAmount":0,
"ExternalCode":"HD000003",
"ReferenceCode": "HD000003",
"SpecialInstructionId":1,
"ExtraServices":[
{
"ServiceID":"PTN",
"Type":2
},
{
"ServiceID":"BP",
"Type":2
}
]
}
}Thông tin mã lỗi
1: Thông tin Phường/Xã không chính xác
2: Thông tin Quận/Huyện không chính xác
3: Thông tin Tỉnh/Thành không chính xác
4: Trùng mã đơn hàng
5: Server error
6: Có lỗi xảy ra trong quá trình xử lý
9: Lỗi chưa cập nhật ghi chú đặc biệt
10: Lỗi chưa truyền dịch vụ
11: Địa chỉ gửi hàng không hợp lệ
12: Tài khoản khách hàng không hợp lệ
15: Chưa truyền mã đơn hàng
16: Đơn hàng không hợp lệ
17: Địa chỉ người nhận không hợp lệ
18: Mã loại hàng hóa vận chuyển không hợp lệ
19: Số lượng kiện không hợp lệ
20: Chi tiết kiện không hợp lệ
21: Thông tin người gửi chưa đầy đủ
25: Tiền COP không hợp lệ
Last updated
Was this helpful?