​

Class: Terminal49Client

Server-side TypeScript client for the Terminal49 JSON:API. Use this client to create tracking requests, list and fetch shipments and containers, retrieve transport events, and work with core Terminal49 tracking data from Node.js applications.

​

Constructors

​

Constructor

new Terminal49Client(config): Terminal49Client

​

Parameters

​

Returns

Terminal49Client

​

Properties

​

Methods

​

createTrackingRequest()

createTrackingRequest(params): Promise<any>

Create a tracking request with an explicit number type and carrier SCAC, or ask the API to auto-detect the carrier SCAC.

​

Parameters

​

Returns

Promise<any>

---

​

createTrackingRequestFromInfer()

createTrackingRequestFromInfer(number, options?): Promise<{ infer: any; trackingRequest: any; }>

Infer carrier/number type, then create a tracking request from the result.

​

Parameters

​

Returns

Promise<{ infer: any; trackingRequest: any; }>

---

​

deserialize()

deserialize<T>(document): T

Deserialize a JSON:API document into plain objects. Useful when you want a simplified shape instead of JSON:API.

​

Type Parameters

​

Parameters

​

Returns

T

​

Remarks

The cast is unchecked at runtime — the caller is responsible for verifying the returned shape matches T.

---

​

getContainer()

getContainer(id, include?, options?): Promise<any>

Fetch a container by ID with optional included relationships.

​

Parameters

​

Returns

Promise<any>

---

​

getContainerRawEvents()

getContainerRawEvents(id, options?): Promise<any>

Fetch raw carrier/terminal events for a container.

​

Parameters

​

Returns

Promise<any>

---

​

getContainerRoute()

getContainerRoute(id, options?): Promise<any>

Fetch routing details for a container. This may require a paid Terminal49 feature.

​

Parameters

​

Returns

Promise<any>

---

​

getContainerTransportEvents()

getContainerTransportEvents(id, options?): Promise<any>

Fetch normalized transport events for a container.

​

Parameters

​

Returns

Promise<any>

---

​

getDemurrage()

getDemurrage(containerId): Promise<any>

Return a demurrage-focused subset of container fields.

​

Parameters

​

Returns

Promise<any>

---

​

getRailMilestones()

getRailMilestones(containerId): Promise<any>

Return rail milestone fields and rail transport events for a container.

​

Parameters

​

Returns

Promise<any>

---

​

getShipment()

getShipment(id, includeContainers?, options?): Promise<any>

Fetch a shipment by ID, optionally including related containers.

​

Parameters

​

Returns

Promise<any>

---

​

getTrackingRequest()

getTrackingRequest(id, options?): Promise<any>

Fetch a tracking request by ID.

​

Parameters

​

Returns

Promise<any>

---

​

inferTrackingNumber()

inferTrackingNumber(number): Promise<any>

Infer a tracking number’s type and likely carrier candidates.

​

Parameters

​

Returns

Promise<any>

---

​

listContainers()

listContainers(filters?, options?): Promise<any>

List containers with optional filters and pagination.

​

Parameters

​

Returns

Promise<any>

---

​

listShipments()

listShipments(filters?, options?): Promise<any>

List shipments with optional filters and pagination.

​

Parameters

​

Returns

Promise<any>

---

​

listShippingLines()

listShippingLines(search?, options?): Promise<any>

List supported shipping lines, optionally filtered by search text.

​

Parameters

​

Returns

Promise<any>

---

​

listTrackingRequests()

listTrackingRequests(filters?, options?): Promise<any>

List tracking requests with optional filters and pagination.

​

Parameters

​

Returns

Promise<any>

---

​

listTrackRequests()

listTrackRequests(filters?, options?): Promise<any>

Alias for listTrackingRequests.

​

Parameters

​

Returns

Promise<any>

---

​

refreshContainer()

refreshContainer(id, options?): Promise<any>

Request an immediate refresh for a container. This may require a paid Terminal49 feature.

​

Parameters

​

Returns

Promise<any>

---

​

resumeTrackingShipment()

resumeTrackingShipment(id, options?): Promise<any>

Resume tracking a previously stopped shipment.

​

Parameters

​

Returns

Promise<any>

---

​

search()

search(query): Promise<any>

Search across shipments and containers by number, reference, or keyword.

​

Parameters

​

Returns

Promise<any>

---

​

stopTrackingShipment()

stopTrackingShipment(id, options?): Promise<any>

Stop tracking a shipment and its containers.

​

Parameters

​

Returns

Promise<any>

---

​

trackContainer()

trackContainer(params): Promise<any>

Convenience helper for creating a tracking request from a container or booking number.

​

Parameters

​

Returns

Promise<any>

---

​

updateShipment()

updateShipment(id, attrs, options?): Promise<any>

Update shipment attributes such as reference numbers or tags.

​

Parameters

​

Returns

Promise<any>

---

​

updateTrackingRequest()

updateTrackingRequest(id, attrs, options?): Promise<any>

Update tracking request attributes.

​

Parameters

​

Returns

Promise<any>