7. API huỷ đơn

API dùng để huỷ 1 đơn hàng đã đẩy lên hệ thống GHTK

Endpoint

TH dùng mã vận đơn GHTK

POST /services/shipment/cancel/{TRACKING_ORDER}

warning

Trong trường hợp dùng mã đối tác ( Mã order.id được truyền qua lúc đăng đơn), vui lòng sử dụng theo format dưới đây

• TRACKING_ORDER = partner_id:PARTNER_CODE

POST /services/shipment/cancel/partner_id:{PARTNER_CODE}

Headers

• Token: {API_TOKEN}
• X-Client-Source: {PARTNER_CODE}
• Content-Type: application/json

Tham số

Tham số	Bắt buộc	Mô tả
TRACKING_ORDER	Có	Mã đơn hàng GHTK hoặc mã Đối tác được truyền qua ở trường order.id ở API đăng đơn

Code

HTTP

GET /services/shipment/cancel/{TRACKING_ORDER} HTTP/1.1
Token: {API_TOKEN}
X-Client-Source: {PARTNER_CODE}

CURL

curl -X GET -H "Token: {API_TOKEN}" \
-H "Token: {API_TOKEN}" \
-H "X-Client-Source: {PARTNER_CODE}" \
"https://services.giaohangtietkiem.vn/services/shipment/cancel/{TRACKING_ORDER}"

PHP

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://services.giaohangtietkiem.vn/services/shipment/cancel/{TRACKING_ORDER}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_HTTPHEADER => array(
        "Token: {API_TOKEN}",
    ),
));

$response = curl_exec($curl);
curl_close($curl);

echo 'Response: ' . $response;
?>

Phản hồi

Huỷ thành công

{
  "success": true,
  "message": "",
  "log_id": "..."
}

Đơn hàng đã huỷ

{
  "success": false,
  "message": "Đơn hàng đã đã ở trạng thái hủy",
  "log_id": "..."
}

Các trường hợp không thể huỷ đơn

danger

Các trạng thái sau khi đơn hàng được lấy thành công sẽ không thể huỷ được, API chỉ có thể huỷ đơn ở các trạng thái sau :

• Trạng thái chưa tiếp nhận (1)
• Trạng thái đã tiếp nhận (2)
• Trạng thái đang lấy hàng (12)

{
  "success": false,
  "message": "Đơn đã lấy hàng, không thể hủy đơn.",
  "log_id": "..."
}