7. Order cancellation API

This API is used to cancel an order that has been pushed to the GHTK system

Endpoint

When using GHTK’s tracking code:

POST /services/shipment/cancel/{TRACKING_ORDER}

warning

If you are using the partner’s order code (the order.id value provided during order creation), please use the format below:

• 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

Parameters

Parameter	Required	Description
TRACKING_ORDER	Yes	The GHTK order code or the partner’s order code is passed through the order.id field in the order creation API

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;
?>

Response

Successful cancellation

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

Canceled order

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

Cases where order cancellation is not allowed

danger

Orders cannot be canceled once they have been successfully picked up. The API can only cancel orders in the following statuses:

• “Not yet received” status (1)
• “Received” status (2)
• “Picking up in progress” status (12)

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