Cập nhật vận đơn

Cập nhật vận đơn

API Cập nhật vận đơn

Cấu hình API

HTTP Request

POST /v1/bill/update-shipping

ParameterTypeRequireDescription
partner_idNumberAlt textPartner ID, được tạo trên Web portal
bill_codeStringAlt textMã Bill
cod_amountDoubleSố tiền COD thu khi giao hàng cho người nhận.
cargo_valueDoubleGiá trị hàng hoá
weightDoubleTrọng lượng hàng hoá
lengthDoubleDài
heightDoubleCao
widthDoubleRộng
cargo_contentStringMô tả sơ về hàng hóa của đơn vận chuyển
receiver_phoneStringSố điện thoại người nhận
receiver_nameStringTên người nhận
receiver_addressStringĐịa chỉ đầy đủ của người nhận (phải đúng định dạng: 52A Nguyễn Thái Bình).
package_noNumberSố kiện
is_return_docNumberCó chuyển hoàn chứng từ không (1: Có; 0: Không; Mặc định để 0)
noteStringGhi chú đơn hàng, lưu ý khi vận chuyển hàng hóa/ giao hàng

JSON body respone

NameTypeDescription
successbooleanReturn true if create bill success, all other false means error. See message for further description.
messagestringReturn Message of API Respond.
dataobjectData of API response.

Mẫu Request

{
   "partner_id": 123736,
   "bill_code": "TEST-009",
   "cod_amount": 200000,
   "is_return_doc": 0
}

Mẫu Response

 
   {
    "success": true,
    "message": "Update successful",
    "data": {
        "bill_id": 159839,
        "bill_code": "CP15983901",
        "ref_code": "TEST-009",
        "status_id": 2,
        "cod_amount": 200000,
        "service_id": 10,
        "payment_method": 10,
        "created_at": "2022-12-01 15:31:30",
        "main_fee": 33462,
        "cod_fee": 0,
        "insurr_fee": 5500,
        "lifting_fee": 0,
        "remote_fee": 0,
        "counting_fee": 0,
        "packing_fee": 0,
        "total_fee": 38962,
        "partner_address_id": 24371,
        "receiver_name": "Nguyễn Văn A",
        "receiver_phone": "09xxxxxxxx",
        "receiver_address": "52A, Nguyễn Thái Bình, P4, Tân Bình, TP.HCM",
        "package_no": 1,
        "weight": 1.3,
        "cargo_content": "Quần áo",
        "cargo_value": 1000000,
        "note": "ghi chú đơn hàng"
    }
}

Mẫu Response Failed

{
    "success": false,
    "message": "descriptions for detail error",
    "data": {}
}