​

Class: ShipmentManager

​

Extends

• BaseManager

​

Constructors

​

Constructor

new ShipmentManager(transport, defaultFormat?): ShipmentManager

​

Parameters

​

Returns

ShipmentManager

​

Inherited from

BaseManager.constructor

​

Methods

​

get()

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

​

Parameters

​

Returns

Promise<any>

---

​

iterate()

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

​

Parameters

​

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

​

Returns

Promise<any>

---

​

resumeTracking()

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

​

Parameters

​

Returns

Promise<any>

---

​

stopTracking()

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

​

Parameters

​

Returns

Promise<any>

---

​

update()

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

​

Parameters

​

Returns

Promise<any>