List Custom Field Definitions

List custom field definitions

curl --request GET \
  --url https://api.terminal49.com/v2/custom_field_definitions \
  --header 'Authorization: <api-key>'

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

fetch('https://api.terminal49.com/v2/custom_field_definitions', 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/custom_field_definitions",
  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/custom_field_definitions"

	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/custom_field_definitions")

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_definition",
      "attributes": {
        "api_slug": "<string>",
        "display_name": "<string>",
        "description": "<string>",
        "reference_type": "<string>",
        "validation": {},
        "default_format": "<string>",
        "default_value": "<string>"
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

GET

custom_field_definitions

List custom field definitions

curl --request GET \
  --url https://api.terminal49.com/v2/custom_field_definitions \
  --header 'Authorization: <api-key>'

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

fetch('https://api.terminal49.com/v2/custom_field_definitions', 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/custom_field_definitions",
  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/custom_field_definitions"

	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/custom_field_definitions")

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_definition",
      "attributes": {
        "api_slug": "<string>",
        "display_name": "<string>",
        "description": "<string>",
        "reference_type": "<string>",
        "validation": {},
        "default_format": "<string>",
        "default_value": "<string>"
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

List all custom field definitions available to your account.

Query filters

Filter	Description
`filter[entity_type]`	Filter by entity type (`Shipment` or `Cargo`)
`filter[data_type]`	Filter by data type
`filter[display_name]`	Filter by display name (prefix match)

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

Query Parameters

page[number]

integer

default:1

page[size]

integer

default:25

filter[entity_type]

string

Filter by entity type (Shipment or Cargo)

filter[data_type]

string

Filter by data type

filter[display_name]

string

Filter by display name (prefix match)

Response

200 - application/json

data

Custom field definition · 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

Query filters

Authorizations

Query Parameters

Response

​Query filters

Authorizations

Query Parameters

Response

Query filters