> ## Documentation Index
> Fetch the complete documentation index at: https://terminal49-mintlify-seo-audit-2026-10-05.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: Terminal49Client

> Terminal49Client class reference for the TypeScript SDK, used to create tracking requests and fetch shipments, containers, and events from Node.js apps.

# 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

| Parameter | Type |
| - | - |
| `config` | [`Terminal49ClientConfig`](/sdk/reference/client/interfaces/Terminal49ClientConfig) |

#### Returns

`Terminal49Client`

## Properties

| Property | Modifier | Type |
| - | - | - |
| <a id="property-containers" /> `containers` | `public` | [`ContainerManager`](/sdk/reference/client/managers/classes/ContainerManager) |
| <a id="property-customfielddefinitions" /> `customFieldDefinitions` | `public` | `object` |
| `customFieldDefinitions.create` | `public` | (`payload`, `options?`) => `Promise`\<`any`> |
| `customFieldDefinitions.delete` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `customFieldDefinitions.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `customFieldDefinitions.list` | `public` | (`options?`) => `Promise`\<`any`> |
| `customFieldDefinitions.update` | `public` | (`id`, `payload`, `options?`) => `Promise`\<`any`> |
| <a id="property-customfieldoptions" /> `customFieldOptions` | `public` | `object` |
| `customFieldOptions.create` | `public` | (`definitionId`, `payload`, `options?`) => `Promise`\<`any`> |
| `customFieldOptions.delete` | `public` | (`definitionId`, `optionId`, `options?`) => `Promise`\<`any`> |
| `customFieldOptions.get` | `public` | (`definitionId`, `optionId`, `options?`) => `Promise`\<`any`> |
| `customFieldOptions.list` | `public` | (`definitionId`, `options?`) => `Promise`\<`any`> |
| `customFieldOptions.update` | `public` | (`definitionId`, `optionId`, `payload`, `options?`) => `Promise`\<`any`> |
| <a id="property-customfields" /> `customFields` | `public` | `object` |
| `customFields.create` | `public` | (`payload`, `options?`) => `Promise`\<`any`> |
| `customFields.delete` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `customFields.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `customFields.list` | `public` | (`options?`) => `Promise`\<`any`> |
| `customFields.update` | `public` | (`id`, `payload`, `options?`) => `Promise`\<`any`> |
| <a id="property-metroareas" /> `metroAreas` | `public` | `object` |
| `metroAreas.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| <a id="property-parties" /> `parties` | `public` | `object` |
| `parties.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `parties.list` | `public` | (`options?`) => `Promise`\<`any`> |
| <a id="property-ports" /> `ports` | `public` | `object` |
| `ports.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| <a id="property-shipments" /> `shipments` | `public` | [`ShipmentManager`](/sdk/reference/client/managers/classes/ShipmentManager) |
| <a id="property-shippinglines" /> `shippingLines` | `public` | [`ShippingLineManager`](/sdk/reference/client/managers/classes/ShippingLineManager) |
| <a id="property-terminals" /> `terminals` | `public` | `object` |
| `terminals.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| <a id="property-trackingrequests" /> `trackingRequests` | `public` | [`TrackingRequestManager`](/sdk/reference/client/managers/classes/TrackingRequestManager) |
| <a id="property-vessels" /> `vessels` | `public` | `object` |
| `vessels.futurePositions` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `vessels.futurePositionsWithCoords` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `vessels.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `vessels.getByImo` | `public` | (`imo`, `options?`) => `Promise`\<`any`> |
| <a id="property-webhooknotifications" /> `webhookNotifications` | `public` | `object` |
| `webhookNotifications.examples` | `public` | (`event?`, `options?`) => `Promise`\<`any`> |
| `webhookNotifications.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `webhookNotifications.list` | `public` | (`options?`) => `Promise`\<`any`> |
| <a id="property-webhooks" /> `webhooks` | `public` | `object` |
| `webhooks.create` | `public` | (`payload`, `options?`) => `Promise`\<`any`> |
| `webhooks.delete` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `webhooks.get` | `public` | (`id`, `options?`) => `Promise`\<`any`> |
| `webhooks.ips` | `public` | (`options?`) => `Promise`\<`any`> |
| `webhooks.list` | `public` | (`options?`) => `Promise`\<`any`> |
| `webhooks.update` | `public` | (`id`, `payload`, `options?`) => `Promise`\<`any`> |

## Methods

### createCustomField()

> **createCustomField**(`payload`, `options?`): `Promise`\<`any`>

Create a custom field assignment.

#### Parameters

| Parameter | Type |
| - | - |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### createCustomFieldDefinition()

> **createCustomFieldDefinition**(`payload`, `options?`): `Promise`\<`any`>

Create a custom field definition.

#### Parameters

| Parameter | Type |
| - | - |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### createCustomFieldOption()

> **createCustomFieldOption**(`definitionId`, `payload`, `options?`): `Promise`\<`any`>

Create a custom field option.

#### Parameters

| Parameter | Type |
| - | - |
| `definitionId` | `string` |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### 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

| Parameter | Type |
| - | - |
| `params` | \{ `autoDetectVoccScac?`: `boolean`; `refNumbers?`: `string`\[]; `requestNumber`: `string`; `requestType`: [`TrackingRequestType`](/sdk/reference/client/managers/type-aliases/TrackingRequestType); `scac?`: `string`; `shipmentTags?`: `string`\[]; } |
| `params.autoDetectVoccScac?` | `boolean` |
| `params.refNumbers?` | `string`\[] |
| `params.requestNumber` | `string` |
| `params.requestType` | [`TrackingRequestType`](/sdk/reference/client/managers/type-aliases/TrackingRequestType) |
| `params.scac?` | `string` |
| `params.shipmentTags?` | `string`\[] |

#### 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

| Parameter | Type |
| - | - |
| `number` | `string` |
| `options` | [`CreateTrackingRequestFromInferOptions`](/sdk/reference/client/managers/interfaces/CreateTrackingRequestFromInferOptions) |

#### Returns

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

***

### createWebhook()

> **createWebhook**(`payload`, `options?`): `Promise`\<`any`>

Create a webhook.

#### Parameters

| Parameter | Type |
| - | - |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### deleteCustomField()

> **deleteCustomField**(`id`, `options?`): `Promise`\<`any`>

Delete a custom field assignment.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### deleteCustomFieldDefinition()

> **deleteCustomFieldDefinition**(`id`, `options?`): `Promise`\<`any`>

Delete a custom field definition.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### deleteCustomFieldOption()

> **deleteCustomFieldOption**(`definitionId`, `optionId`, `options?`): `Promise`\<`any`>

Delete a custom field option.

#### Parameters

| Parameter | Type |
| - | - |
| `definitionId` | `string` |
| `optionId` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### deleteWebhook()

> **deleteWebhook**(`id`, `options?`): `Promise`\<`any`>

Delete a webhook.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`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

| Type Parameter |
| - |
| `T` |

#### Parameters

| Parameter | Type |
| - | - |
| `document` | `unknown` |

#### 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

| Parameter | Type |
| - | - |
| `id` | `string` |
| `include` | [`IncludeParam`](/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ContainerInclude`](/sdk/reference/types/options/type-aliases/ContainerInclude)> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getContainerRawEvents()

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

Fetch raw carrier/terminal events for a container.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getContainerRoute()

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

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

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getContainerTransportEvents()

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

Fetch normalized transport events for a container.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getCustomField()

> **getCustomField**(`id`, `options?`): `Promise`\<`any`>

Fetch a custom field assignment by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getCustomFieldDefinition()

> **getCustomFieldDefinition**(`id`, `options?`): `Promise`\<`any`>

Fetch a custom field definition by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getCustomFieldOption()

> **getCustomFieldOption**(`definitionId`, `optionId`, `options?`): `Promise`\<`any`>

Fetch a custom field option.

#### Parameters

| Parameter | Type |
| - | - |
| `definitionId` | `string` |
| `optionId` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getDemurrage()

> **getDemurrage**(`containerId`): `Promise`\<`any`>

Return a demurrage-focused subset of container fields.

#### Parameters

| Parameter | Type |
| - | - |
| `containerId` | `string` |

#### Returns

`Promise`\<`any`>

***

### getMetroArea()

> **getMetroArea**(`id`, `options?`): `Promise`\<`any`>

Fetch a metro area by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getParty()

> **getParty**(`id`, `options?`): `Promise`\<`any`>

Fetch a party by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getPort()

> **getPort**(`id`, `options?`): `Promise`\<`any`>

Fetch a port by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getRailMilestones()

> **getRailMilestones**(`containerId`): `Promise`\<`any`>

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

#### Parameters

| Parameter | Type |
| - | - |
| `containerId` | `string` |

#### Returns

`Promise`\<`any`>

***

### getShipment()

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

Fetch a shipment by ID, optionally including related containers.

#### Parameters

| Parameter | Type | Default value |
| - | - | - |
| `id` | `string` | `undefined` |
| `includeContainers` | `boolean` | `true` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) & `object` | `undefined` |

#### Returns

`Promise`\<`any`>

***

### getTerminal()

> **getTerminal**(`id`, `options?`): `Promise`\<`any`>

Fetch a terminal by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getTrackingRequest()

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

Fetch a tracking request by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) & `object` |

#### Returns

`Promise`\<`any`>

***

### getVessel()

> **getVessel**(`id`, `options?`): `Promise`\<`any`>

Fetch a vessel by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getVesselByImo()

> **getVesselByImo**(`imo`, `options?`): `Promise`\<`any`>

Fetch a vessel by IMO number.

#### Parameters

| Parameter | Type |
| - | - |
| `imo` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getVesselFuturePositions()

> **getVesselFuturePositions**(`id`, `options?`): `Promise`\<`any`>

Fetch future vessel positions.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getVesselFuturePositionsWithCoords()

> **getVesselFuturePositionsWithCoords**(`id`, `options?`): `Promise`\<`any`>

Fetch future vessel positions with coordinates.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getWebhook()

> **getWebhook**(`id`, `options?`): `Promise`\<`any`>

Fetch a webhook by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getWebhookIps()

> **getWebhookIps**(`options?`): `Promise`\<`any`>

List webhook source IP ranges.

#### Parameters

| Parameter | Type |
| - | - |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getWebhookNotification()

> **getWebhookNotification**(`id`, `options?`): `Promise`\<`any`>

Fetch a webhook notification by ID.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### getWebhookNotificationExamples()

> **getWebhookNotificationExamples**(`event?`, `options?`): `Promise`\<`any`>

Fetch example webhook notification payloads.

#### Parameters

| Parameter | Type |
| - | - |
| `event?` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### inferTrackingNumber()

> **inferTrackingNumber**(`number`): `Promise`\<`any`>

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

#### Parameters

| Parameter | Type |
| - | - |
| `number` | `string` |

#### Returns

`Promise`\<`any`>

***

### listContainers()

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

List containers with optional filters and pagination.

#### Parameters

| Parameter | Type |
| - | - |
| `filters` | \{ `carrier?`: `string`; `include?`: [`IncludeParam`](/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ContainerInclude`](/sdk/reference/types/options/type-aliases/ContainerInclude)>; `port?`: `string`; `status?`: `string`; `updatedAfter?`: `string`; } |
| `filters.carrier?` | `string` |
| `filters.include?` | [`IncludeParam`](/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ContainerInclude`](/sdk/reference/types/options/type-aliases/ContainerInclude)> |
| `filters.port?` | `string` |
| `filters.status?` | `string` |
| `filters.updatedAfter?` | `string` |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listCustomFieldDefinitions()

> **listCustomFieldDefinitions**(`options?`): `Promise`\<`any`>

List custom field definitions.

#### Parameters

| Parameter | Type |
| - | - |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listCustomFieldOptions()

> **listCustomFieldOptions**(`definitionId`, `options?`): `Promise`\<`any`>

List options for a custom field definition.

#### Parameters

| Parameter | Type |
| - | - |
| `definitionId` | `string` |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listCustomFields()

> **listCustomFields**(`options?`): `Promise`\<`any`>

List custom field assignments.

#### Parameters

| Parameter | Type |
| - | - |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listParties()

> **listParties**(`options?`): `Promise`\<`any`>

List parties.

#### Parameters

| Parameter | Type |
| - | - |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listShipments()

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

List shipments with optional filters and pagination.

#### Parameters

| Parameter | Type |
| - | - |
| `filters` | \{ `carrier?`: `string`; `include?`: [`IncludeParam`](/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ShipmentInclude`](/sdk/reference/types/options/type-aliases/ShipmentInclude)>; `includeContainers?`: `boolean`; `port?`: `string`; `status?`: `string`; `updatedAfter?`: `string`; } |
| `filters.carrier?` | `string` |
| `filters.include?` | [`IncludeParam`](/sdk/reference/types/options/type-aliases/IncludeParam)\<[`ShipmentInclude`](/sdk/reference/types/options/type-aliases/ShipmentInclude)> |
| `filters.includeContainers?` | `boolean` |
| `filters.port?` | `string` |
| `filters.status?` | `string` |
| `filters.updatedAfter?` | `string` |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listShippingLines()

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

List supported shipping lines, optionally filtered by search text.

#### Parameters

| Parameter | Type |
| - | - |
| `search?` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### listTrackingRequests()

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

List tracking requests with optional filters and pagination.

#### Parameters

| Parameter | Type |
| - | - |
| `filters` | [`TrackingRequestListFilters`](/sdk/reference/client/managers/interfaces/TrackingRequestListFilters) |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listTrackRequests()

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

Alias for [listTrackingRequests](#listtrackingrequests).

#### Parameters

| Parameter | Type |
| - | - |
| `filters` | [`TrackingRequestListFilters`](/sdk/reference/client/managers/interfaces/TrackingRequestListFilters) |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listWebhookNotifications()

> **listWebhookNotifications**(`options?`): `Promise`\<`any`>

List webhook notifications.

#### Parameters

| Parameter | Type |
| - | - |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### listWebhooks()

> **listWebhooks**(`options?`): `Promise`\<`any`>

List webhooks.

#### Parameters

| Parameter | Type |
| - | - |
| `options?` | [`ListOptions`](/sdk/reference/types/options/interfaces/ListOptions) |

#### Returns

`Promise`\<`any`>

***

### refreshContainer()

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

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

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### resumeTrackingShipment()

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

Resume tracking a previously stopped shipment.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### search()

> **search**(`query`): `Promise`\<`any`>

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

#### Parameters

| Parameter | Type |
| - | - |
| `query` | `string` |

#### Returns

`Promise`\<`any`>

***

### stopTrackingShipment()

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

Stop tracking a shipment and its containers.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### trackContainer()

> **trackContainer**(`params`): `Promise`\<`any`>

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

#### Parameters

| Parameter | Type |
| - | - |
| `params` | \{ `autoDetectVoccScac?`: `boolean`; `bookingNumber?`: `string`; `containerNumber?`: `string`; `refNumbers?`: `string`\[]; `scac?`: `string`; } |
| `params.autoDetectVoccScac?` | `boolean` |
| `params.bookingNumber?` | `string` |
| `params.containerNumber?` | `string` |
| `params.refNumbers?` | `string`\[] |
| `params.scac?` | `string` |

#### Returns

`Promise`\<`any`>

***

### updateCustomField()

> **updateCustomField**(`id`, `payload`, `options?`): `Promise`\<`any`>

Update a custom field assignment.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### updateCustomFieldDefinition()

> **updateCustomFieldDefinition**(`id`, `payload`, `options?`): `Promise`\<`any`>

Update a custom field definition.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### updateCustomFieldOption()

> **updateCustomFieldOption**(`definitionId`, `optionId`, `payload`, `options?`): `Promise`\<`any`>

Update a custom field option.

#### Parameters

| Parameter | Type |
| - | - |
| `definitionId` | `string` |
| `optionId` | `string` |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### updateShipment()

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

Update shipment attributes such as reference numbers or tags.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `attrs` | `Record`\<`string`, `any`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### updateTrackingRequest()

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

Update tracking request attributes.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `attrs` | `Record`\<`string`, `any`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>

***

### updateWebhook()

> **updateWebhook**(`id`, `payload`, `options?`): `Promise`\<`any`>

Update a webhook.

#### Parameters

| Parameter | Type |
| - | - |
| `id` | `string` |
| `payload` | `Record`\<`string`, `unknown`> |
| `options?` | [`CallOptions`](/sdk/reference/types/options/interfaces/CallOptions) |

#### Returns

`Promise`\<`any`>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.