List Shipments

List shipments

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

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

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

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

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": "62738624-7032-4a50-892e-c55826228c25",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T17:28:59Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2148468620",
        "normalized_number": "2148468620",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "CNNBG",
        "port_of_lading_name": "Ningbo",
        "port_of_discharge_locode": "USLAX",
        "port_of_discharge_name": "Los Angeles",
        "pod_vessel_name": "EVER FORWARD",
        "pod_vessel_imo": "9850551",
        "pod_voyage_number": "1119E",
        "destination_locode": "USCLE",
        "destination_name": "Cleveland",
        "destination_timezone": "America/New_York",
        "destination_ata_at": null,
        "destination_eta_at": "2024-07-02T08:00:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-06-09T03:42:00Z",
        "pol_timezone": "Asia/Shanghai",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-22T13:36:00Z",
        "pod_timezone": "America/Los_Angeles",
        "line_tracking_last_attempted_at": "2024-06-26T17:28:59Z",
        "line_tracking_last_succeeded_at": "2024-06-26T17:28:59Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/62738624-7032-4a50-892e-c55826228c25"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "2a90c27b-c2ee-45e2-892f-5c695d74e2d0",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "47b27584-4ec9-4e2f-95e1-7a42928cc40c",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "42c53b13-0d29-4fa6-8663-7343a56319f1",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "3b1cc325-ffe9-400a-82ce-f5c4891af382",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": {
            "id": "ce22669e-14b2-4501-b782-f0a360f07cd0",
            "type": "terminal"
          }
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "7aefc29e-0898-4825-8376-4f998b51d033",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "baaa725e-aa0e-4937-ac78-54d9e2e8621e",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T16:47:42Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "HDMUTAOM72244900",
        "normalized_number": "TAOM72244900",
        "shipping_line_scac": "HDMU",
        "shipping_line_name": "Hyundai Merchant Marine",
        "shipping_line_short_name": "Hyundai",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "CNQDG",
        "port_of_lading_name": "Qingdao",
        "port_of_discharge_locode": "USSAV",
        "port_of_discharge_name": "Savannah",
        "pod_vessel_name": "UMM SALAL",
        "pod_vessel_imo": "9525857",
        "pod_voyage_number": "0038E",
        "destination_locode": "USROQ",
        "destination_name": "Rossville",
        "destination_timezone": "America/Chicago",
        "destination_ata_at": null,
        "destination_eta_at": "2024-06-30T07:05:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-05-07T03:01:00Z",
        "pol_timezone": "Asia/Shanghai",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-20T21:27:00Z",
        "pod_timezone": "America/New_York",
        "line_tracking_last_attempted_at": "2024-06-26T16:48:04Z",
        "line_tracking_last_succeeded_at": "2024-06-26T16:48:04Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/baaa725e-aa0e-4937-ac78-54d9e2e8621e"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "0ccbe8af-c8d0-4abd-a842-3bfad1d82024",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "6129528d-846e-4571-ae16-b5328a4285ab",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "a243bdf8-0da3-4056-a6a7-05fe8ab43999",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "87ca3f37-e4d1-46eb-9eb1-6b5ffafde95d",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": null
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "772cd872-9677-4c68-9b7a-4e9e843b00e2",
              "type": "container"
            },
            {
              "id": "52efc544-0de1-452f-bcf8-0290a6ce5c11",
              "type": "container"
            },
            {
              "id": "3107692e-61ad-4b4c-b3d4-78348b2e37ff",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "7721a48c-5e93-43c9-9f5f-5be10a87fdde",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T16:28:39Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2738424980",
        "normalized_number": "2738424980",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "ITSPE",
        "port_of_lading_name": "La Spezia",
        "port_of_discharge_locode": "USSAV",
        "port_of_discharge_name": "Savannah",
        "pod_vessel_name": "OOCL GUANGZHOU",
        "pod_vessel_imo": "9404869",
        "pod_voyage_number": "162E",
        "destination_locode": "USATL",
        "destination_name": "Atlanta",
        "destination_timezone": "America/New_York",
        "destination_ata_at": null,
        "destination_eta_at": "2024-06-27T06:42:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-06-05T08:03:00Z",
        "pol_timezone": "Europe/Rome",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-23T15:34:00Z",
        "pod_timezone": "America/New_York",
        "line_tracking_last_attempted_at": "2024-06-26T16:28:39Z",
        "line_tracking_last_succeeded_at": "2024-06-26T16:28:39Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/7721a48c-5e93-43c9-9f5f-5be10a87fdde"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "b5656766-a56f-4b32-8e03-d240e7519604",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "6129528d-846e-4571-ae16-b5328a4285ab",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "a243bdf8-0da3-4056-a6a7-05fe8ab43999",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "7daf9ea3-3018-4d62-b88c-43803df9030c",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": {
            "id": "022ef8fc-1e2a-4ad6-8eae-330d65eb1c8e",
            "type": "terminal"
          }
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "2a25fd3e-a18e-47cc-9cea-62771e82d0f2",
              "type": "container"
            },
            {
              "id": "6cdc725d-2b31-40f9-86dd-76225390a488",
              "type": "container"
            },
            {
              "id": "2f1e9a9d-4689-4f4d-84a8-64409b56521d",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "32b5ad78-43ba-42d9-bdc0-4cf12320e020",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T15:59:52Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2738277190",
        "normalized_number": "2738277190",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "CNQDG",
        "port_of_lading_name": "Qingdao",
        "port_of_discharge_locode": "USLAX",
        "port_of_discharge_name": "Los Angeles",
        "pod_vessel_name": "EVER FORWARD",
        "pod_vessel_imo": "9850551",
        "pod_voyage_number": "1119E",
        "destination_locode": "USMEM",
        "destination_name": "Memphis",
        "destination_timezone": "America/Chicago",
        "destination_ata_at": null,
        "destination_eta_at": "2024-07-01T14:00:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-06-02T18:22:00Z",
        "pol_timezone": "Asia/Shanghai",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-22T13:36:00Z",
        "pod_timezone": "America/Los_Angeles",
        "line_tracking_last_attempted_at": "2024-06-26T15:59:52Z",
        "line_tracking_last_succeeded_at": "2024-06-26T15:59:52Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/32b5ad78-43ba-42d9-bdc0-4cf12320e020"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "0ccbe8af-c8d0-4abd-a842-3bfad1d82024",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "47b27584-4ec9-4e2f-95e1-7a42928cc40c",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "42c53b13-0d29-4fa6-8663-7343a56319f1",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "ba0b9f68-2025-40ca-ae12-1c2210cca333",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": {
            "id": "d0ec0da1-8a3a-4b11-b1e3-5716bbc71dc3",
            "type": "terminal"
          }
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "60d2fd62-14e2-4ca2-a927-9633fc58fdff",
              "type": "container"
            },
            {
              "id": "0ffe3e75-b3df-4d20-b9f4-97bbbcec404d",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "bd117d3b-8fa4-487c-9bab-25c15e227d1a",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T15:59:35Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2147973020",
        "normalized_number": "2147973020",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "IDSUB",
        "port_of_lading_name": "Surabaya",
        "port_of_discharge_locode": "USLAX",
        "port_of_discharge_name": "Los Angeles",
        "pod_vessel_name": "CMA CGM A.LINCOLN",
        "pod_vessel_imo": "9780859",
        "pod_voyage_number": "1TU70E1MA",
        "destination_locode": null,
        "destination_name": null,
        "destination_timezone": null,
        "destination_ata_at": null,
        "destination_eta_at": null,
        "pol_etd_at": null,
        "pol_atd_at": "2024-05-14T02:37:00Z",
        "pol_timezone": "Asia/Jakarta",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-23T21:58:00Z",
        "pod_timezone": "America/Los_Angeles",
        "line_tracking_last_attempted_at": "2024-06-26T15:59:35Z",
        "line_tracking_last_succeeded_at": "2024-06-26T15:59:35Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/bd117d3b-8fa4-487c-9bab-25c15e227d1a"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "4201ab42-c51f-48ac-b7a1-12146e02c6a2",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "47b27584-4ec9-4e2f-95e1-7a42928cc40c",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "eaa2580c-5f5b-4198-85e4-821145d62098",
            "type": "terminal"
          }
        },
        "destination": {
          "data": null
        },
        "destination_terminal": {
          "data": null
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "815ff702-fdb5-4455-a28e-314c345d7481",
              "type": "container"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "size": 5,
    "total": 34044
  },
  "links": {
    "self": "https://api.terminal49.com/v2/shipments?page[size]=5",
    "current": "https://api.terminal49.com/v2/shipments?page[number]=1&page[size]=5",
    "next": "https://api.terminal49.com/v2/shipments?page[number]=2&page[size]=5",
    "last": "https://api.terminal49.com/v2/shipments?page[number]=6809&page[size]=5"
  }
}

{
  "errors": [
    {
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "code": "<string>",
      "status": "<string>",
      "meta": {}
    }
  ]
}

GET

shipments

List shipments

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

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

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

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

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": "62738624-7032-4a50-892e-c55826228c25",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T17:28:59Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2148468620",
        "normalized_number": "2148468620",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "CNNBG",
        "port_of_lading_name": "Ningbo",
        "port_of_discharge_locode": "USLAX",
        "port_of_discharge_name": "Los Angeles",
        "pod_vessel_name": "EVER FORWARD",
        "pod_vessel_imo": "9850551",
        "pod_voyage_number": "1119E",
        "destination_locode": "USCLE",
        "destination_name": "Cleveland",
        "destination_timezone": "America/New_York",
        "destination_ata_at": null,
        "destination_eta_at": "2024-07-02T08:00:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-06-09T03:42:00Z",
        "pol_timezone": "Asia/Shanghai",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-22T13:36:00Z",
        "pod_timezone": "America/Los_Angeles",
        "line_tracking_last_attempted_at": "2024-06-26T17:28:59Z",
        "line_tracking_last_succeeded_at": "2024-06-26T17:28:59Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/62738624-7032-4a50-892e-c55826228c25"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "2a90c27b-c2ee-45e2-892f-5c695d74e2d0",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "47b27584-4ec9-4e2f-95e1-7a42928cc40c",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "42c53b13-0d29-4fa6-8663-7343a56319f1",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "3b1cc325-ffe9-400a-82ce-f5c4891af382",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": {
            "id": "ce22669e-14b2-4501-b782-f0a360f07cd0",
            "type": "terminal"
          }
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "7aefc29e-0898-4825-8376-4f998b51d033",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "baaa725e-aa0e-4937-ac78-54d9e2e8621e",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T16:47:42Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "HDMUTAOM72244900",
        "normalized_number": "TAOM72244900",
        "shipping_line_scac": "HDMU",
        "shipping_line_name": "Hyundai Merchant Marine",
        "shipping_line_short_name": "Hyundai",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "CNQDG",
        "port_of_lading_name": "Qingdao",
        "port_of_discharge_locode": "USSAV",
        "port_of_discharge_name": "Savannah",
        "pod_vessel_name": "UMM SALAL",
        "pod_vessel_imo": "9525857",
        "pod_voyage_number": "0038E",
        "destination_locode": "USROQ",
        "destination_name": "Rossville",
        "destination_timezone": "America/Chicago",
        "destination_ata_at": null,
        "destination_eta_at": "2024-06-30T07:05:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-05-07T03:01:00Z",
        "pol_timezone": "Asia/Shanghai",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-20T21:27:00Z",
        "pod_timezone": "America/New_York",
        "line_tracking_last_attempted_at": "2024-06-26T16:48:04Z",
        "line_tracking_last_succeeded_at": "2024-06-26T16:48:04Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/baaa725e-aa0e-4937-ac78-54d9e2e8621e"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "0ccbe8af-c8d0-4abd-a842-3bfad1d82024",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "6129528d-846e-4571-ae16-b5328a4285ab",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "a243bdf8-0da3-4056-a6a7-05fe8ab43999",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "87ca3f37-e4d1-46eb-9eb1-6b5ffafde95d",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": null
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "772cd872-9677-4c68-9b7a-4e9e843b00e2",
              "type": "container"
            },
            {
              "id": "52efc544-0de1-452f-bcf8-0290a6ce5c11",
              "type": "container"
            },
            {
              "id": "3107692e-61ad-4b4c-b3d4-78348b2e37ff",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "7721a48c-5e93-43c9-9f5f-5be10a87fdde",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T16:28:39Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2738424980",
        "normalized_number": "2738424980",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "ITSPE",
        "port_of_lading_name": "La Spezia",
        "port_of_discharge_locode": "USSAV",
        "port_of_discharge_name": "Savannah",
        "pod_vessel_name": "OOCL GUANGZHOU",
        "pod_vessel_imo": "9404869",
        "pod_voyage_number": "162E",
        "destination_locode": "USATL",
        "destination_name": "Atlanta",
        "destination_timezone": "America/New_York",
        "destination_ata_at": null,
        "destination_eta_at": "2024-06-27T06:42:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-06-05T08:03:00Z",
        "pol_timezone": "Europe/Rome",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-23T15:34:00Z",
        "pod_timezone": "America/New_York",
        "line_tracking_last_attempted_at": "2024-06-26T16:28:39Z",
        "line_tracking_last_succeeded_at": "2024-06-26T16:28:39Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/7721a48c-5e93-43c9-9f5f-5be10a87fdde"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "b5656766-a56f-4b32-8e03-d240e7519604",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "6129528d-846e-4571-ae16-b5328a4285ab",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "a243bdf8-0da3-4056-a6a7-05fe8ab43999",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "7daf9ea3-3018-4d62-b88c-43803df9030c",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": {
            "id": "022ef8fc-1e2a-4ad6-8eae-330d65eb1c8e",
            "type": "terminal"
          }
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "2a25fd3e-a18e-47cc-9cea-62771e82d0f2",
              "type": "container"
            },
            {
              "id": "6cdc725d-2b31-40f9-86dd-76225390a488",
              "type": "container"
            },
            {
              "id": "2f1e9a9d-4689-4f4d-84a8-64409b56521d",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "32b5ad78-43ba-42d9-bdc0-4cf12320e020",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T15:59:52Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2738277190",
        "normalized_number": "2738277190",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "CNQDG",
        "port_of_lading_name": "Qingdao",
        "port_of_discharge_locode": "USLAX",
        "port_of_discharge_name": "Los Angeles",
        "pod_vessel_name": "EVER FORWARD",
        "pod_vessel_imo": "9850551",
        "pod_voyage_number": "1119E",
        "destination_locode": "USMEM",
        "destination_name": "Memphis",
        "destination_timezone": "America/Chicago",
        "destination_ata_at": null,
        "destination_eta_at": "2024-07-01T14:00:00Z",
        "pol_etd_at": null,
        "pol_atd_at": "2024-06-02T18:22:00Z",
        "pol_timezone": "Asia/Shanghai",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-22T13:36:00Z",
        "pod_timezone": "America/Los_Angeles",
        "line_tracking_last_attempted_at": "2024-06-26T15:59:52Z",
        "line_tracking_last_succeeded_at": "2024-06-26T15:59:52Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/32b5ad78-43ba-42d9-bdc0-4cf12320e020"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "0ccbe8af-c8d0-4abd-a842-3bfad1d82024",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "47b27584-4ec9-4e2f-95e1-7a42928cc40c",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "42c53b13-0d29-4fa6-8663-7343a56319f1",
            "type": "terminal"
          }
        },
        "destination": {
          "data": {
            "id": "ba0b9f68-2025-40ca-ae12-1c2210cca333",
            "type": "port"
          }
        },
        "destination_terminal": {
          "data": {
            "id": "d0ec0da1-8a3a-4b11-b1e3-5716bbc71dc3",
            "type": "terminal"
          }
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "60d2fd62-14e2-4ca2-a927-9633fc58fdff",
              "type": "container"
            },
            {
              "id": "0ffe3e75-b3df-4d20-b9f4-97bbbcec404d",
              "type": "container"
            }
          ]
        }
      }
    },
    {
      "id": "bd117d3b-8fa4-487c-9bab-25c15e227d1a",
      "type": "shipment",
      "attributes": {
        "created_at": "2024-06-26T15:59:35Z",
        "ref_numbers": [],
        "tags": [],
        "bill_of_lading_number": "OOLU2147973020",
        "normalized_number": "2147973020",
        "shipping_line_scac": "OOLU",
        "shipping_line_name": "Orient Overseas Container Line",
        "shipping_line_short_name": "OOCL",
        "customer_name": "Sodor Steamworks",
        "port_of_lading_locode": "IDSUB",
        "port_of_lading_name": "Surabaya",
        "port_of_discharge_locode": "USLAX",
        "port_of_discharge_name": "Los Angeles",
        "pod_vessel_name": "CMA CGM A.LINCOLN",
        "pod_vessel_imo": "9780859",
        "pod_voyage_number": "1TU70E1MA",
        "destination_locode": null,
        "destination_name": null,
        "destination_timezone": null,
        "destination_ata_at": null,
        "destination_eta_at": null,
        "pol_etd_at": null,
        "pol_atd_at": "2024-05-14T02:37:00Z",
        "pol_timezone": "Asia/Jakarta",
        "pod_eta_at": null,
        "pod_original_eta_at": null,
        "pod_ata_at": "2024-06-23T21:58:00Z",
        "pod_timezone": "America/Los_Angeles",
        "line_tracking_last_attempted_at": "2024-06-26T15:59:35Z",
        "line_tracking_last_succeeded_at": "2024-06-26T15:59:35Z",
        "line_tracking_stopped_at": null,
        "line_tracking_stopped_reason": null
      },
      "links": {
        "self": "/v2/shipments/bd117d3b-8fa4-487c-9bab-25c15e227d1a"
      },
      "relationships": {
        "port_of_lading": {
          "data": {
            "id": "4201ab42-c51f-48ac-b7a1-12146e02c6a2",
            "type": "port"
          }
        },
        "port_of_discharge": {
          "data": {
            "id": "47b27584-4ec9-4e2f-95e1-7a42928cc40c",
            "type": "port"
          }
        },
        "pod_terminal": {
          "data": {
            "id": "eaa2580c-5f5b-4198-85e4-821145d62098",
            "type": "terminal"
          }
        },
        "destination": {
          "data": null
        },
        "destination_terminal": {
          "data": null
        },
        "line_tracking_stopped_by_user": {
          "data": null
        },
        "containers": {
          "data": [
            {
              "id": "815ff702-fdb5-4455-a28e-314c345d7481",
              "type": "container"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "size": 5,
    "total": 34044
  },
  "links": {
    "self": "https://api.terminal49.com/v2/shipments?page[size]=5",
    "current": "https://api.terminal49.com/v2/shipments?page[number]=1&page[size]=5",
    "next": "https://api.terminal49.com/v2/shipments?page[number]=2&page[size]=5",
    "last": "https://api.terminal49.com/v2/shipments?page[number]=6809&page[size]=5"
  }
}

{
  "errors": [
    {
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "code": "<string>",
      "status": "<string>",
      "meta": {}
    }
  ]
}

See the complete filter reference for values, operators, multi-value semantics, and limitations. For combined requests, see filter usage.

Authorizations

Authorization

string

header

required

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

Authorization: Token YOUR_API_KEY

Query Parameters

page[number]

integer

default:1

Required range: x >= 1

page[size]

integer

default:30

Records per page. Default 30.

Required range: x >= 1

string

Deprecated compatibility alias for filter[q]. Nested filter[q] takes precedence. A blank top-level q returns 400. No sunset date is documented.

include

string

Comma delimited list of relations to include

flag[parties]

boolean

Set to true to add the party_roles relationship to each shipment. Add include=party_roles.party to embed the roles and their parties.

number

string

Compatibility alias for filter[number]. Exact shipment number, including punctuation; not a partial container-number search. Nested filter[number] takes precedence.

tracking_stopped

boolean

Compatibility alias for filter[tracking_stopped]. Nested filter takes precedence.

sort

string

Supported values: created_at, -created_at, pod_arrival, -pod_arrival, tracking_stopped_at, -tracking_stopped_at. Both created_at tokens sort newest first for compatibility. Unknown values fall back to newest creation first.

filter[q]

string

Prefix text search across shipment numbers, reference numbers, and linked container identifiers. Use search text, not comparison expressions.

filter[number]

string

Exact number match. Shipment arrays mean OR; container arrays of exact numbers mean AND. Use comma-separated container numbers for OR. Shipment scalar commas are literal.

filter[number][]

string[]

Bracketed array form of filter[number]. Exact number match. Shipment arrays mean OR; container arrays of exact numbers mean AND. Use comma-separated container numbers for OR. Shipment scalar commas are literal.

Minimum array length: 1

filter[created_at]

string

Creation date. Use an ISO 8601 date-time with Z or a timezone offset; prefix with =, <, <=, >, or >=. Arrays combine bounds with AND. Relative dates and comma-separated timestamps are not accepted. Use @exists or @not_exists for presence.

filter[created_at][]

string[]

Bracketed array form of filter[created_at]. Creation date. Use an ISO 8601 date-time with Z or a timezone offset; prefix with =, <, <=, >, or >=. Arrays combine bounds with AND. Relative dates and comma-separated timestamps are not accepted. Use @exists or @not_exists for presence.

Minimum array length: 1

filter[actively_tracked]

boolean

true selects shipments with tracking not stopped; false selects stopped tracking. Applies via the related shipment for containers.

filter[tracking_stopped]

boolean

true selects stopped tracking; false selects tracking not stopped. Combines with other filters using AND.

filter[voyage_status]

enum<string>

arrived means actual POD arrival is present; on_ship means a voyage exists and actual POD arrival is absent. It is not a general shipment lifecycle status.

Available options:

arrived,

on_ship

filter[arriving_today]

boolean

true selects shipments with POD or destination estimated/actual arrival today in the API server day. false does not narrow the list. The SDK accepts only true.

filter[pod_ata_at]

string

Actual POD arrival date. Use YYYY-MM-DD or today/N.days.ago/N.days.from_now; prefix with =, <, <=, >, or >=. Arrays combine bounds with AND. Comma-separated dates mean OR. Use @exists or @not_exists for presence. Compares the stored date component, not timestamp instants; no automatic conversion to the port timezone is applied.

filter[pod_ata_at][]

string[]

Bracketed array form of filter[pod_ata_at]. Actual POD arrival date. Use YYYY-MM-DD or today/N.days.ago/N.days.from_now; prefix with =, <, <=, >, or >=. Arrays combine bounds with AND. Comma-separated dates mean OR. Use @exists or @not_exists for presence. Compares the stored date component, not timestamp instants; no automatic conversion to the port timezone is applied.

Minimum array length: 1

filter[pod_arrival]

string

POD arrival date: actual arrival takes precedence over estimated arrival. Use YYYY-MM-DD or today/N.days.ago/N.days.from_now; prefix with =, <, <=, >, or >=. Arrays combine bounds with AND. Comma-separated dates mean OR. Use @exists or @not_exists for presence. Compares the stored date component, not timestamp instants; no automatic conversion to the port timezone is applied.

filter[pod_arrival][]

string[]

Bracketed array form of filter[pod_arrival]. POD arrival date: actual arrival takes precedence over estimated arrival. Use YYYY-MM-DD or today/N.days.ago/N.days.from_now; prefix with =, <, <=, >, or >=. Arrays combine bounds with AND. Comma-separated dates mean OR. Use @exists or @not_exists for presence. Compares the stored date component, not timestamp instants; no automatic conversion to the port timezone is applied.

Minimum array length: 1

filter[pod_code]

string

Port of discharge UN/LOCODE. Use exact literals, comma-separated values, or arrays with OR semantics. Presence checks and comparison/search operators do not apply to this scope.

filter[pod_code][]

string[]

Bracketed array form of filter[pod_code]. Port of discharge UN/LOCODE. Use exact literals, comma-separated values, or arrays with OR semantics. Presence checks and comparison/search operators do not apply to this scope.

Minimum array length: 1

filter[pod_eta_changed_at]

string

Meaningful change in the POD-local ETA date, comparing the current ETA with its historical baseline. Requires a lower ISO 8601 timestamp bound (=, >, or >=); an optional upper bound must be later. Applies only to active, unarrived shipments with an ETA. Not a raw updated_at filter; a future lower bound is not guaranteed to produce no matches.

filter[pod_eta_changed_at][]

string[]

Bracketed array form of filter[pod_eta_changed_at]. Meaningful change in the POD-local ETA date, comparing the current ETA with its historical baseline. Requires a lower ISO 8601 timestamp bound (=, >, or >=); an optional upper bound must be later. Applies only to active, unarrived shipments with an ETA. Not a raw updated_at filter; a future lower bound is not guaranteed to produce no matches.

Minimum array length: 1

filter[pod_terminal_id]

string

Port of discharge terminal ID. Obtain it from the related terminal resource. Exact match by default; optional =, @exists, or @not_exists. Comma-separated literals mean OR. Arrays mean OR for this shipment terminal filter. ~ is not supported.

filter[pod_terminal_id][]

string[]

Bracketed array form of filter[pod_terminal_id]. Port of discharge terminal ID. Obtain it from the related terminal resource. Exact match by default; optional =, @exists, or @not_exists. Comma-separated literals mean OR. Arrays mean OR for this shipment terminal filter. ~ is not supported.

Minimum array length: 1

filter[pol_code]

string

Port of lading UN/LOCODE. Use exact literals, comma-separated values, or arrays with OR semantics. Presence checks and comparison/search operators do not apply to this scope.

filter[pol_code][]

string[]

Bracketed array form of filter[pol_code]. Port of lading UN/LOCODE. Use exact literals, comma-separated values, or arrays with OR semantics. Presence checks and comparison/search operators do not apply to this scope.

Minimum array length: 1

filter[owner_id]

string

User ID associated with a shipment container. Accepts one ID, comma-separated IDs, or arrays with OR semantics. Use exact literals, comma-separated values, or arrays with OR semantics. Presence checks and comparison/search operators do not apply to this scope.

filter[owner_id][]

string[]

Bracketed array form of filter[owner_id]. User ID associated with a shipment container. Accepts one ID, comma-separated IDs, or arrays with OR semantics. Use exact literals, comma-separated values, or arrays with OR semantics. Presence checks and comparison/search operators do not apply to this scope.

Minimum array length: 1

filter[creator_id]

string

Shipment creator account ID. Comma-separated IDs mean OR; arrays of distinct IDs mean AND and return no matches. Exact match by default; optional =, @exists, or @not_exists. Comma-separated literals mean OR. Arrays mean AND unless the parameter description says otherwise. ~ is not supported.

filter[creator_id][]

string[]

Bracketed array form of filter[creator_id]. Shipment creator account ID. Comma-separated IDs mean OR; arrays of distinct IDs mean AND and return no matches. Exact match by default; optional =, @exists, or @not_exists. Comma-separated literals mean OR. Arrays mean AND unless the parameter description says otherwise. ~ is not supported.

Minimum array length: 1

filter[customer_id]

string

Customer account ID or customer party ID. Falls back to the shipment creator when no customer party role exists. Presence checks refer to the customer party role. Exact match by default; optional =, @exists, or @not_exists. Comma-separated literals mean OR. Arrays mean AND unless the parameter description says otherwise. ~ is not supported.

filter[customer_id][]

string[]

Bracketed array form of filter[customer_id]. Customer account ID or customer party ID. Falls back to the shipment creator when no customer party role exists. Presence checks refer to the customer party role. Exact match by default; optional =, @exists, or @not_exists. Comma-separated literals mean OR. Arrays mean AND unless the parameter description says otherwise. ~ is not supported.

Minimum array length: 1

filter[product]

string

Prefix text search of an associated product name or SKU.

filter[party_id]

string

Party ID match. Accepts a scalar, comma-separated IDs, an array (OR), or an object with value and operator (any or all). Values must come from parties visible to your account.

filter[party_id][value]

string

Party IDs for object-form matching. Supply exact authorized IDs; comma-separated IDs use OR unless operator=all.

filter[party_id][value][]

string<uuid>[]

Repeated party IDs for object-form any/all matching. Requires actual party UUIDs.

Minimum array length: 1

filter[party_id][operator]

enum<string>

Object-form party matching; requires value. any is the default; all requires every party on the same shipment.

Available options:

any,

all

filter[party_id][]

string[]

Bracketed array form of filter[party_id]. Party ID match. Accepts a scalar, comma-separated IDs, an array (OR), or an object with value and operator (any or all). Values must come from parties visible to your account.

filter[tags]

string

Account-scoped shipment tags. Comma-separated names or arrays match ANY tag by default.

filter[tags][]

string[]

Bracketed array form of filter[tags]. Account-scoped shipment tags. Comma-separated names or arrays match ANY tag by default.

filter[tags_and]

boolean

With tags, true requires ALL tags; false or absent means ANY. Has no effect without tags. The SDK requires tags (or shipment tag) when this modifier is supplied.

filter[tag]

string

Alias for tags. When both are present, tag takes precedence. Uses the requesting account tag names.

filter[tag][]

string[]

Bracketed array form of filter[tag]. Alias for tags. When both are present, tag takes precedence. Uses the requesting account tag names.

Response

data

Shipment model · object[]

Show child attributes

included

(Container model · object | Port model · object | Terminal model · object)[]

Represents the equipment during a specific journey.

Container model
Port model
Terminal model

Show child attributes

links

links · object

Show child attributes

Tracking Requests

Shipments

Containers

Documents

Email Submissions

Document Schemas

Document Representations

Search

Webhooks

Webhook Notifications

Custom Field Definitions

Custom Field Options

Custom Fields

Trade Intelligence

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Parties

Party Roles

Authorizations

Query Parameters

Response