Skip to main content
DELETE
/
shipments
/
{shipment_id}
/
custom_fields
/
{api_slug}
Delete a shipment custom field
curl --request DELETE \
  --url https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug} \
  --header 'Authorization: <api-key>'
import requests

url = "https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug}"

headers = {"Authorization": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug}"

req, _ := http.NewRequest("DELETE", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.terminal49.com/v2/shipments/{shipment_id}/custom_fields/{api_slug}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
Deletes a specific custom field from a shipment by its api_slug.

Path parameters

ParameterRequiredDescription
shipment_idYesThe ID of the shipment
api_slugYesThe api_slug of the custom field definition

Authorization

Requires update permission on the shipment.

Response

Returns 204 No Content on success.

Authorizations

Authorization
string
header
required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Path Parameters

shipment_id
string
required

Shipment ID

api_slug
string
required

Custom field api_slug

Response

204

No Content