cURL
curl --request PATCH \
--url https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}import requests
url = "https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/api/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.example.com/api/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 => "PATCH",
]);
$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.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyShipments
Update shipment custom field
Update an existing custom field value on a shipment in the Terminal49 API, identified by the custom field definition’s api_slug for that shipment record.
PATCH
/
api
/
v2
/
shipments
/
{shipment_id}
/
custom_fields
/
{api_slug}
cURL
curl --request PATCH \
--url https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}import requests
url = "https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.com/api/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.example.com/api/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 => "PATCH",
]);
$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.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/shipments/{shipment_id}/custom_fields/{api_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyUpdates a specific custom field on a shipment by its
api_slug.
Path parameters
| Parameter | Required | Description |
|---|---|---|
shipment_id | Yes | The ID of the shipment |
api_slug | Yes | The api_slug of the custom field definition |
Request body
| Parameter | Required | Description |
|---|---|---|
value | Yes | The new value to set |
Authorization
Requiresupdate permission on the shipment.
Response
Returns200 OK with the updated custom field resource on success.Was this page helpful?