Vận chuyển
Tạo vận đơn
Tạo vận đơn trong Hubport cho một phiếu xuất kho của đơn bán
Endpoint
POST /v1/shippingbills
Quyền:
inventory.dispatchprocess
Tạo vận đơn trong Hubport (chưa gửi sang hãng). Sau khi tạo, gọi Đẩy vận đơn sang hãng để tạo đơn tại hãng vận chuyển. Mỗi phiếu xuất kho chỉ tạo được một vận đơn.
Request Body
| Trường | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
company_id | int | Có | ID công ty |
creator_id | int | Có | ID người tạo |
sale_order_id | int | Có | ID đơn bán (thuộc công ty) |
product_receipt_id | int | Có | ID phiếu xuất kho của đơn |
shipping_carrier_id | int | Có | ID hãng vận chuyển |
address | string | Có* | Địa chỉ người nhận |
region_id | int | Có* | ID tỉnh/thành |
sub_region_id | int | Có* | ID quận/huyện (hoặc phường/xã theo mô hình địa chỉ mới) |
sub_sub_region_id | int | Không | ID phường/xã |
contact_full_name | string | Có* | Tên người nhận |
contact_phone | string | Có* | SĐT người nhận (tối thiểu 8 ký tự) |
weight | int | Có* | Khối lượng (gram), tối thiểu 50 |
length, width, height | int | Không | Kích thước kiện (cm) |
cod | int | Không | Tiền thu hộ (VND) |
insurance_value | int | Không | Giá trị khai báo bảo hiểm (VND) |
shipping_batch_id | int | Không | ID lô vận chuyển (bỏ qua nếu không hợp lệ) |
address_line_2 | string | Không | Địa chỉ dòng 2 |
delivery_note | string | Không | Ghi chú giao hàng |
legacy_province_name, legacy_district_name, legacy_ward_name | string | Không | Tên địa chính theo địa chỉ cũ |
carrier_name | string | Không | Tên hãng (ghi chú) |
package_preset_id | int | Không | ID mẫu kiện hàng |
note | string | Không | Ghi chú |
* Bắt buộc khi carrier có tích hợp API (api_type khác 1).
Workflow & Logic
- Vận đơn mới có
status=1(chờ lấy hàng). gateway_status=3(chờ đẩy) với GHTK/SuperAI, các hãng khác là1.- Đơn bán được cập nhật trạng thái xử lý "sẵn sàng giao" và trạng thái giao hàng "đã tạo vận đơn".
Response Schema
HTTP 201 - JSON Object
Shipping Bill Object vừa tạo.
Error Codes
| Mã lỗi | Mô tả |
|---|---|
error_sale_order_id_required | Thiếu sale_order_id (HTTP 422) |
error_sale_order_id_invalid | Đơn bán không tồn tại hoặc không thuộc công ty (HTTP 422) |
error_product_receipt_id_required | Thiếu product_receipt_id (HTTP 422) |
error_product_receipt_id_invalid | Phiếu xuất kho không hợp lệ (HTTP 422) |
error_product_receipt_id_already_create_shipping_bill | Phiếu xuất kho đã có vận đơn (HTTP 422) |
error_shipping_carrier_id_required | Thiếu shipping_carrier_id (HTTP 422) |
error_shipping_carrier_id_invalid | Carrier không tồn tại hoặc không thuộc công ty (HTTP 422) |
error_address_required | Thiếu địa chỉ (HTTP 422) |
error_region_id_required | Thiếu region_id (HTTP 422) |
error_sub_region_id_required | Thiếu sub_region_id (HTTP 422) |
error_contact_phone_required | Thiếu SĐT người nhận (HTTP 422) |
error_contact_phone_too_short | SĐT người nhận dưới 8 ký tự (HTTP 422) |
error_contact_full_name_required | Thiếu tên người nhận (HTTP 422) |
error_weight_atleast_50gr | Khối lượng dưới 50 gram (HTTP 422) |
error_role_not_available | Không có quyền inventory.dispatchprocess (HTTP 403) |
error_add | Lỗi hệ thống khi lưu (HTTP 500) |