WWO

• Action: The action to execute (such as GENERAL, GETVOYAGE, GETCARGO).

• Url: The primary API endpoint URL.

• Username: Username sent in the HTTP request header for API authentication.

• Password: Password sent in the HTTP request header for API authentication.

• Key: Ocp-Apim-Subscription-Key header value for API gateway authentication.

• oAuthEndpoint: OAuth 2.0 token endpoint URL (e.g. Azure AD).

• oAuthScope: OAuth 2.0 scope for the token request.

• oAuthClientID: OAuth 2.0 client ID.

• oAuthClientSecret: OAuth 2.0 client secret.

• RateLimitPerMinute: Maximum number of API requests allowed per minute. Execution pauses when the limit is reached.

What it does

Performs a generic GET request to the configured URL, converts the JSON response to XML, and saves it as a single inbound message.

Settings

Action: GENERAL

What it does

Retrieves the full voyage table from the API, filters voyages by port code (from the transport's Configuration Params) and by ETA/ETD within the configured number of days (DaysVoyagesToCheck). Creates one message per port code.

Settings

Action: GETVOYAGE

DaysVoyagesToCheck: Number of days in the past to include voyages by ETA/ETD. Defaults to 30.

Timeout: HTTP request timeout in milliseconds (overrides the default 12000 milliseconds).

What it does

Retrieves cargo details for each valid voyage. Supports IMPORT, EXPORT, or BOTH operation types. Optionally filters cargo by LastActivityDate within HoursCargoToCheck hours. Creates one message per voyage, grouped and sorted by booking number, bill of lading, equipment, and connected equipment.

Settings

Action: GETCARGO

PortCode: [Required] The port code used when building cargo requests (e.g. AUFRE).

VoyagesAPIUrl: [Required] Separate API endpoint used to retrieve valid voyages when fetching cargo.

OperationType: BOTH (default), EXPORT, or IMPORT. Controls which cargo operation types are fetched.

DaysVoyagesToCheck: Number of days in the past to include voyages by ETA/ETD. Defaults to 30.

HoursCargoToCheck: Number of hours to look back for LastActivityDate filtering. If omitted, no date restriction is applied.

Timeout: HTTP request timeout in milliseconds (overrides the default 12000 milliseconds).

Update Cargo Priority

• UPDATEPRIORITY or UPDATECARGOPRIORITY

• Updates cargo priority. Posts bookingNo, cargoId, portCode, and priority fields.

Update Cargo Status

• UPDATECARGOSTATUS

• Updates cargo status. Posts bookingNo, cargoId, portCode, and status fields.

Update Cargo Equipment

• UPDATECARGOEQUIPMENT

• Updates cargo equipment details. Posts cargoId, cargoSeqNo, portId, equipmentNumber, operType, voyageNumber, barcode, connectedEquipmentNumber, length, height, width, weight, pol, pod, commodityCode, and commodityDesc fields.

Update Cargo Status And Priority

• UPDATECARGOSTATUSANDPRIORITY

• Calls both UpdateCargoStatus and UpdateCargoPriority in sequence. The Url setting must contain two semicolon-separated endpoints (status URL;priority URL).

Update Cargo Status And Equipment

• UPDATECARGOSTATUSANDEQUIPMENT

• Calls both UpdateCargoStatus and UpdateCargoEquipment in sequence. The Url setting must contain two semicolon-separated endpoints (status URL;equipment URL).

Update Cargo Priority And Equipment

• UPDATECARGOPRIORITYANDEQUIPMENT

• Calls both UpdateCargoPriority and UpdateCargoEquipment in sequence. The Url setting must contain two semicolon-separated endpoints (priority URL;equipment URL).

Update Cargo Status And Priority And Equipment

• UPDATECARGOSTATUSANDPRIORITYANDEQUIPMENT

• Calls UpdateCargoStatus, UpdateCargoPriority, and UpdateCargoEquipment in sequence. The Url setting must contain three semicolon-separated endpoints (status URL;priority URL;equipment URL).