Delete /api/v1/shipments
This API endpoint sends an HTTP DELETE request to remove the shipment with the passed ID.
Delete a shipment record by passing in a shipment id to the delete endpoint.
Request parameters:
id
id *required integer($int32) (path) Pass the ID of the shipment to delete.
This API endpoint sends an HTTP DELETE request to remove the shipment with the passed ID. Upon successful execution, the server returns a status code of 204 with a Content-Type of text/xml. No specific response data is provided.
Sample code
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://api.locate2u.com/api/v1/shipments/174495");
request.Headers.Add("Authorization", "Bearer yourBearerTokenHere");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://api.locate2u.com/api/v1/shipments/174495")
.method("DELETE", body)
.addHeader("Authorization", "Bearer yourBearerTokenHere")
.build();
Response response = client.newCall(request).execute();
var https = require('follow-redirects').https;
var fs = require('fs');
var options = {
'method': 'DELETE',
'hostname': 'api.locate2u.com',
'path': '/api/v1/shipments/174495',
'headers': {
'Authorization': 'Bearer yourBearerTokenHere'
},
'maxRedirects': 20
};
var req = https.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function (chunk) {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
res.on("error", function (error) {
console.error(error);
});
});
req.end();
'https://api.locate2u.com/api/v1/shipments/174495',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer yourBearerTokenHere'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
import requests
url = "https://api.locate2u.com/api/v1/shipments/174495"
payload = {}
headers = {
'Authorization': 'Bearer yourBearerTokenHere'
}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
Response
Upon successful execution, the server returns a status code of 204 with a Content-Type of text/xml. No specific response data is provided.