MEmentium
v2
tms
v2
tms
loads

Sync Load

Trigger a sync for a single load from the TMS

This endpoint starts a Temporal workflow to sync the load data from the TMS. The workflow runs asynchronously on the Vortex queue.

Path Parameters: - external_reference_id: The load's external reference ID in the TMS

Query Parameters: - integration_connection_id: TMS integration connection ID (required) - integration_name: Integration name like 'SUNNYBROOK', 'TAI' (required)

Returns: SyncLoadResponse with workflow ID and status

post/v2/tms/loads/{external_reference_id}/sync

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

external_reference_idstring required

Query parameters

integration_connection_idstring required
integration_namestring required

Integration name (e.g., 'SUNNYBROOK', 'TAI')

Headers

mentium-workspace-idstring nullable

Response

Successful Response

temporal_workflow_idstring nullable
successboolean required
entity_typestring required
entity_idstring required
errorstring nullable
messagestring required

Changes

No recorded changes to this operation across all 2 revisions of this API.