Class: ShipmentManager

ShipmentManager class in the Terminal49 TypeScript SDK, used to list shipments, fetch a shipment by ID, and include related containers, ports, and terminals.

Class: ShipmentManager

Extends

• BaseManager

Constructors

Constructor

new ShipmentManager(transport, defaultFormat?): ShipmentManager

Parameters

Parameter	Type	Default value
transport	Transport	undefined
defaultFormat	ResponseFormat	'raw'

Returns

ShipmentManager

Inherited from

BaseManager.constructor

Methods

get()

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

Parameters

Parameter	Type	Default value
id	string	undefined
includeContainers	boolean	true
options?	CallOptions & object	undefined

Returns

Promise<any>

---

iterate()

iterate(filters?, options?): AsyncGenerator<Shipment, void, unknown>

Parameters

Parameter	Type
filters	{ carrier?: string; include?: IncludeParam<ShipmentInclude>; includeContainers?: boolean; number?: string; port?: string; status?: string; trackingStopped?: boolean; updatedAfter?: string; } | undefined
options?	Omit<ListOptions, "page">

Returns

AsyncGenerator<Shipment, void, unknown>

---

list()

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

List shipments. Filters the v2 API does not support (status, port, carrier, updatedAfter) are omitted from the request and reported back via unsupportedFilters. That field is only surfaced when options.format is 'mapped' or 'both'; the default 'raw' format returns the verbatim API response and does not carry it.

Parameters

Parameter	Type	Description
filters	{ carrier?: string; include?: IncludeParam<ShipmentInclude>; includeContainers?: boolean; number?: string; port?: string; status?: string; trackingStopped?: boolean; updatedAfter?: string; }	-
filters.carrier?	string	-
filters.include?	IncludeParam<ShipmentInclude>	-
filters.includeContainers?	boolean	-
filters.number?	string	Search shipments by the original tracking request_number.
filters.port?	string	-
filters.status?	string	-
filters.trackingStopped?	boolean	Filter shipments by whether they are still tracking. Maps to the supported filter[tracking_stopped].
filters.updatedAfter?	string	-
options?	ListOptions	-

Returns

Promise<any>

---

resumeTracking()

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

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

stopTracking()

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

Parameters

Parameter	Type
id	string
options?	CallOptions

Returns

Promise<any>

---

update()

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

Parameters

Parameter	Type
id	string
attrs	Record<string, any>
options?	CallOptions

Returns

Promise<any>