Contact

Schedule Demo

Blog

Terminal 49

API Docs

DataSync

Sign in

Start your free trial

Learn how to edit container details through Terminal49's API. Update container info efficiently and integrate changes into your shipping workflows.

Edit a Container | Terminal49 API Documentation

Edit a container

Represents the equipment during a specific journey.

Whether Terminal 49 is receiving availability status from the terminal.

If availability_known is true, then whether container is available to be picked up at terminal.

IANA tz. Applies to attribute empty_terminated_at.

Pickup time at final destination for inland moves.

IANA tz. Applies to attribute final_destination_full_out_at.

The SCAC of the rail carrier for the delivery leg of the container's journey.(BETA)

When available the pickup appointment time at the terminal is returned.

The last free day for pickup before demmurage accrues. Corresponding timezone is pod_timezone.

Full Out time at port of discharge. Null for inland moves.

The chassis number used when container was picked up at POD (if available)

The SCAC of the rail carrier for the pickup leg of the container's journey.(BETA)

IANA tz. Applies to attributes pod_arrived_at, pod_discharged_at, pickup_appointment_at, pod_full_out_at.

Container model

The ISO 4217 currency code of the fee is charged in. E.g. USD

terminal_fee

Text description from the terminal (if any)

terminal_hold

authorization

Learn about Terminal49's home features and API documentation for container and shipment tracking.

Terminal49 Home | API Documentation

Terminal49 Dev Documentation

1. Start Here

Submitting a tracking request is how you tell Terminal49 to track a shipment for you.

Track shipments and containers with ease via Terminal49's API. Optimize your shipping processes with seamless tracking.

Tracking Shipments and Containers | Terminal49 API

2. Tracking Shipments & Containers

3. List Your Shipments & Containers

Get real-time status updates on shipments using Terminal49's API. Ensure timely deliveries with accurate tracking data.

Receive Status Updates | Terminal49 API Documentation

4. How to Receive Status Updates

Get started quickly with Terminal49's API using this comprehensive guide. Simplify your shipping workflows today.

Quickstart Guide | Terminal49 API Documentation

Quick Start Guide

Webhooks

Including Resources

Tracking Request Lifecycle

Learn how event timestamps are captured and processed through Terminal49's API for improved shipment visibility.

Event Timestamps Guide | Terminal49 API Documentation

Event Timestamps

The Terminal49 Map allows you to embed real-time visualized container tracking on your website with just a few lines of code.

Terminal49 Map Embed Guide

The Terminal49 Track & Trace Widget allows you to embed real-time container tracking on your website with just a few lines of code. This widget provides a seamless user experience and helps improve customer satisfaction.

Tracking Widget Embed Guide

This guide provides a comprehensive, step-by-step approach for integrating North American Class-1 rail container tracking data into your systems. Whether you are a shipper or a logistics service provider, this guide will help you track all your rail containers via a single API.

Integrate rail data seamlessly with Terminal49's API for accurate and real-time tracking of rail shipments.

Rail Integration Guide | Terminal49 API Documentation

Integrate Rail Container Tracking Data

Our platform gets data from variety of sources in order to create a complete view of a shipment and containers. However,some data is not universally available from all sources, and some data does not become available until certain milestones pass. This page will help you understand which data sources we support, and which data items should be universally expected by your code and which you need to code more defensively around.

Access availability of API data sources to enhance shipping logistics with Terminal49's comprehensive tools.

API Data Sources Availability | Terminal49 API

API Data Sources and Availability.

Review Terminal49's pricing information for API access. Plan your logistics with transparent cost structures.

Pricing Information | Terminal49 API Documentation

Pricing

Access test numbers for your API integrations with Terminal49 for accurate tracking simulations.

Test Numbers for API | Terminal49 API Documentation

Test Numbers

Retry tracking requests through Terminal49's API for uninterrupted shipment monitoring.

Tracking Request Retrying | Terminal49 API Documentation

Tracking Request Retrying

Get examples of webhook events using Terminal49's API to enhance your tracking and notification systems.

Webhook Event Examples | Terminal49 API Documentation

Webhook Events Examples

Discover the Datasync feature from Terminal49. Streamline shipment data management effortlessly.

Datasync Home | Terminal49 API Documentation

Get an overview of the Datasync feature in Terminal49's API to streamline container tracking.

Datasync Overview | Terminal49 API Documentation

Overview

Explore supported data destinations using Terminal49's API to sync container data efficiently.

Supported Destinations | Terminal49 API Documentation

Supported Destinations

Get information on rail container table properties via Terminal49's Datasync API.

Rail Container Table Properties | Terminal49 Datasync

Containers

Retrieve shipment table properties with the Datasync feature from Terminal49 for detailed tracking.

Shipment Table Properties | Terminal49 Datasync

Shipments

View tracking request table properties with Terminal49's Datasync to manage shipment tracking.

Tracking Request Table Properties | Terminal49 Datasync

Tracking Requests

Access transfer status table properties for seamless data synchronization using Terminal49.

Transfer Status Table Properties | Terminal49 Datasync

Transfer Status

Access detailed container table properties through Terminal49's Datasync API.

Container Table Properties | Terminal49 Datasync

Containers (deprecated)

Returns a list of your shipments. The shipments are returned sorted by creation date, with the most recent shipments appearing first.

This api will return all shipments associated with the account. Shipments created via the `tracking_request` API aswell as the ones added via the dashboard will be retuned via this endpoint. 

List all shipment details using Terminal49's API. Improve operational efficiency with organized shipment overviews.

List Shipments | Terminal49 API Documentation

List shipments

Retrieves the details of an existing shipment. You need only supply the unique shipment `id` that was returned upon `tracking_request` creation.

Retrieve shipment details quickly with Terminal49's API. Enhance your shipping visibility and streamline tracking processes.

Get a Shipment | Terminal49 API Documentation

Get a shipment

Modify shipment information quickly and accurately using Terminal49's API to ensure up-to-date logistics and tracking data.

Edit a Shipment | Terminal49 API Documentation

Edit a shipment

We'll stop tracking the shipment, which means that there will be no more updates.  You can still access the shipment's previously-collected information via the API or dashboard.

You can resume tracking a shipment by calling the `resume_tracking` endpoint, but keep in mind that some information is only made available by our data sources at specific times, so a stopped and resumed shipment may have some information missing.

Stop shipment tracking anytime via Terminal49's API. Manage tracking effortlessly when deliveries are complete.

Stop Shipment Tracking | Terminal49 API Documentation

Stop tracking a shipment

Resume tracking a shipment.  Keep in mind that some information is only made available by our data sources at specific times, so a stopped and resumed shipment may have some information missing.

Resume tracking for shipments using Terminal49's API. Keep tabs on crucial shipments with automated updates.

Resume Shipment Tracking | Terminal49 API Documentation

Resume tracking a shipment

Returns a list of your tracking requests. The tracking requests are returned sorted by creation date, with the most recent tracking request appearing first.

List tracking requests

To track an ocean shipment, you create a new tracking request. 
Two attributes are required to track a shipment. A `bill of lading/booking number` and a shipping line `SCAC`. 

Once a tracking request is created we will attempt to fetch the shipment details and it's related containers from the shipping line. If the attempt is successful we will create in new shipment object including any related container objects. We will send a `tracking_request.succeeded` webhook notification to your webhooks.  

If the attempt to fetch fails then we will send a `tracking_request.failed` webhook notification to your `webhooks`.  

A `tracking_request.succeeded` or `tracking_request.failed` webhook notificaiton will only be sent  if you have  atleast one active webhook. 

Create tracking requests via Terminal49's API for accurate shipment tracking and notifications.

Create a Tracking Request | Terminal49 API Documentation

Create a tracking request

Get the details and status of an existing tracking request. 

Get a single tracking request

Edit a tracking request

Retrieve a single webhook using Terminal49's API for detailed event tracking.

Get Single Webhook | Terminal49 API Documentation

Get single webhook

Delete a webhook

Modify webhook settings with Terminal49's API. Ensure accurate notifications for container tracking.

Edit a Webhook | Terminal49 API Documentation

Edit a webhook

View all webhooks associated with your account using Terminal49's API for real-time event tracking.

List Webhooks | Terminal49 API Documentation

List webhooks

You can configure a webhook via the API to be notified about events that happen in your Terminal49 account. These events can be realted to tracking_requests, shipments and containers. 

This is the recommended way tracking shipments and containers via the API. You should use this instead of polling our the API periodically.  

Create a webhook

Return the list of IPs used for sending webhook notifications.  This can be useful for whitelisting the IPs on the firewall.

List webhook IPs using Terminal49's API for improved network security and configuration.

List Webhook IPs | Terminal49 API Documentation

List webhook IPs

Get a single webhook notification

Return the list of  webhook notifications. This can be useful for reconciling your data if your endpoint has been down. 

List webhook notifications

Returns an example payload as it would be sent to a webhook endpoint for the provided `event` 

Get webhook notification payload examples

Returns a list of container. The containers are returned sorted by creation date, with the most recently refreshed containers appearing first.

This API will return all containers associated with the account.

Use Terminal49's API to list all containers associated with your account. Stay organized with a clear overview of all shipments.

List Containers | Terminal49 API Documentation

List containers

Retrieve comprehensive container information using Terminal49's API to streamline logistics management and enhance data accuracy.

Get a Container | Terminal49 API Documentation

Get a container

#### Deprecation warning
The `raw_events` endpoint is provided as-is.

 For past events we recommend consuming `transport_events`.

---
Get a list of past and future (estimated) milestones for a container as reported by the carrier. Some of the data is normalized even though the API is called raw_events. 

Normalized attributes: `event` and `timestamp` timestamp. Not all of the `event` values have been normalized. You can expect the the events related to container movements to be normalized but there are cases where events are not normalized. 

For past historical events we recommend consuming `transport_events`. Although there are fewer events here those events go through additional vetting and normalization to avoid false positives and get you correct data.

Access raw event data for containers via Terminal49's API to track shipment progress and optimize your supply chain.

Access Raw Container Events | Terminal49 API Documentation

Get a container's raw events

Get a list of past transport events (canonical) for a container. All data has been normalized across all carriers. These are a verified subset of the raw events may also be sent as Webhook Notifications to a webhook endpoint.

This does not provide any estimated future events. See `container/:id/raw_events` endpoint for that.  

Fetch detailed transport event data for containers, providing real-time updates on shipment status through Terminal49's API.

Retrieve Transport Events | Terminal49 API Documentation

Get a container's transport events

Return a list of shipping lines supported by Terminal49. 
N.B. There is no pagination for this endpoint.

Get an overview of all shipping lines using Terminal49's API. Streamline logistics with detailed shipping line data.

Shipping Lines Overview | Terminal49 API Documentation

Shipping Lines

Return the details of a single shipping line.

Retrieve information about shipping lines with Terminal49's API. Stay updated with accurate shipping line details.

Get a Shipping Line | Terminal49 API Documentation

Get a single shipping line

Return the details of a single metro area.

Retrieve detailed metro area information using the UNLOCODE or ID, enhancing geographic data management with Terminal49's API.

Get Metro Area by UNLOCODE or ID | Terminal49 API

Get a metro area using the un/locode or the id

Retrieve port data via LOCODE or ID, streamlining port-related operations and integrating key location data with Terminal49's API.

Access Port Details by LOCODE or ID | Terminal49 API

Get a port using the locode or the id

Returns a vessel by it's given identifier

Get a vessel using the id

Returns a vessel by the given IMO number.

Get a vessel using the imo

Retrieve terminal information using Terminal49's API. Access up-to-date terminal details by ID quickly.

Getting Started

In Depth Guides

Useful Info

Shipments

Tracking Requests

Tracking requests

Webhooks

Webhook Notifications

Containers

Shipping Lines

Metro Areas

Ports

Vessels

Terminals

Edit a container

Authorizations

Body

Response