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
createCustomField()
createCustomField(Create a custom field assignment.payload,options?):Promise<any>
Parameters
Returns
Promise<any>
createCustomFieldDefinition()
createCustomFieldDefinition(Create a custom field definition for your account. Setpayload,options?):Promise<any>
data.attributes.template_id to copy a Terminal49 template.
Parameters
Returns
Promise<any>
createCustomFieldOption()
createCustomFieldOption(Create a custom field option.definitionId,payload,options?):Promise<any>
Parameters
Returns
Promise<any>
createParty()
createParty(Create a party.attributes,options?):Promise<any>
Parameters
Returns
Promise<any>
createTrackingRequest()
createTrackingRequest(Create a tracking request with an explicit number type and carrier SCAC, or ask the API to auto-detect the carrier SCAC.params):Promise<any>
Parameters
Returns
Promise<any>
createTrackingRequestFromInfer()
createTrackingRequestFromInfer(Infer carrier/number type, then create a tracking request from the result.number,options?):Promise<{infer:any;trackingRequest:any; }>
Parameters
Returns
Promise<{ infer: any; trackingRequest: any; }>
createWebhook()
createWebhook(Create a webhook.payload,options?):Promise<any>
Parameters
Returns
Promise<any>
deleteCustomField()
deleteCustomField(Delete a custom field assignment.id,options?):Promise<any>
Parameters
Returns
Promise<any>
deleteCustomFieldDefinition()
deleteCustomFieldDefinition(Delete a custom field definition.id,options?):Promise<any>
Parameters
Returns
Promise<any>
deleteCustomFieldOption()
deleteCustomFieldOption(Delete a custom field option.definitionId,optionId,options?):Promise<any>
Parameters
Returns
Promise<any>
deleteWebhook()
deleteWebhook(Delete a webhook.id,options?):Promise<any>
Parameters
Returns
Promise<any>
deserialize()
deserialize<Deserialize a JSON:API document into plain objects. Useful when you want a simplified shape instead of JSON:API.T>(document):T
Type Parameters
Parameters
Returns
T
Remarks
The cast is unchecked at runtime — the caller is responsible for verifying the returned shape matchesT.
getContainer()
getContainer(Fetch a container by ID with optional included relationships.id,include?,options?):Promise<any>
Parameters
Returns
Promise<any>
getContainerRawEvents()
getContainerRawEvents(Fetch raw carrier/terminal events for a container.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getContainerRoute()
getContainerRoute(Fetch a container’s route (ports, current vessel, tracks). Requires the Routing Data feature.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getContainerTransportEvents()
getContainerTransportEvents(Fetch normalized transport events for a container.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getCustomField()
getCustomField(Fetch a custom field assignment by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getCustomFieldDefinition()
getCustomFieldDefinition(Fetch a custom field definition by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getCustomFieldOption()
getCustomFieldOption(Fetch a custom field option.definitionId,optionId,options?):Promise<any>
Parameters
Returns
Promise<any>
getDemurrage()
getDemurrage(Return a demurrage-focused subset of container fields.containerId):Promise<any>
Parameters
Returns
Promise<any>
getMetroArea()
getMetroArea(Fetch a metro area by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getParty()
getParty(Fetch a party by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getPort()
getPort(Fetch a port by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getRailMilestones()
getRailMilestones(Return rail milestone fields and rail transport events for a container.containerId):Promise<any>
Parameters
Returns
Promise<any>
getShipment()
getShipment(Fetch a shipment by ID, optionally including related containers.id,includeContainers?,options?):Promise<any>
Parameters
Returns
Promise<any>
getTerminal()
getTerminal(Fetch a terminal by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getTrackingRequest()
getTrackingRequest(Fetch a tracking request by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getVessel()
getVessel(Fetch a vessel by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getVesselByImo()
getVesselByImo(Fetch a vessel by IMO number.imo,options?):Promise<any>
Parameters
Returns
Promise<any>
getVesselFuturePositions()
getVesselFuturePositions(Fetch a vessel’s estimated positions between two ports. Requires the Routing Data feature.id,params,options?):Promise<any>
Parameters
Returns
Promise<any>
getVesselFuturePositionsWithCoords()
getVesselFuturePositionsWithCoords(Fetch a vessel’s estimated positions from a starting coordinate. Requires the Routing Data feature.id,params,options?):Promise<any>
Parameters
Returns
Promise<any>
getWebhook()
getWebhook(Fetch a webhook by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getWebhookIps()
getWebhookIps(List webhook source IP ranges.options?):Promise<any>
Parameters
Returns
Promise<any>
getWebhookNotification()
getWebhookNotification(Fetch a webhook notification by ID.id,options?):Promise<any>
Parameters
Returns
Promise<any>
getWebhookNotificationExamples()
getWebhookNotificationExamples(Fetch the example webhook notification payload forevent,options?):Promise<any>
event. The API answers 400 without one.
Parameters
Returns
Promise<any>
inferTrackingNumber()
inferTrackingNumber(Infer a tracking number’s type and likely carrier candidates.number):Promise<any>
Parameters
Returns
Promise<any>
listContainers()
listContainers(List containers with optional filters and pagination.filters?,options?):Promise<any>
Parameters
Returns
Promise<any>
listCustomFieldDefinitions()
listCustomFieldDefinitions(List your account’s custom field definitions, or the Terminal49 templates. The API does not paginate this list.options?):Promise<any>
Parameters
Returns
Promise<any>
listCustomFieldOptions()
listCustomFieldOptions(List every option of a custom field definition. The API does not paginate this list.definitionId,options?):Promise<any>
Parameters
Returns
Promise<any>
listCustomFields()
listCustomFields(List custom field assignments. The API does not paginate this list.options?):Promise<any>
Parameters
Returns
Promise<any>
listParties()
listParties(List parties.options?):Promise<any>
Parameters
Returns
Promise<any>
listShipments()
listShipments(List shipments with optional filters and pagination.filters?,options?):Promise<any>
Parameters
Returns
Promise<any>
listShippingLines()
listShippingLines(List supported shipping lines, optionally filtered by search text.search?,options?):Promise<any>
Parameters
Returns
Promise<any>
listTrackingRequests()
listTrackingRequests(List tracking requests with optional filters and pagination.filters?,options?):Promise<any>
Parameters
Returns
Promise<any>
listTrackRequests()
listTrackRequests(Alias for listTrackingRequests.filters?,options?):Promise<any>
Parameters
Returns
Promise<any>
listWebhookEvents()
listWebhookEvents(List the event names a webhook can subscribe to.options?):Promise<any>
Parameters
Returns
Promise<any>
listWebhookNotifications()
listWebhookNotifications(List webhook notifications.options?):Promise<any>
Parameters
Returns
Promise<any>
listWebhooks()
listWebhooks(List webhooks.options?):Promise<any>
Parameters
Returns
Promise<any>
me()
me(Describe the credential behind this client: API key or signed-in user, the account it is scoped to, and which gated features it can use there. Works for free-plan API keys too.options?):Promise<any>
Parameters
Returns
Promise<any>
refreshContainer()
refreshContainer(Request an immediate refresh for a container. This may require a paid Terminal49 feature.id,options?):Promise<any>
Parameters
Returns
Promise<any>
resumeTrackingShipment()
resumeTrackingShipment(Resume tracking a previously stopped shipment.id,options?):Promise<any>
Parameters
Returns
Promise<any>
search()
search(Search across shipments and containers by number, reference, or keyword.query):Promise<any>
Parameters
Returns
Promise<any>
stopTrackingShipment()
stopTrackingShipment(Stop tracking a shipment and its containers.id,options?):Promise<any>
Parameters
Returns
Promise<any>
trackContainer()
trackContainer(Convenience helper for creating a tracking request from a container, booking, or bill of lading number.params):Promise<any>
Parameters
Returns
Promise<any>
triggerWebhook()
triggerWebhook(Send a test webhook delivery with an example payload to a URL.params,options?):Promise<any>
Parameters
Returns
Promise<any>
updateCustomField()
updateCustomField(Update a custom field assignment.id,payload,options?):Promise<any>
Parameters
Returns
Promise<any>
updateCustomFieldDefinition()
updateCustomFieldDefinition(Update a custom field definition.id,payload,options?):Promise<any>
Parameters
Returns
Promise<any>
updateCustomFieldOption()
updateCustomFieldOption(Update a custom field option.definitionId,optionId,payload,options?):Promise<any>
Parameters
Returns
Promise<any>
updateParty()
updateParty(Update a party.id,attributes,options?):Promise<any>
Parameters
Returns
Promise<any>
updateShipment()
updateShipment(Update shipment attributes such as reference numbers or tags.id,attrs,options?):Promise<any>
Parameters
Returns
Promise<any>
updateTrackingRequest()
updateTrackingRequest(Update tracking request attributes.id,attrs,options?):Promise<any>
Parameters
Returns
Promise<any>
updateWebhook()
updateWebhook(Update a webhook.id,payload,options?):Promise<any>
Parameters
Returns
Promise<any>