6. API in đơn hàng
API dùng để in nhãn đơn hàng của GHTK
thông tin
Nhãn đơn hàng là tem nhãn được dán lên kiện hàng, ghi rõ các thông tin quan trọng của đơn hàng gồm: mã vận đơn, mã vạch, thông tin sản phẩm, phương thức vận chuyển....
- GHTK cung cấp 2 mẫu nhãn đơn hàng, gồm: khổ dọc và khổ ngang
- Kích thước hỗ trợ : A5 hoặc A6 (Mặc định )
Mẫu nhãn đơn hàng
Mẫu label A5 khổ ngang:
Mẫu label A5 khổ dọc
Request
Đường dẫn
GET /services/label/{TRACKING_ORDER}?original={ORIGINAL}&paper_size={PAPER_SIZE}
Headers
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}
Tham số
Tham số | Bắt buộc | Mô tả |
---|---|---|
TRACKING_ORDER | Có | Mã vận đơn GHTK |
ORIGINAL | Không | String - Kiểu in nhãn portrait (in dọc) hoặc landscape (in ngang) (mặc định là portrait) |
PAPER_SIZE | Không | String - Khổ in của nhãn A5 , A6 (mặc định là A6) |
Code
- HTTP
- CURL
- PHP
GET /services/label/{TRACKING_ORDER} HTTP/1.1
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}
curl -X GET -H "Token: {API_TOKEN}" \
-H "Token: {API_TOKEN}" \
-H "X-Client-Source: {PARTNER_CODE}" \
"https://services.giaohangtietkiem.vn/services/label/{TRACKING_ORDER}"
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://services.giaohangtietkiem.vn/services/label/{TRACKING_ORDER}",
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
Kết quả trả về
Hệ thống sẽ trả về kết quả dưới dạng binary file PDF. Kết quả trả về được mô tả như sau:
Thành công
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename=""
Content-Transfer-Encoding: binary
Trường hợp có lỗi
Kết quả sẽ trả về với định dạng JSON
{
"success": false,
"message": "Mã vận đơn không hợp lệ, không tìm thấy vận đơn"
}