Skip to main content

D&D Monitoring API

The base request URL for the TRADLINX Ocean Visibility API is: https://api.tradlinx.com

The API is activated based on a pre-agreed schedule. Once activated, you can send requests and receive responses normally.

Common API Guidelines:

  • An asterisk * indicates a required field.
  • A question mark ? indicates an optional field, which may or may not be provided.
  • Requests that violate these constraints will not be processed.
  • For types other than string, boolean, or number, refer to the custom types defined within this document.
  • For error code references, see the 'Error Codes' section in the reference materials.

🔔 API Update & Backward Compatibility Notice

The TRADLINX Ocean Visibility API may be updated from time to time to improve service quality, expand data coverage, and introduce new features.

When updating the API, we prioritize the stable operation of existing integrations and follow backward-compatible change principles, such as adding new fields.

Accordingly, we recommend that client systems be implemented in a backward-compatible manner so that they can continue to operate normally even when unknown or newly added fields are included in API responses.

If any changes may affect existing integrations, we will provide advance notice.

1. Retrieve D&D Monitoring​

  • Provides Demurrage & Detention monitoring data for B/L tracking registered entries.
  • B/L tracking entries that meet the following conditions can be queried through this feature:
    • Auto-tracking entries with Container+ feature enabled
    • Tracking entries with existing arrivalDateTime
  • arrivalDateTime is determined with the following priority:
    1. Vessel Arrival at Port event time at POD
    2. Berthing time at POD from AIS data
    3. ATA provided by the carrier
  • terminalDwellDays is calculated as the number of days from dischargeDateTime (or arrivalDateTime if not available) to gateOutDateTime.
  • streetDwellDays is calculated as the number of days from dischargeDateTime to emptyReturnDateTime.
  • terminalDwellDays and streetDwellDays are incremented by 1 day up to a maximum of 61 days and can be used as sorting fields in the order parameter.
  • terminalDwellRawDays and streetDwellRawDays are calculated without the maximum increment limit.
  • Date and time data within the content field follows the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssZ

Request

GET /partners/track/v3/dnd-monitoring

Query Parameters

FieldTypeDescription
arrival_fromstringStart Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss
arrival_tostringEnd Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss
carrier_codestringCarrier code
pod_location_codestringPOD port code
bl_nostringMaster B/L number
container_nostringContainer number
reference_nostringManagement number
terminal_dwell_daysnumberTerminal dwell days
street_dwell_daysnumberContainer usage days
exists_dischargebooleanContainer discharge flag
exists_gate_outbooleanGate Out flag
exists_empty_returnbooleanContainer return flag
orderARRIVAL_DATE_TIME_ASC
ARRIVAL_DATE_TIME_DESC
TERMINAL_DWELL_ASC
TERMINAL_DWELL_DESC
STREET_DWELL_ASC
STREET_DWELL_DESC
DISCHARGE_DATE_TIME_ASC
DISCHARGE_DATE_TIME_DESC
GATE_OUT_DATE_TIME_ASC
GATE_OUT_DATE_TIME_DESC
EMPTY_RETURN_DATE_TIME_ASC
EMPTY_RETURN_DATE_TIME_DESC
Data Sorting (Default: ARRIVAL_DATE_TIME_DESC)
*pagenumberPage number
*sizenumberPage size
curl -X GET "https://api.tradlinx.com/partners/track/v3/dnd-monitoring?arrival_from=[Arrival From]&arrival_to=[Arrival To]&page=[Page]&size=[Size]" \
-H "tx-clientid: [Client ID]" \
-H "tx-apikey: [API Key]" \
-H "Content-Type: application/json"

Response

{
"api_version": "v3",
"content": [
{
"registration_type": "BL_TRACKING",
"detail_status": "TRACKING",
"carrier_code": "TRX",
"carrier_name": "TRADLINX",
"container_no": "TRADLINX6882",
"bl_no": "MASTERBL1029",
"reference_no": "reference number-0123",
"pol_name": "Kwangyang",
"pol_code": "KRKWA",
"pod_name": "Pipavav",
"pod_code": "INPAV",
"latest_event": null,
"terminal_dwell_days": 1,
"terminal_dwell_raw_days": 1,
"street_dwell_days": 6,
"street_dwell_raw_days": 6,
"arrival_date_time": "2025-10-18T12:58:57Z",
"discharge_date_time": null,
"gate_out_date_time": "2025-10-20T06:02:12Z",
"empty_return_date_time": "2025-10-26T12:11:38Z"
}
],
"transaction_time": "2025-09-03T04:52:26.649981",
"size": 50,
"pagination": {
"total_size": 549,
"total_page": 11,
"current_page": 1,
"has_next": true
}
}

Response Body

FieldTypeDescriptionRemark
api_versionstringAPI versionv3
contentDndMonitoring[]D&D monitoring data
transaction_timestringResponse timestampyyyy-MM-dd'T'HH:mm:ss.SSSSSS
sizenumberPage size
paginationPaginationPagination information

D&D Monitoring Data - DndMonitoring

FieldTypeDescription
registration_typestringRegistration type
detail_statusstringDetail status
carrier_codestringCarrier code
carrier_namestringCarrier name
container_nostringContainer number
bl_nostringMaster B/L number
reference_nostringManagement number
pol_namestringPOL port name
pol_codestringPOL port code
pod_namestringPOD port name
pod_codestringPOD port code
?latest_eventstringLatest container event
?terminal_dwell_daysnumberTerminal dwell days (max 60 days)
?terminal_dwell_raw_daysnumberTerminal dwell days
?street_dwell_daysnumberContainer usage days (max 60 days)
?street_dwell_raw_daysnumberContainer usage days
arrival_date_timestringArrival date/time (yyyy-MM-dd'T'HH:mm:ssZ)
?discharge_date_timestringDischarge date/time (yyyy-MM-dd'T'HH:mm:ssZ)
?gate_out_date_timestringGate Out date/time (yyyy-MM-dd'T'HH:mm:ssZ)
?empty_return_date_timestringContainer return date/time (yyyy-MM-dd'T'HH:mm:ssZ)

Pagination Information - Pagination

FieldTypeDescription
total_sizenumberTotal data count
total_pagenumberTotal page count
current_pagenumberCurrent page number
has_nextbooleanWhether next page exists

400 Error

{
"error_detail": "[page]: Required field is not provided.",
"message": "SAMPLE_ERROR_CODE",
"transaction_time": "2025-08-28T07:21:13.367404"
}

500 Error

{
"status": 500,
"type": "Internal Server Error",
"message": "Internal server error. Please try again in a few minutes."
}