4. API tính phí đơn hàng
API dùng để thực hiện tính toán phí ship và các phụ phí liên quan đến đơn hàng dựa trên các thông tin như địa chỉ lấy hàng, địa chỉ giao hàng, cân nặng, dịch vụ đơn hàng đã chọn ...
Request
Đường dẫn
GET /services/shipment/fee
Headers
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}
Tham số
Tham số | Bắt buộc | Mô tả |
---|---|---|
pick_address_id | no | 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 |
pick_address | no | 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 |
pick_province | yes | String - Tên tỉnh/thành phố nơi lấy hàng hóa |
pick_district | yes | String - Tên quận/huyện nơi lấy hàng hóa |
pick_ward | no | String - Tên phường/xã nơi lấy hàng hóa |
pick_street | no | String - Tên đường/phố nơi lấy hàng hóa |
address | no | 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 |
province | yes | String - Tên tỉnh/thành phố của người nhận hàng hóa |
district | yes | String - Tên quận/huyện của người nhận hàng hóa |
ward | no | String - Tên phường/xã của người nhận hàng hóa |
street | no | String - Tên đường/phố của người nhận hàng hóa |
weight | yes | Integer - Cân nặng của gói hàng, đơn vị sử dụng Gram |
value | no | Integer - Giá trị thực của đơn hàng áp dụng để tính phí bảo hiểm, đơn vị sử dụng VNĐ |
transport | no | 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 |
deliver_option | yes | String - Sử dụng phương thức vận chuyển xfast. Nhận 1 trong 2 giá trị xteam/none |
tags | no | array - Gắn nhãn cho đơn hàng. Truyền giá trị nhãn đơn hàng vào mảng tags |
Code
- HTTP
- CURL
- PHP
GET /services/shipment/fee?address=P.503%20t%C3%B2a%20nh%C3%A0%20Auu%20Vi%E1%BB%87t,%20s%E1%BB%91%201%20L%C3%AA%20%C4%90%E1%BB%A9c%20Th%E1%BB%8D&province=H%C3%A0%20n%E1%BB%99i&district=Qu%E1%BA%ADn%20C%E1%BA%A7u%20Gi%E1%BA%A5y&pick_province=H%C3%A0%20N%E1%BB%99i&pick_district=Qu%E1%BA%ADn%20Hai%20B%C3%A0%20Tr%C6%B0ng&weight=1000&value=3000000&deliver_option=xteam HTTP/1.1
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}
curl -X GET -H "Token: APITokenSample-ca441e70288cB0515F310742" \
"https://services.giaohangtietkiem.vn/services/shipment/fee?address=P.503%20t%C3%B2a%20nh%C3%A0%20Auu%20Vi%E1%BB%87t,%20s%E1%BB%91%201%20L%C3%AA%20%C4%90%E1%BB%A9c%20Th%E1%BB%8D&province=H%C3%A0%20n%E1%BB%99i&district=Qu%E1%BA%ADn%20C%E1%BA%A7u%20Gi%E1%BA%A5y&pick_province=H%C3%A0%20N%E1%BB%99i&pick_district=Qu%E1%BA%ADn%20Hai%20B%C3%A0%20Tr%C6%B0ng&weight=1000&value=3000000&deliver_option=xteam&tags%5B%5D=1"
<?php
$data = array(
"pick_province" => "Hà Nội",
"pick_district" => "Quận Hai Bà Trưng",
"province" => "Hà nội",
"district" => "Quận Cầu Giấy",
"address" => "P.503 tòa nhà Auu Việt, số 1 Lê Đức Thọ",
"weight" => 1000,
"value" => 3000000,
"transport" => "fly",
"deliver_option" => "xteam",
"tags" => [1,7]
);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://services.giaohangtietkiem.vn/services/shipment/fee?" . http_build_query($data),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_HTTPHEADER => array(
"Token: APITokenSample-ca441e70288cB0515F310742",
),
));
$response = curl_exec($curl);
curl_close($curl);
echo 'Response: ' . $response;
?>
Phản hồi
Các thông tin trả về
Tham số | Mô tả |
---|---|
fee.name | String - Tên gói cước được áp dụng, các giá trị có thể: area1 , area2 , area3 |
fee.fee | Integer - Cước vận chuyển tính theo VNĐ |
fee.insurance_fee | Integer - Giá bảo hiểm tính theo VNĐ |
fee.delivery | Boolean - Hỗ trợ giao ở địa chỉ này chưa, nếu điểm giao đã được GHTK hỗ trợ giao trả về true , nếu GTHK chưa hỗ trợ giao đến khu vực này thì trả về false |