Delete Shipment
It is called when a tendered load is withdrawn or canceled in shipper's system. Loads are deleted asynchronously. An HTTP 200 response simply indicates the request was valid and submitted loads will be deleted soon if they are in a state in which they can be deleted.
Note that you will be charged for the loads that get deleted.
This API accepts up to 100 loads in a single request and it is recommended to batch multiple loads in a single request.
Rate Limit
1 request per second
Authenticated Resource
API Key
For more information on Authentication, click here.
Request Attributes
Name | Format | Validation | Description |
|---|---|---|---|
trackingIds | Array of Integers | Required | List of unique FourKites® internal loadId(s) that are returned during load creation. |
Response Attributes
Name | Format | Description |
|---|---|---|
message | String | It represents the status of the request submitted. |
statusCode | String | HTTP StatusCode of the response. |
deletedTrackingIds | Array of Integer | List of load ids accepted for deletion. |
curl --location --request POST 'https://api.fourkites.com/api/v1/tracking/delete_loads' \
--header 'Content-Type: application/json' \
--header 'apikey: REPLACE_KEY_VALUE' \
--data-raw '{
"trackingIds": [1234,1235,1236]
}'
import http.client
import mimetypes
conn = http.client.HTTPSConnection("api-staging.fourkites.com")
payload = "{\n \"trackingIds\": [1234,1235,1236]\n}"
headers = {
'Content-Type': 'application/json',
'apikey': 'REPLACE_KEY_VALUE'
}
conn.request("POST", "/api/v1/tracking/delete_loads", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))