​

Class: ContainerManager

​

Extends

• BaseManager

​

Constructors

​

Constructor

new ContainerManager(transport, defaultFormat?): ContainerManager

​

Parameters

​

Returns

ContainerManager

​

Inherited from

BaseManager.constructor

​

Methods

​

addPartyRole()

addPartyRole(id, __namedParameters, options?): Promise<any>

Assign a party to a container in the given role.

​

Parameters

​

Returns

Promise<any>

---

​

customFields()

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

​

Parameters

​

Returns

Promise<any>

---

​

deleteCustomField()

deleteCustomField(id, apiSlug, options?): Promise<any>

Remove a custom field value from a container.

​

Parameters

​

Returns

Promise<any>

---

​

demurrage()

demurrage(id): Promise<any>

​

Parameters

​

Returns

Promise<any>

---

​

events()

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

​

Parameters

​

Returns

Promise<any>

---

​

get()

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

​

Parameters

​

Returns

Promise<any>

---

​

iterate()

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

​

Parameters

​

Returns

AsyncGenerator<Container, void, unknown>

---

​

list()

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

​

Parameters

​

Returns

Promise<any>

---

​

map()

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

​

Parameters

​

Returns

Promise<any>

​

Deprecated

Use ContainerManager.route. Returns the GeoJSON FeatureCollection unmapped: raw and mapped return it as is, and both returns { raw, mapped } with the FeatureCollection in each half.

---

​

partyRoles()

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

List the party roles assigned to a container.

​

Parameters

​

Returns

Promise<any>

---

​

rawEvents()

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

​

Parameters

​

Returns

Promise<any>

---

​

refresh()

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

​

Parameters

​

Returns

Promise<any>

---

​

removePartyRole()

removePartyRole(id, partyRoleId, options?): Promise<any>

Remove a party role assignment from a container.

​

Parameters

​

Returns

Promise<any>

---

​

route()

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

Fetch the container’s route: ports, the current vessel, and vessel tracks. The raw format is the GeoJSON FeatureCollection; the mapped format is a ContainerRoute. Requires the Routing Data feature, otherwise the API returns 403.

​

Parameters

​

Returns

Promise<any>

---

​

setCustomField()

setCustomField(id, apiSlug, value, options?): Promise<any>

Create a custom field value on a container.

​

Parameters

​

Returns

Promise<any>

---

​

summary()

summary(groupBy, filters?, options?): Promise<any>

Count the containers list would return for the same filters, grouped by one dimension, in one request (GET /containers/summary).

​

Parameters

​

Returns

Promise<any>

---

​

update()

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

Update a container’s ref_numbers, seal_number, equipment type, length, and height, or weight_in_lbs.

​

Parameters

​

Returns

Promise<any>

---

​

updateCustomField()

updateCustomField(id, apiSlug, value, options?): Promise<any>

Update an existing custom field value on a container.

​

Parameters

​

Returns

Promise<any>