List Container Custom Fields

List container custom fields

curl --request GET \
  --url https://api.terminal49.com/v2/containers/{container_id}/custom_fields \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.terminal49.com/v2/containers/{container_id}/custom_fields"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.terminal49.com/v2/containers/{container_id}/custom_fields', 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/containers/{container_id}/custom_fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/containers/{container_id}/custom_fields"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.terminal49.com/v2/containers/{container_id}/custom_fields")

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

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

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "custom_field",
      "attributes": {
        "api_slug": "<string>",
        "value": "<string>",
        "display_value": "<string>"
      },
      "relationships": {
        "entity": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "definition": {
          "data": {
            "type": "custom_field_definition",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

GET

containers

{container_id}

custom_fields

List container custom fields

curl --request GET \
  --url https://api.terminal49.com/v2/containers/{container_id}/custom_fields \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.terminal49.com/v2/containers/{container_id}/custom_fields"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.terminal49.com/v2/containers/{container_id}/custom_fields', 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/containers/{container_id}/custom_fields",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/containers/{container_id}/custom_fields"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.terminal49.com/v2/containers/{container_id}/custom_fields")

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

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

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "custom_field",
      "attributes": {
        "api_slug": "<string>",
        "value": "<string>",
        "display_value": "<string>"
      },
      "relationships": {
        "entity": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "definition": {
          "data": {
            "type": "custom_field_definition",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

Lists all custom fields attached to a specific container.

Path parameters

Parameter	Required	Description
`container_id`	Yes	The ID of the container

Authorization

Requires show permission on the container.

Response

Returns a JSONAPI array of custom field resources including:

value - The raw stored value
display_value - Formatted value for display
Relationships to the definition and user who last updated the field

Authorizations

Authorization

string

header

required

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Path Parameters

container_id

string

required

Container ID

Response

200 - application/json

data

Custom field · object[]

Show child attributes

links

links · object

Show child attributes

Tracking Requests

Shipments

Containers

Webhooks

Webhook Notifications

Custom Field Definitions

Custom Field Options

Custom Fields

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Parties

Path parameters

Authorization

Response

Authorizations

Path Parameters

Response

​Path parameters

​Authorization

​Response

Authorizations

Path Parameters

Response

Path parameters

Authorization

Response