Update a Bill
API for Updating a Bill
API Configuration
HTTP Request
POST /v1/bill/update-shipping
Parameter | Type | Require | Description |
---|---|---|---|
partner_id | Number | Partner ID, that created on Web portal | |
bill_code | String | Bill code | |
cod_amount | Double | Amount of COD to collect when package delivered to receiver | |
cargo_value | Double | Brief value of Package Product Items | |
weight | Double | Weight of package | |
length | Double | Length of package | |
height | Double | Height of package | |
width | Double | Width of package | |
cargo_content | String | Brief description of Package Product Items | |
receiver_phone | String | Receiver's contact phone number | |
receiver_name | String | Full name of receiver | |
receiver_address | String | Full address of receiver (should be format: 52A Nguyễn Thái Bình) | |
package_no | Number | Number of packages | |
is_return_doc | Number | If yes, return the correct service, if not, return all services | |
note | String | Note for shipping |
JSON body respone
Name | Type | Description |
---|---|---|
success | boolean | Return true if create bill success, all other false means error. See message for further description. |
message | string | Return Message of API Respond. |
data | object | Data of API response. |
Sample Request
{
"partner_id": 123736,
"bill_code": "TEST-009",
"cod_amount": 200000,
"is_return_doc": 0
}
Sample 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"
}
}
Response Failed
{
"success": false,
"message": "descriptions for detail error",
"data": {}
}