TRADLINX Ocean Visibility API collection, organized by the LNB structure. Inject base URL and auth headers (tx-clientid / tx-apikey) via collection/environment variables; never commit real secrets.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"55482299","collectionId":"f557a62a-509d-4035-b82c-3e57ae933738","publishedId":"2sBXwqsWYD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2d69ff"},"publishDate":"2026-06-25T14:35:16.000Z"},"item":[{"name":"Getting Started","item":[{"name":"Welcome to TRADLINX API","item":[],"id":"799d4329-e757-4be3-93f2-4e684f0b5a67","description":"Tradlinx provides APIs for ocean freight visibility and logistics operations.
\nWhether you're building a TMS, ERP, customer portal, or internal logistics platform, Tradlinx APIs help you integrate logistics data directly into your applications.
\nUsing standard logistics identifiers such as a Master B/L, Container Number, or Booking Number, you can track ocean shipments and access logistics data through Tradlinx APIs. Tradlinx also provides additional logistics intelligence APIs, including Port Congestion and Supply Chain Issue Monitoring.
\nIn ocean freight, tracking data is fragmented across dozens of carriers. Each carrier has its own portal, data format, and update schedule, making it difficult to consolidate and utilize shipment information efficiently.
\nIn addition, critical logistics intelligence such as port congestion and supply chain disruptions is often scattered across multiple sources, making it challenging to monitor and act on in a timely manner.
\nTradlinx standardizes this information through a unified API platform, allowing you to access shipment data using a consistent data structure regardless of carrier. Tradlinx also provides logistics intelligence APIs, including Port Congestion and Supply Chain Issue Monitoring, helping you make more informed operational decisions.
\nTo discuss the details further, a representative from our Sales Team will be available to provide detailed answers to all your questions. Please schedule a time that works best for you using the link below, or reach us at help@tradlinx.com
\n\n","_postman_id":"799d4329-e757-4be3-93f2-4e684f0b5a67"},{"name":"Common API Guidelines","item":[],"id":"51b489e7-8a87-46e1-99a4-7ad0329e7982","description":"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.
\nAn 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.
\nFor types other than string, boolean, or number, refer to the custom types defined within each document.
\nFor error code references, see the Error Codes section in References.
\n🔑
\nDon't have your API credentials yet? To get started, please reach out to our Sales Team — we'll get you set up right away. Please schedule a time that works best for you (Schedule A Meeting), or reach us at help@tradlinx.com
\nTradlinx APIs may be updated from time to time to improve service quality, expand data coverage, and introduce new features.
\nWhen making changes, Tradlinx prioritizes the stability of existing integrations and follows backward compatibility principles whenever possible. Examples of backward-compatible changes include:
\nAdding new response fields
\nAdding new enum values
\nIntroducing new optional request parameters
\n⭐ We recommend that client applications be designed to safely ignore unknown fields and handle newly added values gracefully.
\nIf a change may impact existing integrations, Tradlinx will provide advance notice whenever possible.
\n","_postman_id":"51b489e7-8a87-46e1-99a4-7ad0329e7982"}],"id":"79677685-6360-4abd-b375-b763143e5a79","_postman_id":"79677685-6360-4abd-b375-b763143e5a79","description":""},{"name":"Shipment Tracking APIs","item":[{"name":"B/L Shipment Tracking API","item":[{"name":"1. B/L Tracking Request","id":"732edc46-231f-4120-a75f-1674587d4d39","request":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"bl_no\": \"SAMPLE_BL_NO\",\n \"cntr_no\": \"SAMPLE_CNTR_NO\",\n \"cust_corp_nm\": \"SAMPLE_CORP_NAME\",\n \"cust_nm\": \"SAMPLE_CUSTOMER_NAME\",\n \"cust_order_id\": \"SAMPLE_ORDER_ID\",\n \"extend_tracking\": true,\n \"line_cd\": \"SAMPLE_LINE_CD\"\n }\n ]","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v2/cargo-tracks/tracking","description":"Register one or more Master Bill of Lading numbers to start shipment tracking.
\nRequests must be structured as an Array.
\nEach tracking record is uniquely identified by bl_no + line_cd + cust_order_id. This identifier set is used across all B/L Tracking APIs.
cust_order_id is your internal reference for the shipment (e.g. purchase order number, job ID).
Maximum 50 entries can be submitted per request.
\nFor the list of carrier codes, please refer to the Supported Carriers.
\nReturns a success list and a fail list. A request may partially succeed, so always check both the success and fail arrays.
Failed entries include a reason code. See Error Codes for details.
\nThis endpoint only registers tracking requests. To retrieve shipment tracking data, use Retrieve B/L Tracking Details.
\nRetrieve B/L tracking records registered within a specified date range.
\nResults are returned in a paginated format.
\nUse the page and size parameters to navigate through large result sets.
The registration period is based on the date and time when the tracking request was first registered.
\nDate and time fields in content follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssZ.
Start date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX
\n","type":"text/plain"},"key":"register_from","value":"[Register From]"},{"description":{"content":"End date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX
\n","type":"text/plain"},"key":"register_to","value":"[Register To]"},{"description":{"content":"(required) Page number (minimum: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1–1000)
\n","type":"text/plain"},"key":"size","value":"[Size]"}],"variable":[]}},"response":[{"id":"10b71ea7-601c-4efe-8b05-dde658a15f93","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/query?register_from=[Register From]®ister_to=[Register To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","query"],"query":[{"key":"register_from","value":"[Register From]","description":"Start date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX"},{"key":"register_to","value":"[Register To]","description":"End date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1–1000)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"transaction_time\": \"2025-07-09T04:04:06.333705\",\n \"content\": [\n {\n \"cargo_track_id\": \"SAMPLE_CARGO_TRACK_ID\",\n \"line_cd\": \"SAMPLE_LINE_CD\",\n \"bl_no\": \"SAMPLE_BL_NO\",\n \"cust_order_id\": \"SAMPLE_ORDER_ID\",\n \"cust_corp_name\": \"SAMPLE_CORP_NAME\",\n \"cust_name\": \"SAMPLE_CUSTOMER_NAME\",\n \"registered_datetime\": \"2025-02-27T06:51:49Z\",\n \"tracking_status\": \"COMPLETE\",\n \"trade_type\": null,\n \"is_container_plus\": true\n }\n ],\n \"size\": 1,\n \"pagination\": {\n \"current_page\": 1,\n \"has_next\": false,\n \"total_page\": 10,\n \"total_size\": 10\n }\n}"},{"id":"277bb564-50c6-4c34-ab74-3b61581b220e","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/query?register_from=[Register From]®ister_to=[Register To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","query"],"query":[{"key":"register_from","value":"[Register From]","description":"Start date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX"},{"key":"register_to","value":"[Register To]","description":"End date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1–1000)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"[page]: The value of the field must be greater than or equal to 1.\",\n \"transaction_time\": \"2025-03-20T05:42:27.135265\"\n}"},{"id":"552596ba-9223-4654-80a4-c88e768cb317","name":"500 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/query?register_from=[Register From]®ister_to=[Register To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","query"],"query":[{"key":"register_from","value":"[Register From]","description":"Start date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX"},{"key":"register_to","value":"[Register To]","description":"End date/time for registration filter. Must follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1–1000)"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"type\": \"Internal Server Error\",\n \"message\": \"Internal server error. Please try again in a few minutes.\"\n}"}],"_postman_id":"173dcf67-fdfb-4ca7-8d6c-bba6bfcec6f9"},{"name":"3. Retrieve B/L Tracking Details","id":"8dd607f4-cbc3-4827-a292-0ba8f7c8ed06","request":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details?bl_nos=[BL No],[BL No],[BL No]&page=[Page]&size=[Size]","description":"Retrieve detailed tracking information for one or more B/L numbers.
\nTracking details become available only after the tracking status reaches TRACKING.
Maximum 50 B/L numbers can be requested at once.
\nDate and time fields in content follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX.
(required) List of Bill of Lading numbers (Master B/L)
\n","type":"text/plain"},"key":"bl_nos","value":"[BL No],[BL No],[BL No]"},{"description":{"content":"(required) Page number (minimum: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1-50)
\n","type":"text/plain"},"key":"size","value":"[Size]"}],"variable":[]}},"response":[{"id":"d72da596-dd0d-4e92-a35c-93f5f773adff","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details?bl_nos=[BL No],[BL No],[BL No]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","details"],"query":[{"key":"bl_nos","value":"[BL No],[BL No],[BL No]","description":"(required) List of Bill of Lading numbers (Master B/L)"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"bl_no\": \"SAMPLE_BL_NO\",\n \"cargo_track_id\": \"SAMPLE_CARGO_TRACK_ID\",\n \"containers\": [\n {\n \"cntr_no\": \"SAMPLE_CNTR_NO\",\n \"cntr_sz\": \"SAMPLE_CNTR_SIZE\",\n \"cntr_tp\": \"SAMPLE_CNTR_TYPE\",\n \"container_events\": [\n {\n \"event_datetime\": \"2025-07-08T07:25:39+09:00\",\n \"event_type\": \"CONTAINER_PICK_UP\",\n \"is_actual\": false,\n \"port_code\": \"SAMPLE_PORT_CODE\",\n \"transportation\": \"BARGE\"\n }\n ],\n \"seal_no\": \"SAMPLE_SEAL_NO\"\n }\n ],\n \"current_vessel\": {\n \"imo\": \"SAMPLE_IMO\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"voyage\": \"SAMPLE_VOYAGE\"\n },\n \"cust_corp_name\": \"SAMPLE_CORP_NAME\",\n \"cust_name\": \"SAMPLE_CUSTOMER_NAME\",\n \"cust_order_id\": \"SAMPLE_CUST_ORDER_ID\",\n \"is_active\": false,\n \"is_container_plus\": false,\n \"line_cd\": \"SAMPLE_LINE_CD\",\n \"origin\": {\n \"location_code\": \"SAMPLE_LOCATION_CODE\",\n \"location_name\": \"SAMPLE_LOCATION_NAME\",\n \"init_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"estimate_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"actual_date_time\": \"2025-07-08T07:25:39+09:00\"\n },\n \"pod\": {\n \"ata\": \"2025-07-08T07:25:39+09:00\",\n \"eta\": \"2025-07-08T07:25:39+09:00\",\n \"init_eta\": \"2025-07-08T07:25:39+09:00\",\n \"pod_code\": \"SAMPLE_POD_PORT_CODE\",\n \"pod_name\": \"SAMPLE_POD_NAME\",\n \"tx_ata\": \"2025-07-08T07:25:39+09:00\"\n },\n \"pol\": {\n \"atd\": \"2025-07-08T07:25:39+09:00\",\n \"etd\": \"2025-07-08T07:25:39+09:00\",\n \"init_etd\": \"2025-07-08T07:25:39+09:00\",\n \"pol_code\": \"POL_PORT_CODE\",\n \"pol_name\": \"POL_NAME\",\n \"tx_atd\": \"2025-07-08T07:25:39+09:00\"\n },\n \"destination\": {\n \"location_code\": \"SAMPLE_LOCATION_CODE\",\n \"location_name\": \"SAMPLE_LOCATION_NAME\",\n \"init_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"estimate_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"actual_date_time\": \"2025-07-08T07:25:39+09:00\"\n },\n \"registered_datetime\": \"2025-07-08T07:25:39.493Z\",\n \"remark\": \"SAMPLE_REMARK\",\n \"routes\": [\n {\n \"ata\": \"2025-07-08T07:25:39+09:00\",\n \"atd\": \"2025-07-08T07:25:39+09:00\",\n \"eta\": \"2025-07-08T07:25:39+09:00\",\n \"etd\": \"2025-07-08T07:25:39+09:00\",\n \"imo\": \"SAMPLE_IMO\",\n \"init_eta\": \"2025-07-08T07:25:39+09:00\",\n \"init_etd\": \"2025-07-08T07:25:39+09:00\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"order\": 0,\n \"pod_code\": \"SAMPLE_POD_CODE\",\n \"pod_name\": \"SAMPLE_POD_NAME\",\n \"pol_code\": \"SAMPLE_POL_CODE\",\n \"pol_name\": \"SAMPLE_POL_NAME\",\n \"tx_ata\": \"2025-07-08T07:25:39+09:00\",\n \"tx_atd\": \"2025-07-08T07:25:39+09:00\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"voyage\": \"SAMPLE_VOYAGE\"\n }\n ],\n \"tracking_status\": \"TRACKING\",\n \"trade_type\": null,\n \"trans_type\": \"DIR\"\n }\n ],\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"pagination\": {\n \"current_page\": 0,\n \"has_next\": false,\n \"total_page\": 0,\n \"total_size\": 0\n },\n \"size\": 1,\n \"transaction_time\": \"2025-07-08T07:25:39.493258\"\n}"},{"id":"db228bb1-279f-4399-af49-7591613a4a45","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details?bl_nos=[BL No],[BL No],[BL No]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","details"],"query":[{"key":"bl_nos","value":"[BL No],[BL No],[BL No]","description":"(required) List of Bill of Lading numbers (Master B/L)"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"error_detail\": \"[page]: The value of the field must be greater than or equal to 1.\",\n\t\"transaction_time\": \"2025-03-20T05:42:27.123543\"\n}"},{"id":"c07bb65b-bfd3-4397-bf50-6d5bd54d7a8a","name":"500 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details?bl_nos=[BL No],[BL No],[BL No]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","details"],"query":[{"key":"bl_nos","value":"[BL No],[BL No],[BL No]","description":"(required) List of Bill of Lading numbers (Master B/L)"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": 500,\n\t\"type\": \"Internal Server Error\",\n\t\"message\": \"Internal server error. Please try again in a few minutes.\"\n}"}],"_postman_id":"8dd607f4-cbc3-4827-a292-0ba8f7c8ed06"},{"name":"4. B/L Tracking Update Request","id":"a34f6716-b450-486d-abbe-aec4162ceecb","request":{"method":"PUT","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cust_order_id\": \"SAMPLE_ORDER_ID\",\n \"cust_corp_name\": \"SAMPLE_CORP_NAME\",\n \"cust_name\": \"SAMPLE_CUSTOMER_NAME\",\n \"remark\": \"SAMPLE_REMARK\"\n }","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/:cargo_track_id","description":"Update an existing B/L tracking record using its unique cargo_track_id.
\nIf bl_no, line_cd, and cust_order_id all match an existing record, the update will not be applied. If only one or two fields match, the update is allowed.
Unique B/L tracking ID that can be obtained through B/L tracking lookup
\n","type":"text/plain"},"type":"any","value":"","key":"cargo_track_id"}]}},"response":[{"id":"4102e110-121e-4c5a-b567-9533f1599d5b","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cust_order_id\": \"SAMPLE_ORDER_ID\",\n \"cust_corp_name\": \"SAMPLE_CORP_NAME\",\n \"cust_name\": \"SAMPLE_CUSTOMER_NAME\",\n \"remark\": \"SAMPLE_REMARK\"\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/:cargo_track_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks",":cargo_track_id"],"variable":[{"key":"cargo_track_id","value":"","description":"Unique B/L tracking ID that can be obtained through B/L tracking lookup"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"1820fccc-9308-4b77-8e51-407d5e8bd707","name":"400 Error","originalRequest":{"method":"PUT","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cust_order_id\": \"SAMPLE_ORDER_ID\",\n \"cust_corp_name\": \"SAMPLE_CORP_NAME\",\n \"cust_name\": \"SAMPLE_CUSTOMER_NAME\",\n \"remark\": \"SAMPLE_REMARK\"\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/:cargo_track_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks",":cargo_track_id"],"variable":[{"key":"cargo_track_id","value":"","description":"Unique B/L tracking ID that can be obtained through B/L tracking lookup"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"error_detail\": \"[cust_order_id]: must not be blank\",\n\t\"transaction_time\": \"2024-08-13T05:42:27.251232\"\n}"}],"_postman_id":"a34f6716-b450-486d-abbe-aec4162ceecb"},{"name":"5. B/L Tracking Cancellation Request","id":"ac302b77-bcda-4282-9177-452736819d59","request":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"bl_no\": \"SAMPLE_BL_NO\",\n \"cust_order_id\": \"SAMPLE_ORDER_ID\",\n \"line_cd\": \"SAMPLE_LINE_CD\"\n }\n ]","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v2/cargo-tracks/cancel","description":"Cancel one or more B/L tracking records in a single request.
\nRequests must be structured as an Array.
\nEach entry is identified by bl_no + line_cd + cust_order_id.
\nMax 50 entries per request
\nCredits are refunded only if tracking has not started. If the tracking status is TRACKING or COMPLETE, credits will not be refunded.
Register one or more B/L tracking entries manually when automatic tracking is not available.
\nRequests must be structured as an Array.
\nEach tracking record is uniquely identified by bl_no + line_cd + cust_order_id. Duplicate combinations are not allowed.Manual Tracking relies on the route and vessel information provided in the request, including POL, POD, ETD, ETA, vessel name, and IMO number.
Inaccurate or missing information may result in incomplete or inaccurate tracking data.
\nMaximum 50 entries can be submitted per request.
\nUpdate an existing manually registered B/L tracking entry.
\nThe tracking identifier ( bl_no + line_cd + cust_order_id) cannot be modified after registration. To change any of these values, cancel the existing tracking record and create a new one.
bl_no, line_cd, and cust_order_id form the unique identifier for this record and cannot be modified once registered.
B/L Tracking allows you to monitor shipment status using a Master Bill of Lading number.
\nSubmit a Master B/L number and carrier code to register a shipment for tracking. Tradlinx continuously collects shipment data from the carrier and provides tracking updates through the API.
\nEach tracking record is uniquely identified by the combination of bl_no + line_cd + cust_order_id. This identifier set is used across all B/L Tracking APIs.
The B/L Tracking API is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month).
\nTo enable this API, an active Enterprise subscription is required.
\n\nGetting started requires two steps:
\nSubmit the B/L number, carrier code, and your internal shipment reference.
\nTradlinx begins collecting shipment tracking data immediately.
\nQuery the tracking record using the same bl_no + line_cd + cust_order_id.
Once tracking becomes available, shipment events, vessel information, route details, and container information can be retrieved through the API.
\nRegister one or more containers to start shipment tracking.
\nRequests must be structured as an Array.
\nEach tracking record is uniquely identified by container_no + carrier_code + reference_no. This identifier set is used across all Container Tracking APIs.
reference_no is your internal reference for the shipment (e.g. purchase order number, job ID).
For the list of carrier codes, please refer to the Supported Carriers.
\nRetrieve detailed tracking information for registered container tracking records.
\nTracking details become available only after the tracking status reaches TRACKING.
Date and time data within the content field follows ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX
Container number
\n","type":"text/plain"},"key":"container_no","value":"[Container No]"},{"description":{"content":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_from","value":"[Register From]"},{"description":{"content":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_to","value":"[Register To]"},{"description":{"content":"Reference number
\n","type":"text/plain"},"key":"reference_no","value":"[Reference No]"},{"description":{"content":"Carrier code
\n","type":"text/plain"},"key":"carrier_code","value":"[Carrier Code]"},{"description":{"content":"(required) Page number (minimum: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1-50)
\n","type":"text/plain"},"key":"size","value":"[Size]"},{"disabled":true,"description":{"content":"tracking status
\n","type":"text/plain"},"key":"status","value":""}],"variable":[]}},"response":[{"id":"09df3a9d-7d1b-492c-a98c-536806b4b7f4","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks?container_no=[Container No]®ister_from=[Register From]®ister_to=[Register To]&reference_no=[Reference No]&carrier_code=[Carrier Code]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks"],"query":[{"key":"container_no","value":"[Container No]","description":"Container number"},{"key":"register_from","value":"[Register From]","description":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"reference_no","value":"[Reference No]","description":"Reference number"},{"key":"carrier_code","value":"[Carrier Code]","description":"Carrier code"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"},{"key":"status","value":"","description":"tracking status","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"container_no\": \"SAMPLE_CONTAINER_NO\",\n \"carrier_code\": \"SAMPLE_CARRIER_CODE\",\n \"client\": \"SAMPLE_CLIENT\",\n \"containers\": [\n {\n \"cntr_no\": \"SAMPLE_CNTR_NO\",\n \"cntr_sz\": \"SAMPLE_CNTR_SZ\",\n \"cntr_tp\": \"SAMPLE_CNTR_TP\",\n \"container_events\": [\n {\n \"event_datetime\": \"SAMPLE_EVENT_DATETIME\",\n \"event_type\": \"SAMPLE_EVENT_TYPE\",\n \"is_actual\": false,\n \"port_code\": \"SAMPLE_PORT_CODE\",\n \"transportation\": \"SAMPLE_TRANSPORTATION\"\n }\n ],\n \"seal_no\": \"SAMPLE_SEAL_NO\"\n }\n ],\n \"current_vessel\": {\n \"imo\": \"SAMPLE_IMO\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"voyage\": \"SAMPLE_VOYAGE\"\n },\n \"detail_status\": \"SAMPLE_DETAIL_STATUS\",\n \"internal_usage\": \"SAMPLE_INTERNAL_USAGE\",\n \"origin\": {\n \"location_code\": \"SAMPLE_LOCATION_CODE\",\n \"location_name\": \"SAMPLE_LOCATION_NAME\",\n \"init_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"estimate_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"actual_date_time\": \"2025-07-08T07:25:39+09:00\"\n },\n \"pod\": {\n \"ata\": \"2025-07-09T05:32:47+09:00\",\n \"eta\": \"2025-07-09T05:32:47+09:00\",\n \"init_eta\": \"2025-07-09T05:32:47+09:00\",\n \"pod_code\": \"SAMPLE_POD_CODE\",\n \"pod_name\": \"SAMPLE_POD_NAME\",\n \"tx_ata\": \"2025-07-09T05:32:47+09:00\"\n },\n \"pol\": {\n \"atd\": \"2025-07-09T05:32:47+09:00\",\n \"etd\": \"2025-07-09T05:32:47+09:00\",\n \"init_etd\": \"2025-07-09T05:32:47+09:00\",\n \"pol_code\": \"SAMPLE_POL_CODE\",\n \"pol_name\": \"SAMPLE_POL_NAME\",\n \"tx_atd\": \"2025-07-09T05:32:47+09:00\"\n },\n \"destination\": {\n \"location_code\": \"SAMPLE_LOCATION_CODE\",\n \"location_name\": \"SAMPLE_LOCATION_NAME\",\n \"init_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"estimate_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"actual_date_time\": \"2025-07-08T07:25:39+09:00\"\n },\n \"reference_no\": \"SAMPLE_REFERENCE_NO\",\n \"registered_datetime\": \"2025-07-08T07:25:39.493Z\",\n \"remark\": \"SAMPLE_REMARK\",\n \"routes\": [\n {\n \"ata\": \"2025-07-09T05:32:47+09:00\",\n \"atd\": \"2025-07-09T05:32:47+09:00\",\n \"eta\": \"2025-07-09T05:32:47+09:00\",\n \"etd\": \"2025-07-09T05:32:47+09:00\",\n \"imo\": \"SAMPLE_IMO\",\n \"init_eta\": \"2025-07-09T05:32:47+09:00\",\n \"init_etd\": \"2025-07-09T05:32:47+09:00\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"order\": 0,\n \"pod_code\": \"SAMPLE_POD_CODE\",\n \"pod_name\": \"SAMPLE_POD_NAME\",\n \"pol_code\": \"SAMPLE_POL_CODE\",\n \"pol_name\": \"SAMPLE_POL_NAME\",\n \"tx_ata\": \"2025-07-09T05:32:47+09:00\",\n \"tx_atd\": \"2025-07-09T05:32:47+09:00\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"voyage\": \"SAMPLE_VOYAGE\"\n }\n ],\n \"status\": \"SAMPLE_STATUS\",\n \"track_mst_id\": \"SAMPLE_TRACK_MST_ID\",\n \"trans_type\": \"SAMPLE_TRANS_TYPE\"\n }\n ],\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"pagination\": {\n \"current_page\": 0,\n \"has_next\": false,\n \"total_page\": 0,\n \"total_size\": 0\n },\n \"size\": 1,\n \"transaction_time\": \"2025-07-09T05:32:47.939106\"\n}"},{"id":"9487fa01-cc04-4740-a026-2f267b9b9a07","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks?container_no=[Container No]®ister_from=[Register From]®ister_to=[Register To]&reference_no=[Reference No]&carrier_code=[Carrier Code]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks"],"query":[{"key":"container_no","value":"[Container No]","description":"Container number"},{"key":"register_from","value":"[Register From]","description":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"reference_no","value":"[Reference No]","description":"Reference number"},{"key":"carrier_code","value":"[Carrier Code]","description":"Carrier code"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"},{"key":"status","value":"","description":"tracking status","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"[page]: The value of the field must be greater than or equal to 1.\",\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2025-03-20T05:42:27.171506\"\n}"},{"id":"8a7282be-08b2-4de5-b955-7c49e5e75f40","name":"500 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks?container_no=[Container No]®ister_from=[Register From]®ister_to=[Register To]&reference_no=[Reference No]&carrier_code=[Carrier Code]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks"],"query":[{"key":"container_no","value":"[Container No]","description":"Container number"},{"key":"register_from","value":"[Register From]","description":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"reference_no","value":"[Reference No]","description":"Reference number"},{"key":"carrier_code","value":"[Carrier Code]","description":"Carrier code"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"},{"key":"status","value":"","description":"tracking status","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"type\": \"Internal Server Error\",\n \"message\": \"Internal server error. Please try again in a few minutes.\"\n}"}],"_postman_id":"8b7a6957-f9c2-48e4-9c7a-5e6a4c1c343f"},{"name":"3. Container No. Tracking Re-Registration Request","id":"31e27446-9c09-4bc8-b623-b7a12ef2e332","request":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id/re-enroll","description":"Re-registration is available for tracking records that could not be tracked due to retry failure, plan restrictions, or insufficient credits.
\nContainer tracking records can only be re-registration one at a time.
\nUnique shipment ID that can be obtained through shipment lookup
\n","type":"text/plain"},"type":"any","value":"","key":"track_mst_id"}]}},"response":[{"id":"47840b2e-2d7a-49f3-a2cb-bf3b85c2087d","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id/re-enroll","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks",":track_mst_id","re-enroll"],"variable":[{"key":"track_mst_id","value":"","description":"Unique shipment ID that can be obtained through shipment lookup"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": {\n \"container_no\": \"SAMPLE_CONTAINER_NO\",\n \"carrier_code\": \"SAMPLE_CARRIER_CODE\",\n \"client\": \"SAMPLE_CLIENT\",\n \"internal_usage\": \"SAMPLE_INTERNAL_USAGE\",\n \"reference_no\": \"SAMPLE_REFERENCE_NO\",\n \"track_mst_id\": \"SAMPLE_TRACK_MST_ID\"\n },\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2025-07-09T05:22:11.380245\"\n}"},{"id":"6f164da0-1f29-4ec4-bb49-e5887db51cd8","name":"400 Error","originalRequest":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id/re-enroll","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks",":track_mst_id","re-enroll"],"variable":[{"key":"track_mst_id","value":"","description":"Unique shipment ID that can be obtained through shipment lookup"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"Resource not found.\",\n \"transaction_time\": \"2026-06-25 00:37:58\",\n \"message\": \"RESOURCE_NOT_FOUND\"\n}"}],"_postman_id":"31e27446-9c09-4bc8-b623-b7a12ef2e332"},{"name":"4. Container No. Tracking Update Request","id":"8808ad0b-5cbd-4ce4-9ac0-7e8ceeb9c462","request":{"method":"PATCH","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference_no\": \"SAMPLE_REFERENCE_NO\",\n \"client\": \"SAMPLE_CLIENT_NAME\",\n \"internal_usage\": \"SAMPLE_INTERNAL_USAGE\",\n \"remark\": \"SAMPLE_REMARK\"\n }","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id","description":"Update metadata on an existing container tracking record.
\nThe combination of container_no + carrier_code + reference_no must remain unique.
Updates that create duplicate tracking records will be rejected.
\nUnique shipment ID that can be obtained through shipment lookup
\n","type":"text/plain"},"type":"any","value":"","key":"track_mst_id"}]}},"response":[{"id":"c261ca63-d0c4-4efa-a7b5-c2679f7f10e6","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference_no\": \"SAMPLE_REFERENCE_NO\",\n \"client\": \"SAMPLE_CLIENT_NAME\",\n \"internal_usage\": \"SAMPLE_INTERNAL_USAGE\",\n \"remark\": \"SAMPLE_REMARK\"\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks",":track_mst_id"],"variable":[{"key":"track_mst_id","value":"","description":"Unique shipment ID that can be obtained through shipment lookup"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"transaction_time\": \"2026-06-25T00:32:23.190632\"\n}"},{"id":"b5e4d9ea-354e-4436-b62c-4bff089d1f13","name":"400 Error","originalRequest":{"method":"PUT","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"reference_no\": \"SAMPLE_REFERENCE_NO\",\n \"client\": \"SAMPLE_CLIENT_NAME\",\n \"internal_usage\": \"SAMPLE_INTERNAL_USAGE\",\n \"remark\": \"SAMPLE_REMARK\"\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks",":track_mst_id"],"variable":[{"key":"track_mst_id","value":"","description":"Unique shipment ID that can be obtained through shipment lookup"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"[track_mst_id]: must not be blank\",\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2024-08-13T05:42:27.402256\"\n}"}],"_postman_id":"8808ad0b-5cbd-4ce4-9ac0-7e8ceeb9c462"},{"name":"5. Container No. Tracking Cancellation Request","id":"6860439c-01fe-4ddb-ac80-2cfa871bd0c9","request":{"method":"DELETE","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id","description":"Container tracking records can only be canceled one at a time.
\nCredits are refunded only if tracking has not started. If the tracking status is TRACKING or COMPLETE, credits will not be refunded.
Unique shipment ID that can be obtained through shipment lookup
\n","type":"text/plain"},"type":"any","value":"","key":"track_mst_id"}]}},"response":[{"id":"62163c03-d838-4c67-a96d-247081a15a09","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks/:track_mst_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks",":track_mst_id"],"variable":[{"key":"track_mst_id","value":"","description":"Unique shipment ID that can be obtained through shipment lookup"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"transaction_time\": \"2026-06-25T00:39:31.107587\"\n}"}],"_postman_id":"6860439c-01fe-4ddb-ac80-2cfa871bd0c9"}],"id":"983e0466-4298-49a7-a9e7-712f8302c1df","description":"Tradlinx supports shipment tracking by B/L, Container, and Vessel. This page covers Container No. Tracking only.
\nContainer No. Tracking allows you to monitor shipment status using a Container Number. Submit a container number — Tradlinx begins tracking the shipment and returns status updates through the API.
\nThe Container No. Tracking API is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month). To adopt this API officially, an active Enterprise subscription is required.
\nTo upgrade your plan to Enterprise Plan, contact our sales team
\n\nMake your first tracking call in two steps.
\n[Register a container for tracking →]
Submit the container number and carrier code. Tradlinx starts collecting shipment data immediately. (For Detail)
[Retrieve tracking details →]
Query using the same identifier set. Once the status reaches TRACKING, shipment events and tracking information become available. (For Detail)
Retrieve Demurrage & Detention (D&D) monitoring data for shipments registered through the B/L Tracking API.
\nQueryable entries must meet the following conditions:
\nAuto-tracking entries with Container+ enabled
\nEntries with a valid arrivalDateTime
Date and time fields in content follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssZ.
arrivalDateTime is determined using the following priority:
Vessel Arrival at Port event at POD
\nBerthing time at POD derived from AIS data
\nATA provided by the carrier
\nterminalDwellDays is calculated from dischargeDateTime or arrivalDateTime if dischargeDateTime is unavailable, to gateOutDateTime.
streetDwellDays is calculated from dischargeDateTime to emptyReturnDateTime.
terminalDwellDays and streetDwellDays increase by one day per day, up to a maximum of 61 days. These values can be used for sorting.
terminalDwellRawDays and streetDwellRawDays are calculated without the maximum limit.
Start Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss
\n","type":"text/plain"},"key":"arrival_from","value":"[Arrival From]"},{"description":{"content":"End Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss
\n","type":"text/plain"},"key":"arrival_to","value":"[Arrival To]"},{"description":{"content":"(required) Page number
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size
\n","type":"text/plain"},"key":"size","value":"[Size]"},{"disabled":true,"description":{"content":"Carrier code
\n","type":"text/plain"},"key":"carrier_code","value":""},{"disabled":true,"description":{"content":"POD port code
\n","type":"text/plain"},"key":"pod_location_code","value":""},{"disabled":true,"description":{"content":"Master B/L number
\n","type":"text/plain"},"key":"bl_no","value":""},{"disabled":true,"description":{"content":"Container number
\n","type":"text/plain"},"key":"container_no","value":""},{"disabled":true,"description":{"content":"Management number
\n","type":"text/plain"},"key":"reference_no","value":""},{"disabled":true,"description":{"content":"Terminal dwell days
\n","type":"text/plain"},"key":"terminal_dwell_days","value":""},{"disabled":true,"description":{"content":"Container usage days
\n","type":"text/plain"},"key":"street_dwell_days","value":""},{"disabled":true,"description":{"content":"Container discharge flag
\n","type":"text/plain"},"key":"exists_discharge","value":""},{"disabled":true,"description":{"content":"Gate Out flag
\n","type":"text/plain"},"key":"exists_gate_out","value":""},{"disabled":true,"description":{"content":"Container return flag
\n","type":"text/plain"},"key":"exists_empty_return","value":""},{"disabled":true,"description":{"content":"Data Sorting (Default: ARRIVAL_DATE_TIME_DESC)
\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[{"id":"8ca472b9-c6e1-4719-80fd-0af263e977f8","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/dnd-monitoring?arrival_from=[Arrival From]&arrival_to=[Arrival To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","dnd-monitoring"],"query":[{"key":"arrival_from","value":"[Arrival From]","description":"Start Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss"},{"key":"arrival_to","value":"[Arrival To]","description":"End Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss"},{"key":"page","value":"[Page]","description":"(required) Page number"},{"key":"size","value":"[Size]","description":"(required) Page size"},{"key":"carrier_code","value":"","description":"Carrier code","disabled":true},{"key":"pod_location_code","value":"","description":"POD port code","disabled":true},{"key":"bl_no","value":"","description":"Master B/L number","disabled":true},{"key":"container_no","value":"","description":"Container number","disabled":true},{"key":"reference_no","value":"","description":"Management number","disabled":true},{"key":"terminal_dwell_days","value":"","description":"Terminal dwell days","disabled":true},{"key":"street_dwell_days","value":"","description":"Container usage days","disabled":true},{"key":"exists_discharge","value":"","description":"Container discharge flag","disabled":true},{"key":"exists_gate_out","value":"","description":"Gate Out flag","disabled":true},{"key":"exists_empty_return","value":"","description":"Container return flag","disabled":true},{"key":"order","value":"","description":"Data Sorting (Default: ARRIVAL_DATE_TIME_DESC)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"registration_type\": \"BL_TRACKING\",\n \"detail_status\": \"TRACKING\",\n \"carrier_code\": \"TRX\",\n \"carrier_name\": \"TRADLINX\",\n \"container_no\": \"TRADLINX6882\",\n \"bl_no\": \"MASTERBL1029\",\n \"reference_no\": \"reference number-0123\",\n \"pol_name\": \"Kwangyang\",\n \"pol_code\": \"KRKWA\",\n \"pod_name\": \"Pipavav\",\n \"pod_code\": \"INPAV\",\n \"latest_event\": null,\n \"terminal_dwell_days\": 1,\n \"terminal_dwell_raw_days\": 1,\n \"street_dwell_days\": 6,\n \"street_dwell_raw_days\": 6,\n \"arrival_date_time\": \"2025-10-18T12:58:57Z\",\n \"discharge_date_time\": null,\n \"gate_out_date_time\": \"2025-10-20T06:02:12Z\",\n \"empty_return_date_time\": \"2025-10-26T12:11:38Z\"\n }\n ],\n \"transaction_time\": \"2025-09-03T04:52:26.649981\",\n \"size\": 50,\n \"pagination\": {\n \"total_size\": 549,\n \"total_page\": 11,\n \"current_page\": 1,\n \"has_next\": true\n }\n}"},{"id":"a7f51165-0015-4a52-a811-ec2d6dbf1384","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/dnd-monitoring?arrival_from=[Arrival From]&arrival_to=[Arrival To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","dnd-monitoring"],"query":[{"key":"arrival_from","value":"[Arrival From]","description":"Start Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss"},{"key":"arrival_to","value":"[Arrival To]","description":"End Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss"},{"key":"page","value":"[Page]","description":"(required) Page number"},{"key":"size","value":"[Size]","description":"(required) Page size"},{"key":"carrier_code","value":"","description":"Carrier code","disabled":true},{"key":"pod_location_code","value":"","description":"POD port code","disabled":true},{"key":"bl_no","value":"","description":"Master B/L number","disabled":true},{"key":"container_no","value":"","description":"Container number","disabled":true},{"key":"reference_no","value":"","description":"Management number","disabled":true},{"key":"terminal_dwell_days","value":"","description":"Terminal dwell days","disabled":true},{"key":"street_dwell_days","value":"","description":"Container usage days","disabled":true},{"key":"exists_discharge","value":"","description":"Container discharge flag","disabled":true},{"key":"exists_gate_out","value":"","description":"Gate Out flag","disabled":true},{"key":"exists_empty_return","value":"","description":"Container return flag","disabled":true},{"key":"order","value":"","description":"Data Sorting (Default: ARRIVAL_DATE_TIME_DESC)","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"[page]: Required field is not provided.\",\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2025-08-28T07:21:13.367404\"\n}"},{"id":"15b366c9-1c3b-403f-9bb9-50f70d07f051","name":"500 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/dnd-monitoring?arrival_from=[Arrival From]&arrival_to=[Arrival To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","dnd-monitoring"],"query":[{"key":"arrival_from","value":"[Arrival From]","description":"Start Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss"},{"key":"arrival_to","value":"[Arrival To]","description":"End Date of arrivalDateTime yyyy-MM-dd'T'HH:mm:ss"},{"key":"page","value":"[Page]","description":"(required) Page number"},{"key":"size","value":"[Size]","description":"(required) Page size"},{"key":"carrier_code","value":"","description":"Carrier code","disabled":true},{"key":"pod_location_code","value":"","description":"POD port code","disabled":true},{"key":"bl_no","value":"","description":"Master B/L number","disabled":true},{"key":"container_no","value":"","description":"Container number","disabled":true},{"key":"reference_no","value":"","description":"Management number","disabled":true},{"key":"terminal_dwell_days","value":"","description":"Terminal dwell days","disabled":true},{"key":"street_dwell_days","value":"","description":"Container usage days","disabled":true},{"key":"exists_discharge","value":"","description":"Container discharge flag","disabled":true},{"key":"exists_gate_out","value":"","description":"Gate Out flag","disabled":true},{"key":"exists_empty_return","value":"","description":"Container return flag","disabled":true},{"key":"order","value":"","description":"Data Sorting (Default: ARRIVAL_DATE_TIME_DESC)","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"type\": \"Internal Server Error\",\n \"message\": \"Internal server error. Please try again in a few minutes.\"\n}"}],"_postman_id":"ba95e4b7-be84-4c97-be78-f5e59ce2e561"}],"id":"2874082a-9495-417f-b90b-bffc02035e77","description":"Tradlinx provides D&D Monitoring as an extension of the B/L Tracking API. This page covers D&D Monitoring only.
\nD&D Monitoring allows you to track Demurrage & Detention risk at the container level, based on shipment data collected through B/L Tracking. Monitor container pickup and return durations to proactively manage potential D&D cost risks before charges accrue.
\nD&D Monitoring is available only for shipments registered under B/L Tracking.
\nFor supported carriers, see Supported Carriers.
\nThe D&D Monitoring API is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month) and using the B/L Shipment Tracking API. To adopt this API officially, an active Enterprise subscription is required.
\nTo upgrade your plan to Enterprise Plan, contact our sales team https://documenter.getpostman.com/view/55482299/2sBXwqsWYD#8b7a6957-f9c2-48e4-9c7a-5e6a4c1c343fhttps://documenter.getpostman.com/view/55482299/2sBXwqsWYD#8b7a6957-f9c2-48e4-9c7a-5e6a4c1c343f
\n\n","_postman_id":"2874082a-9495-417f-b90b-bffc02035e77"},{"name":"AI-ETA","item":[{"name":"1. Retrieve B/L Tracking Details (AI ETA)","id":"9ef74deb-d32b-4bad-b11e-2f07801d047c","request":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details/ai-eta?bl_nos=[BL No],[BL No],[BL No]&tracking_status=[Tracking Status]®ister_from=[Register From]®ister_to=[Register To]&active=[Active]&page=[Page]&size=[Size]","description":"Retrieve detailed B/L tracking data and AI ETA prediction information for registered shipments.
\nThis API requires the B/L Shipment Tracking API and can only be used for shipments that have already been registered through B/L Tracking.
\nTo retrieve AI ETA prediction data, replace the standard \"3. Retrieve B/L Tracking Details\" API with this endpoint.
\nMaximum 50 tracking records can be retrieved per request.
\nOnly successfully registered B/L tracking entries can be queried.
\nDate and time fields in content follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX.
List of Bill of Lading numbers (Master B/L)
\n","type":"text/plain"},"key":"bl_nos","value":"[BL No],[BL No],[BL No]"},{"description":{"content":"Tracking status filter (comma-separated)
\n","type":"text/plain"},"key":"tracking_status","value":"[Tracking Status]"},{"description":{"content":"Registration start date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_from","value":"[Register From]"},{"description":{"content":"Registration end date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_to","value":"[Register To]"},{"description":{"content":"Active status filter (default: true)
\n","type":"text/plain"},"key":"active","value":"[Active]"},{"description":{"content":"(required) Page number (minimum: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1-50)
\n","type":"text/plain"},"key":"size","value":"[Size]"}],"variable":[]}},"response":[{"id":"4c479b2c-5073-4d73-b5ee-6c3bed63b148","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details/ai-eta?bl_nos=[BL No],[BL No],[BL No]&tracking_status=[Tracking Status]®ister_from=[Register From]®ister_to=[Register To]&active=[Active]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","details","ai-eta"],"query":[{"key":"bl_nos","value":"[BL No],[BL No],[BL No]","description":"List of Bill of Lading numbers (Master B/L)"},{"key":"tracking_status","value":"[Tracking Status]","description":"Tracking status filter (comma-separated)"},{"key":"register_from","value":"[Register From]","description":"Registration start date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration end date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"active","value":"[Active]","description":"Active status filter (default: true)"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"bl_no\": \"SAMPLE_BL_NO\",\n \"cargo_track_id\": \"SAMPLE_CARGO_TRACK_ID\",\n \"containers\": [\n {\n \"cntr_no\": \"SAMPLE_CNTR_NO\",\n \"cntr_sz\": \"SAMPLE_CNTR_SIZE\",\n \"cntr_tp\": \"SAMPLE_CNTR_TYPE\",\n \"container_events\": [\n {\n \"event_datetime\": \"2025-07-08T07:25:39+09:00\",\n \"event_type\": \"CONTAINER_PICK_UP\",\n \"is_actual\": false,\n \"port_code\": \"SAMPLE_PORT_CODE\",\n \"transportation\": \"BARGE\"\n }\n ],\n \"seal_no\": \"SAMPLE_SEAL_NO\"\n }\n ],\n \"current_vessel\": {\n \"imo\": \"SAMPLE_IMO\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"voyage\": \"SAMPLE_VOYAGE\"\n },\n \"cust_corp_name\": \"SAMPLE_CORP_NAME\",\n \"cust_name\": \"SAMPLE_CUSTOMER_NAME\",\n \"cust_order_id\": \"SAMPLE_CUST_ORDER_ID\",\n \"is_active\": false,\n \"is_container_plus\": false,\n \"line_cd\": \"SAMPLE_LINE_CD\",\n \"origin\": {\n \"location_code\": \"SAMPLE_LOCATION_CODE\",\n \"location_name\": \"SAMPLE_LOCATION_NAME\",\n \"init_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"estimate_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"actual_date_time\": \"2025-07-08T07:25:39+09:00\"\n },\n \"pod\": {\n \"ata\": \"2025-07-08T07:25:39+09:00\",\n \"eta\": \"2025-07-08T07:25:39+09:00\",\n \"init_eta\": \"2025-07-08T07:25:39+09:00\",\n \"pod_code\": \"SAMPLE_POD_PORT_CODE\",\n \"pod_name\": \"SAMPLE_POD_NAME\",\n \"tx_ata\": \"2025-07-08T07:25:39+09:00\",\n \"ai_eta\": {\n \"ai_eta\": \"2025-07-10T14:00:00+09:00\",\n \"ai_eta_p10\": \"2025-07-09T08:00:00+09:00\",\n \"ai_eta_p90\": \"2025-07-12T22:00:00+09:00\",\n \"ai_eta_confidence\": 72.50\n }\n },\n \"pol\": {\n \"atd\": \"2025-07-08T07:25:39+09:00\",\n \"etd\": \"2025-07-08T07:25:39+09:00\",\n \"init_etd\": \"2025-07-08T07:25:39+09:00\",\n \"pol_code\": \"POL_PORT_CODE\",\n \"pol_name\": \"POL_NAME\",\n \"tx_atd\": \"2025-07-08T07:25:39+09:00\"\n },\n \"destination\": {\n \"location_code\": \"SAMPLE_LOCATION_CODE\",\n \"location_name\": \"SAMPLE_LOCATION_NAME\",\n \"init_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"estimate_date_time\": \"2025-07-08T07:25:39+09:00\",\n \"actual_date_time\": \"2025-07-08T07:25:39+09:00\"\n },\n \"registered_datetime\": \"2025-07-08T07:25:39.493Z\",\n \"remark\": \"SAMPLE_REMARK\",\n \"routes\": [\n {\n \"ata\": \"2025-07-08T07:25:39+09:00\",\n \"atd\": \"2025-07-08T07:25:39+09:00\",\n \"eta\": \"2025-07-08T07:25:39+09:00\",\n \"etd\": \"2025-07-08T07:25:39+09:00\",\n \"imo\": \"SAMPLE_IMO\",\n \"init_eta\": \"2025-07-08T07:25:39+09:00\",\n \"init_etd\": \"2025-07-08T07:25:39+09:00\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"order\": 0,\n \"pod_code\": \"SAMPLE_POD_CODE\",\n \"pod_name\": \"SAMPLE_POD_NAME\",\n \"pol_code\": \"SAMPLE_POL_CODE\",\n \"pol_name\": \"SAMPLE_POL_NAME\",\n \"tx_ata\": \"2025-07-08T07:25:39+09:00\",\n \"tx_atd\": \"2025-07-08T07:25:39+09:00\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"voyage\": \"SAMPLE_VOYAGE\",\n \"ai_eta\": {\n \"ai_eta\": \"2025-07-10T14:00:00+09:00\",\n \"ai_eta_p10\": \"2025-07-09T08:00:00+09:00\",\n \"ai_eta_p90\": \"2025-07-12T22:00:00+09:00\",\n \"ai_eta_confidence\": 72.50\n }\n }\n ],\n \"tracking_status\": \"TRACKING\",\n \"trade_type\": null,\n \"trans_type\": \"DIR\"\n }\n ],\n \"pagination\": {\n \"current_page\": 0,\n \"has_next\": false,\n \"total_page\": 0,\n \"total_size\": 0\n },\n \"size\": 1,\n \"transaction_time\": \"2025-07-08T07:25:39.493258\"\n}"},{"id":"875ac4e1-c7c4-4ea1-8069-0f2baa49080f","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details/ai-eta?bl_nos=[BL No],[BL No],[BL No]&tracking_status=[Tracking Status]®ister_from=[Register From]®ister_to=[Register To]&active=[Active]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","details","ai-eta"],"query":[{"key":"bl_nos","value":"[BL No],[BL No],[BL No]","description":"List of Bill of Lading numbers (Master B/L)"},{"key":"tracking_status","value":"[Tracking Status]","description":"Tracking status filter (comma-separated)"},{"key":"register_from","value":"[Register From]","description":"Registration start date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration end date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"active","value":"[Active]","description":"Active status filter (default: true)"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"error_detail\": \"[page]: The value of the field must be greater than or equal to 1.\",\n\t\"transaction_time\": \"2025-03-20T05:42:27.123543\"\n}"},{"id":"abcef62c-4d45-402e-a7ee-6a09fe135439","name":"500 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/cargo-tracks/details/ai-eta?bl_nos=[BL No],[BL No],[BL No]&tracking_status=[Tracking Status]®ister_from=[Register From]®ister_to=[Register To]&active=[Active]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","cargo-tracks","details","ai-eta"],"query":[{"key":"bl_nos","value":"[BL No],[BL No],[BL No]","description":"List of Bill of Lading numbers (Master B/L)"},{"key":"tracking_status","value":"[Tracking Status]","description":"Tracking status filter (comma-separated)"},{"key":"register_from","value":"[Register From]","description":"Registration start date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration end date/time (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"active","value":"[Active]","description":"Active status filter (default: true)"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": 500,\n\t\"type\": \"Internal Server Error\",\n\t\"message\": \"Internal server error. Please try again in a few minutes.\"\n}"}],"_postman_id":"9ef74deb-d32b-4bad-b11e-2f07801d047c"},{"name":"2. Retrieve Container No. Tracking Details (AI ETA)","id":"cf4ba130-be0e-4e9f-8591-cb54ff3ce589","request":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/container-tracks/details/ai-eta?container_no=[Container No]®ister_from=[Register From]®ister_to=[Register To]&reference_no=[Reference No]&carrier_code=[Carrier Code]&page=[Page]&size=[Size]","description":"Retrieve detailed container tracking data and AI ETA prediction information for registered shipments.
\nThis API requires the Container No. Shipment Tracking API and can only be used for containers that have already been registered through Container Tracking.
\nTo retrieve AI ETA prediction data, replace the standard \"2. Retrieve Container No. Tracking Details\" API with this endpoint.
\nMaximum 50 tracking records can be retrieved per request.
\nOnly successfully registered container tracking entries can be queried.
\nDate and time fields in content follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssXXX.
Container number
\n","type":"text/plain"},"key":"container_no","value":"[Container No]"},{"description":{"content":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_from","value":"[Register From]"},{"description":{"content":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_to","value":"[Register To]"},{"description":{"content":"Reference number
\n","type":"text/plain"},"key":"reference_no","value":"[Reference No]"},{"description":{"content":"Carrier code
\n","type":"text/plain"},"key":"carrier_code","value":"[Carrier Code]"},{"description":{"content":"(required) Page number (minimum: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1-50)
\n","type":"text/plain"},"key":"size","value":"[Size]"},{"disabled":true,"description":{"content":"tracking status
\n","type":"text/plain"},"key":"status","value":""}],"variable":[]}},"response":[{"id":"254af9ee-e8d8-46c1-bc3b-cd8e6d217ca2","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/container-tracks/details/ai-eta?container_no=[Container No]®ister_from=[Register From]®ister_to=[Register To]&reference_no=[Reference No]&carrier_code=[Carrier Code]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","container-tracks","details","ai-eta"],"query":[{"key":"container_no","value":"[Container No]","description":"Container number"},{"key":"register_from","value":"[Register From]","description":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"reference_no","value":"[Reference No]","description":"Reference number"},{"key":"carrier_code","value":"[Carrier Code]","description":"Carrier code"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"},{"key":"status","value":"","description":"tracking status","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"container_no\": \"SAMPLE_CONTAINER_NO\",\n \"track_mst_id\": \"SAMPLE_TRACK_MST_ID\",\n \"pod\": {\n \"ata\": \"2025-07-09T05:32:47+09:00\",\n \"eta\": \"2025-07-09T05:32:47+09:00\",\n \"pod_code\": \"SAMPLE_POD_CODE\",\n \"pod_name\": \"SAMPLE_POD_NAME\",\n \"ai_eta\": {\n \"ai_eta\": \"2025-07-10T14:00:00+09:00\",\n \"ai_eta_p10\": \"2025-07-09T08:00:00+09:00\",\n \"ai_eta_p90\": \"2025-07-12T22:00:00+09:00\",\n \"ai_eta_confidence\": 72.50\n }\n },\n \"routes\": [\n {\n \"order\": 0,\n \"ai_eta\": {\n \"ai_eta\": \"2025-07-10T14:00:00+09:00\",\n \"ai_eta_p10\": \"2025-07-09T08:00:00+09:00\",\n \"ai_eta_p90\": \"2025-07-12T22:00:00+09:00\",\n \"ai_eta_confidence\": 72.50\n }\n }\n ],\n \"status\": \"SAMPLE_STATUS\"\n }\n ]\n}"}],"_postman_id":"cf4ba130-be0e-4e9f-8591-cb54ff3ce589"}],"id":"db7e5d57-6750-4df1-bbee-9b3f89cc4b78","description":"AI ETA provides AI-powered arrival predictions for shipments registered through the Shipment Tracking API.
\nUsing real-time vessel data and historical voyage patterns, AI ETA predicts vessel arrival times and provides multiple arrival scenarios instead of a single estimated arrival time.
\nAI ETA helps customers better prepare for operational uncertainty caused by vessel delays, port congestion, and schedule changes.
\nAI ETA provides three probability-based arrival scenarios rather than a single ETA.
\nAI ETA provides probability-based arrival predictions.
\nThe range between P10 and P90 represents an approximately 80% confidence interval, helping customers evaluate optimistic, expected, and conservative arrival scenarios.
\nAI ETA is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month) and requires the Shipment Tracking API.
\nTo enable this feature, an active Enterprise subscription is required.
\n\n","_postman_id":"db7e5d57-6750-4df1-bbee-9b3f89cc4b78"}],"id":"865220f4-761c-4c7a-b088-a9ba13788096","description":"Shipment Tracking APIs provide shipment visibility based on standard logistics identifiers such as Master B/L and Container Number.
\nTradlinx collects and normalizes shipment tracking data from multiple carriers, providing a consistent API response regardless of carrier-specific tracking systems and data formats.
\nAvailable APIs include Shipment Tracking, D&D Monitoring, AI ETA, and Shipment Webhook.
\nNot all identifiers used in day-to-day logistics operations are supported. Check the table below before designing your tracking workflow.
\nShipment Tracking APIs may provide the following data depending on carrier availability.
\n","_postman_id":"865220f4-761c-4c7a-b088-a9ba13788096"},{"name":"Webhook","item":[{"name":"B/L Tracking","item":[{"name":"1. Retrieve Webhook Event List","id":"7e20ab6e-0bd0-422a-9ecd-9b745664414e","request":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/webhook/events?page=[Page]&size=[Size]&status=[Status]","description":"Retrieves the webhook delivery history (including success/failure) for the client account.
\nThe retention period for event data is limited to one month, after which the data is deleted.
\n(required) Page number (min: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1~1000)
\n","type":"text/plain"},"key":"size","value":"[Size]"},{"description":{"content":"(required) Event status to retrieve: SUCCESS_RESPONSE, FAILURE_RESPONSE, DELIVERED, FAILURE_UNKNOWN_HOST, FAILURE_REQUEST_TIMEOUT, FAILURE_CONNECTION_REFUSED
\n","type":"text/plain"},"key":"status","value":"[Status]"}],"variable":[]}},"response":[{"id":"38f82b4b-d33b-4457-bbbc-2bb06fbeec77","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/webhook/events?page=[Page]&size=[Size]&status=[Status]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","webhook","events"],"query":[{"key":"page","value":"[Page]","description":"(required) Page number (min: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1~1000)"},{"key":"status","value":"[Status]","description":"(required) Event status to retrieve: SUCCESS_RESPONSE, FAILURE_RESPONSE, DELIVERED, FAILURE_UNKNOWN_HOST, FAILURE_REQUEST_TIMEOUT, FAILURE_CONNECTION_REFUSED"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": \"8f6c1c4b-0ae4-4f31-9df7-2a13d5e4bc11\",\n \"event_name\": \"SHIPMENT.BL.UPDATED\",\n \"status\": \"SUCCESS_RESPONSE\",\n \"payload\": \"{\\\"sample\\\": \\\"payload\\\"}\",\n \"payload_type\": \"REAL\",\n \"payload_version\": \"v1\",\n \"is_resendable\": true,\n \"occurred_datetime\": \"2025-12-10T14:22:11\",\n \"created_datetime\": \"2025-12-10T14:22:12\"\n },\n {\n \"id\": \"4c2a7512-9b5c-4bd1-bd0a-afb22d8c1120\",\n \"event_name\": \"SHIPMENT.BL.UPDATED\",\n \"status\": \"SUCCESS_RESPONSE\",\n \"payload\": \"{\\\"sample\\\": \\\"payload\\\"}\",\n \"payload_type\": \"REAL\",\n \"payload_version\": \"v1\",\n \"is_resendable\": false,\n \"occurred_datetime\": \"2025-12-10T14:20:02\",\n \"created_datetime\": \"2025-12-10T14:20:03\"\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"has_next\": false,\n \"total_page\": 10,\n \"total_size\": 10\n }\n}"}],"_postman_id":"7e20ab6e-0bd0-422a-9ecd-9b745664414e"},{"name":"2. Retrieve Webhook Event Log","id":"c482d6db-722b-4913-a6f5-2ff520b4dbbf","request":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/webhook/events/:event_id/log","description":"Retrieves all request attempt logs for a specific webhook event (HTTP status code, response body/headers, attempt time).
\nIf an event was retried multiple times, all attempts are returned as an array.
\nWebhook Event ID to retrieve
\n","type":"text/plain"},"type":"any","value":"","key":"event_id"}]}},"response":[{"id":"da9f5792-7b26-4d11-8183-9dea8ca5cc41","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/webhook/events/:event_id/log","host":["https://api.tradlinx.com"],"path":["partners","track","v3","webhook","events",":event_id","log"],"variable":[{"key":"event_id","value":"","description":"Webhook Event ID to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": 101,\n \"event_id\": \"8f6c1c4b-0ae4-4f31-9df7-2a13d5e4bc11\",\n \"request_cause\": \"SUCCESS\",\n \"request_method\": \"POST\",\n \"request_url\": \"https://api.example.com/webhook\",\n \"request_status\": \"SUCCESS\",\n \"request_datetime\": \"2025-12-10T14:10:20.123456\",\n \"response_http_status\": 200,\n \"response_body\": \"{\\\"result\\\":\\\"ok\\\"}\",\n \"response_header\": \"{\\\"Content-Type\\\":\\\"application/json\\\"}\",\n \"response_datetime\": \"2025-12-10T14:10:20.543210\",\n \"attempts\": 1\n },\n {\n \"id\": 102,\n \"event_id\": \"8f6c1c4b-0ae4-4f31-9df7-2a13d5e4bc11\",\n \"request_cause\": \"SUCCESS\",\n \"request_method\": \"POST\",\n \"request_url\": \"https://api.example.com/webhook\",\n \"request_status\": \"FAILED\",\n \"request_datetime\": \"2025-12-10T14:12:05.333222\",\n \"response_http_status\": 504,\n \"response_body\": \"\",\n \"response_header\": \"{\\\"Content-Type\\\":\\\"application/json\\\"}\",\n \"response_datetime\": \"2025-12-10T14:12:10.888999\",\n \"attempts\": 2\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"has_next\": false,\n \"total_page\": 10,\n \"total_size\": 10\n }\n}"}],"_postman_id":"c482d6db-722b-4913-a6f5-2ff520b4dbbf"},{"name":"3. Resend Webhook Event","id":"ad249d70-25b6-4402-836b-ca0afd503209","request":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/webhook/events/:event_id","description":"Force re-send (retry) a specific webhook event.
\nRetries are performed regardless of the event's existing status (SUCCESS/FAILURE, etc.).
\nThe retention period for event data is limited to one month. After this period, the data will be deleted, and deleted events cannot be resent.
\nWebhook Event ID to resend
\n","type":"text/plain"},"type":"any","value":"","key":"event_id"}]}},"response":[{"id":"f597dc28-683b-41af-8ba4-312a95d1e1c7","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/webhook/events/:event_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","webhook","events",":event_id"],"variable":[{"key":"event_id","value":"","description":"Webhook Event ID to resend"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"8022099e-b68a-480d-bace-40d471818b0a","name":"4xx Error","originalRequest":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/webhook/events/:event_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","webhook","events",":event_id"],"variable":[{"key":"event_id","value":"","description":"Webhook Event ID to resend"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"NOT_FOUND_ENDPOINT\",\n \"transaction_time\": \"2025-03-20T05:42:27.135265\"\n}"}],"_postman_id":"ad249d70-25b6-4402-836b-ca0afd503209"}],"id":"fe1e4b19-fd4a-486c-a2ff-27f46b391632","description":"B/L Tracking Webhook delivers real-time notifications whenever tracking data changes for registered B/L tracking entries.
\nWebhook events are sent to your registered HTTPS endpoint as HTTP POST requests with a JSON payload.
\nEach event contains an event object and a payload with the latest shipment tracking information.
\n{\n \"event_id\": \"31b1a972-677b-422c-a696-4228e3b5a8ff\",\n \"event_occurred_at\": \"2025-12-01T04:22:15.805606262\",\n \"event_name\": \"SHIPMENT.BL.UPDATED\",\n \"payload\": {}\n}\n\n{\n \"cargo_track_id\": \"3d8b1e76-8721-4e27-a98d-2bfb8193d4ee\",\n \"line_cd\": \"HMM\",\n \"bl_no\": \"HDMUPUSM12345678\",\n \"cust_order_id\": \"REFERENCE_NO\",\n \"cust_corp_name\": null,\n \"cust_name\": null,\n \"remark\": null,\n \"is_active\": true,\n \"registered_datetime\": \"2025-12-01T04:22:06.6305903Z\",\n \"tracking_status\": \"TRACKING\",\n \"is_container_plus\": true,\n \"trade_type\": \"EXPRT\",\n \"trans_type\": \"DIRECT\",\n \"pol\": {\n \"pol_name\": \"New Busan\",\n \"pol_code\": \"KRBNP\",\n \"init_etd\": \"2025-12-06T00:00:00+09:00\",\n \"etd\": \"2025-12-06T00:00:00+09:00\",\n \"atd\": null,\n \"tx_atd\": \"2025-12-06T00:00:00+09:00\"\n },\n \"pod\": {\n \"pod_name\": \"Manzanillo\",\n \"pod_code\": \"MXZLO\",\n \"init_eta\": \"2025-12-19T18:00:00-06:00\",\n \"eta\": \"2025-12-19T18:00:00-06:00\",\n \"ata\": null,\n \"tx_ata\": null\n },\n \"current_vessel\": {\n \"imo\": \"9976707\",\n \"mmsi\": \"563262300\",\n \"vessel_name\": \"ONE SAPPHIRE\",\n \"voyage\": \"2547E\"\n },\n \"routes\": [\n {\n \"order\": 1,\n \"pol_name\": \"New Busan\",\n \"pol_code\": \"KRBNP\",\n \"pod_name\": \"Manzanillo\",\n \"pod_code\": \"MXZLO\",\n \"imo\": \"9976707\",\n \"mmsi\": \"563262300\",\n \"vessel_name\": \"ONE SAPPHIRE\",\n \"voyage\": \"2547E\",\n \"init_etd\": \"2025-12-06T00:00:00+09:00\",\n \"etd\": \"2025-12-06T00:00:00+09:00\",\n \"atd\": null,\n \"tx_atd\": \"2025-12-06T00:00:00+09:00\",\n \"init_eta\": \"2025-12-19T18:00:00-06:00\",\n \"eta\": \"2025-12-19T18:00:00-06:00\",\n \"ata\": null,\n \"tx_ata\": null\n }\n ],\n \"containers\": [\n {\n \"cntr_no\": \"CAIU7471046\",\n \"cntr_sz\": \"40\",\n \"cntr_tp\": \"DC\",\n \"container_events\": [\n {\n \"port_code\": \"KRPUS\",\n \"event_type\": \"LOADING_ON_VESSEL\",\n \"transportation\": \"VESSEL\",\n \"is_actual\": true,\n \"event_datetime\": \"2025-12-05T16:45:00+09:00\"\n },\n {\n \"port_code\": \"KRPUS\",\n \"event_type\": \"VESSEL_DEPARTURE_FROM_PORT\",\n \"transportation\": \"VESSEL\",\n \"is_actual\": true,\n \"event_datetime\": \"2025-12-06T00:00:00+09:00\"\n },\n {\n \"port_code\": \"MXZLO\",\n \"event_type\": \"VESSEL_ARRIVAL_AT_PORT\",\n \"transportation\": \"VESSEL\",\n \"isActual\": false,\n \"event_datetime\": \"2025-12-19T17:00:00-06:00\"\n },\n {\n \"port_code\": \"MXZLO\",\n \"event_type\": \"VESSEL_BERTHING_ON_PORT\",\n \"transportation\": \"VESSEL\",\n \"isActual\": false,\n \"event_datetime\": \"2025-12-19T18:00:00-06:00\"\n },\n {\n \"port_code\": \"MXZLO\",\n \"event_type\": \"DISCHARGING_FROM_VESSEL\",\n \"transportation\": \"VESSEL\",\n \"isActual\": false,\n \"event_datetime\": \"2025-12-20T11:02:24-06:00\"\n }\n ]\n }\n ]\n}\n\ncontainers[].containerEvents[*]
\nTo receive webhook events, you must operate an HTTPS endpoint capable of receiving webhook requests.
\nRegister and test your endpoint by following the steps below.
\nTRADLINX Webhook is delivered as a JSON payload.
\nTherefore, you must implement an HTTPS endpoint that can handle webhook requests.
\nThe endpoint host supports HTTPS protocol only.
\nImplement an endpoint that allows the event you want to subscribe to and the HTTP method (GET, POST, etc.) supported by that event.
\nThe request body is a JSON payload.
\nAfter receiving the payload, your endpoint must return an HTTP status of 2xx (200, 201, etc.) to be recorded as successfully received.
\nProcess the payload as quickly as possible.
\nIf the volume of webhook deliveries surges, the endpoint host may be overloaded.
\nIf the response waiting time exceeds 10 seconds and repeats 3 or more times, it may be switched to an inactive state.
\nParse the received JSON payload
\nExtract key fields such as `event_id`, `event_name`, `event_occurred_at`, `payload.cargo_track_id`, etc.
\nRecord receipt success/failure in a monitoring system
\nCurrently, webhook endpoints are managed directly by Tradlinx.
\nPlease send the following information to [tech.support@tradlinx.com]
\n**`Submission Items`**\n\nOnce webhook endpoint registration is completed, a test mock event is automatically generated.
\nUsing the API below, you can view the list of webhook events provided by TRADLINX or manually publish the mock event to the endpoint by re-sending it directly.
\nUse the mock event re-send feature to test whether your webhook endpoint works properly.
\nTo receive webhooks properly, you must register the shipments to be tracked via the API or SaaS (OceanVisibility).
\nWebhooks are sent for shipments among registered tracking targets when a progress status change or shipment status change occurs.
\nWhen receiving a webhook event, process the data by referring to the guide below.
\nStore the `cargo_track_id` returned when registering a shipment.
\nThe identifier of the shipment data contained in the event payload that is updated when an event occurs is the `cargo_track_id` returned at registration.
\nSave or update data based on `cargo_track_id`.
\nIf `cargo_track_id` does not exist in storage, save it as a new shipment record.
\nIf `cargo_track_id` exists in storage, find newer data based on `event_occurred_at` and update it.
\nIf the webhook endpoint fails to receive an event, TRADLINX performs up to 3 automatic retries using an exponential backoff strategy after an initial 2-second delay.
\nIf the event is still not received despite automatic retries, the user can check failed events via the Event List Retrieval API provided in the API documentation.
\nIf you want to receive a specific event again, call the Webhook Event Resend API using the event_id obtained from the list to immediately receive that event again.
\nDepending on network conditions or retry policies,
\nthe webhook endpoint may receive the same event multiple times.
\nSince TRADLINX re-sends with the same `event_id` during retries,
\nthe receiving (client) endpoint must implement logic to prevent duplicate event processing.
\nDeduplication Rules
\nWhen receiving an event, record whether the event has already been processed based on `event_id`.
\nIf the same `event_id` is received again, it is a retried event, so check `occurred_datetime` to determine whether it is the latest event.
\nIf processing has already been completed for the same `event_id`, it must be ignored without re-running business logic.
\nRecommended Approach
\nRecord a “processed” status in a database, Redis, or other storage based on `event_id`.
\nIf a re-received event exists, ignore it immediately or only log it.
\nIMO No, MMSI, Call Sign, Vessel Name
\n","type":"text/plain"},"key":"keyword","value":"[Keyword]"}],"variable":[]}},"response":[{"id":"060fe0e5-2d53-47a5-be4d-bcb0752f9b1a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/search?keyword=[Keyword]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","vessel-tracks","search"],"query":[{"key":"keyword","value":"[Keyword]","description":"IMO No, MMSI, Call Sign, Vessel Name"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"call_sign\": \"SAMPLE_CALL_SIGN\",\n \"imo_no\": \"SAMPLE_IMO_NO\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"vessel_id\": 1,\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\"\n }\n ],\n \"size\": 1,\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2025-08-21T06:15:46.608323\"\n}"}],"_postman_id":"096467d8-970e-4e59-b785-8483b21093e7"},{"name":"2. Vessel Tracking Request","id":"e52318fd-409f-4472-aa9f-7415d59f8cec","request":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"auto_renewal\": true,\n \"remark\": \"SAMPLE_REMARK\",\n \"track_group\": \"SAMPLE_TRACK_GROUP\",\n \"vessel_id\": 1\n }","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/enroll","description":"Register a vessel for tracking.
\nOnly one vessel can be registered per request.
\nA vessel cannot be registered more than once while an active tracking record exists.
\nExpired tracking records can be registered again by submitting a new tracking request.
\nTracking records remain active for one month.
\nIf auto_renewal is enabled, the tracking period is automatically extended by one month before expiration, and the corresponding credits are deducted.
\nTRACKING, DELETED, EXPIRED, PENDING
\n","type":"text/plain"},"key":"status","value":"[Status]"},{"description":{"content":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_from","value":"[Register From]"},{"description":{"content":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"register_to","value":"[Register To]"},{"description":{"content":"IMO No, MMSI, Call Sign, Vessel Name
\n","type":"text/plain"},"key":"keyword","value":"[Keyword]"},{"description":{"content":"Unique ID of the tracking record obtained via vessel tracking inquiry list (maximum: 50)
\n","type":"text/plain"},"key":"vessel_track_ids","value":"[Vessel Track ID],[Vessel Track ID]"},{"description":{"content":"(required) Page number (minimum: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1-50)
\n","type":"text/plain"},"key":"size","value":"[Size]"}],"variable":[]}},"response":[{"id":"c272eb16-3ed4-4063-a6e1-e1bed81a7019","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/vessel-tracks?status=[Status]®ister_from=[Register From]®ister_to=[Register To]&keyword=[Keyword]&vessel_track_ids=[Vessel Track ID],[Vessel Track ID]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","vessel-tracks"],"query":[{"key":"status","value":"[Status]","description":"TRACKING, DELETED, EXPIRED, PENDING"},{"key":"register_from","value":"[Register From]","description":"Registration Start Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"register_to","value":"[Register To]","description":"Registration End Date (ISO 8601 date/time format: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"keyword","value":"[Keyword]","description":"IMO No, MMSI, Call Sign, Vessel Name"},{"key":"vessel_track_ids","value":"[Vessel Track ID],[Vessel Track ID]","description":"Unique ID of the tracking record obtained via vessel tracking inquiry list (maximum: 50)"},{"key":"page","value":"[Page]","description":"(required) Page number (minimum: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1-50)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"expired_datetime\": \"2025-08-21T07:45:24Z\",\n \"registered_datetime\": \"2025-08-21T07:45:24Z\",\n \"remark\": \"SAMPLE_REMARK\",\n \"status\": \"TRACKING\",\n \"track_group\": \"SAMPLE_TRACK_GROUP\",\n \"updated_datetime\": \"2025-08-21T07:45:24Z\",\n \"vessel\": {\n \"call_sign\": \"SAMPLE_CALL_SIGN\",\n \"imo_no\": \"SAMPLE_IMO_NO\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"vessel_id\": 1\n },\n \"vessel_track_id\": 1\n }\n ],\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"pagination\": {\n \"current_page\": 1,\n \"has_next\": false,\n \"total_page\": 1,\n \"total_size\": 1\n },\n \"size\": 1,\n \"transaction_time\": \"2025-08-21T07:45:24.608323\"\n}"}],"_postman_id":"2d910ba0-8559-481f-9183-8f02f470c616"},{"name":"4. Retrieve Vessel Tracking Details","id":"854f7a9b-de09-4bd7-a079-54872e778e2f","request":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id","description":"Retrieve detailed vessel schedules and movement information for a tracked vessel.
\nDetailed tracking information is available only for records with a status of TRACKING.
Unique ID of the tracking record obtained via vessel tracking inquiry
\n","type":"text/plain"},"type":"any","value":"","key":"vessel_track_id"}]}},"response":[{"id":"8609b08f-7a1a-4b98-9a7e-7eeaa046dd5c","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","vessel-tracks",":vessel_track_id"],"variable":[{"key":"vessel_track_id","value":"","description":"Unique ID of the tracking record obtained via vessel tracking inquiry"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"expired_datetime\": \"2025-08-21T07:45:24Z\",\n \"registered_datetime\": \"2025-08-21T07:45:24Z\",\n \"remark\": \"SAMPLE_REMARK\",\n \"status\": \"TRACKING\",\n \"track_group\": \"SAMPLE_TRACK_GROUP\",\n \"updated_datetime\": \"2025-08-21T07:45:24Z\",\n \"vessel\": {\n \"call_sign\": \"SAMPLE_CALL_SIGN\",\n \"imo_no\": \"SAMPLE_IMO_NO\",\n \"mmsi\": \"SAMPLE_MMSI\",\n \"vessel_name\": \"SAMPLE_VESSEL_NAME\",\n \"vessel_id\": 1\n },\n \"port_in_out_schedules\": [\n {\n \"arrival_datetime\": \"2025-01-01T00:00:00+09:00\",\n \"data_source\": \"PORT_CALL\",\n \"departure_datetime\": \"2025-01-01T00:00:00+09:00\",\n \"is_actual\": true,\n \"port_name\": \"SAMPLE_PORT_NAME\"\n }\n ],\n \"vessel_track_id\": 1\n }\n ],\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2025-08-21T07:45:24.608323\"\n}"}],"_postman_id":"854f7a9b-de09-4bd7-a079-54872e778e2f"},{"name":"5. Vessel Tracking Update Request","id":"42752d94-8250-4d18-bb7c-8f6f175bd0c8","request":{"method":"PATCH","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"remark\": \"SAMPLE_REMARK\",\n \"track_group\": \"SAMPLE_TRACK_GROUP\"\n }","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id","description":"Update an existing vessel tracking record.
\nOnly the following fields can be updated: remark and track_group.
\nUnique ID of the tracking record obtained via vessel tracking inquiry
\n","type":"text/plain"},"type":"any","value":"","key":"vessel_track_id"}]}},"response":[{"id":"0a8ebe2e-3ae7-43db-8d6f-7729b13fefef","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"remark\": \"SAMPLE_REMARK\",\n \"track_group\": \"SAMPLE_TRACK_GROUP\"\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","vessel-tracks",":vessel_track_id"],"variable":[{"key":"vessel_track_id","value":"","description":"Unique ID of the tracking record obtained via vessel tracking inquiry"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": {\n \"vessel_id\": 1,\n \"vessel_track_id\": 1\n },\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2025-08-21T06:37:36.608323\"\n}"}],"_postman_id":"42752d94-8250-4d18-bb7c-8f6f175bd0c8"},{"name":"6. Vessel Tracking Auto Renewal Update Request","id":"e50d0d2e-57c6-4695-b184-bb8079930331","request":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"auto_renewal\": true\n }","options":{"raw":{"language":"json"}}},"url":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id/auto-renewal","description":"Enable or disable automatic renewal for a vessel tracking record.
\nauto_renewal can only be updated for active tracking records.
Unique ID of the tracking record obtained via vessel tracking inquiry
\n","type":"text/plain"},"type":"any","value":"","key":"vessel_track_id"}]}},"response":[{"id":"1a2f9f2c-d7c6-4658-9db2-a2cebbd84f6a","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"auto_renewal\": true\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id/auto-renewal","host":["https://api.tradlinx.com"],"path":["partners","track","v3","vessel-tracks",":vessel_track_id","auto-renewal"],"variable":[{"key":"vessel_track_id","value":"","description":"Unique ID of the tracking record obtained via vessel tracking inquiry"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e50d0d2e-57c6-4695-b184-bb8079930331"},{"name":"7. Vessel Tracking Cancellation Request","id":"de2238e0-7cf7-4a1a-b173-b74fb5838f93","request":{"method":"DELETE","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id","description":"Cancel a vessel tracking record.
\nCancellation requests can only be made one at a time.
\nCredits are not refunded for tracking records in TRACKING or EXPIRED status.
Unique ID of the tracking record obtained via vessel tracking inquiry
\n","type":"text/plain"},"type":"any","value":"","key":"vessel_track_id"}]}},"response":[{"id":"5272218b-ae28-47a9-87e6-23c4a46c395b","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/vessel-tracks/:vessel_track_id","host":["https://api.tradlinx.com"],"path":["partners","track","v3","vessel-tracks",":vessel_track_id"],"variable":[{"key":"vessel_track_id","value":"","description":"Unique ID of the tracking record obtained via vessel tracking inquiry"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"de2238e0-7cf7-4a1a-b173-b74fb5838f93"}],"id":"14758237-dca4-423a-a237-eaffaaead7e9","description":"Tradlinx supports shipment tracking by B/L, Container, and Vessel. This page covers Vessel Tracking only.
\nVessel Tracking provides real-time vessel movement data, including vessel positions, port arrivals, departures, and voyage information.
\nSearch by vessel name, IMO, MMSI, or call sign to retrieve vessel tracking data through the API.
\nThe Vessel Tracking API is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month).
\nTo enable this API, an active Enterprise subscription is required.
\n\n","_postman_id":"14758237-dca4-423a-a237-eaffaaead7e9"},{"name":"Embedded MapView","item":[{"name":"B/L","item":[{"name":"1. Issue JSON Web Token","id":"75bb2e0c-b266-4af2-b102-a39653481272","request":{"method":"POST","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""}],"url":"https://api.tradlinx.com/partners/auth/authenticate","description":"Issue a JSON Web Token (JWT) used to authenticate requests to Embedded MapView.
\n⚠️
\nClient ID and API Key are sensitive credentials and must be stored securely on the server side.
\nNever expose them to browsers or other public clients.
\n","urlObject":{"path":["partners","auth","authenticate"],"host":["https://api.tradlinx.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"75bb2e0c-b266-4af2-b102-a39653481272"},{"name":"2. Load Embedded MapView (Form POST)","id":"e9a85ea8-2fae-4f18-a28c-b3edb692a2e7","request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"authorization","value":"","description":"(required) Authorization key (JWT issued via /partners/auth/authenticate)
\n"},{"key":"searchType","value":"blNo","description":"\"blNo\" | \"po\" | \"trackMstId\" | \"customerCompany\" — Type of search query (default \"blNo\")
\n"},{"key":"searchValue","value":"SAMPLE_BL_NO","description":"Value to search for
\n"},{"key":"lang","value":"en","description":"\"ko\" | \"en\" — Language selection (default \"ko\")
\n"},{"key":"detail","value":"SHOW_ALL","description":"(required) \"SHOW_ALL\" | \"HIDE_TABS\" | \"HIDE_ALL\" — Method of displaying shipment details
\n"},{"key":"companyFilter","value":"true","description":"Whether to apply the customer filter (default true)
\n"},{"key":"startMode","value":"LIST","description":"\"LIST\" | \"HIDE_LIST\" | \"DETAIL\" — Initial state of the map view
\n"}]},"url":"https://app.tradlinx.com/partner-mapview/api/shipment","description":"Request the B/L Tracking Embedded MapView page.
\nSubmit the request as application/x-www-form-urlencoded form data. The response returns a rendered MapView page that can be displayed directly in an iframe.
\nIf the shipment is transported on a bulk carrier, the vessel is displayed with a \"Bulk\" icon in MapView.
\nB/L Tracking Embedded MapView allows you to embed Tradlinx Ocean Visibility map views directly into your own applications.
\nUsing shipment tracking data, users can visualize container movements, vessel positions, routes, and shipment status without building a separate map interface.
\nB/L Tracking Embedded MapView is supported in any environment capable of rendering web content and iframes.
\nRecommended Dimensions
\nFull View (Map + Shipment List): 1440 × 900
\nMap Only: 800 × 600
\nThe Container Tracking Embedded MapView API is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month).
\nTo enable this API, an active Enterprise subscription is required.
\n\nAuthentication must be handled through a backend middleware service implemented by the API user.
\nClient ID and API Key credentials must never be exposed directly to the browser.
\n![\"mapview_flow\"](\"https://static-cdn.tradlinx.com/images/ov/mapview_250602.png\")
\n\nBrowser requests a JWT token from the middleware.
\nMiddleware requests a JWT token from Ocean Visibility API.
\nOcean Visibility API returns the JWT token.
\nMiddleware returns the JWT token to the browser.
\nBrowser requests the Embedded MapView using the JWT token.
\nOcean Visibility MapView Server returns the MapView.
\nA sample code snippet is provided for quick testing.
\nYou may implement the integration differently as long as it follows the required request specification.
\nThe code below is for reference only.
\n<html> \n <head> \n <title>TRADLINX Ocean Visibility B/L Embedded MapView TEST</title> \n </head> \n <body> \n <form action=\"https://app.tradlinx.com/partner-mapview/api/shipment\" name=\"viewer_form\" id=\"viewer_form\" target=\"viewer\" method=\"post\"> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"oceanVisibilityMap\"> \n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Input area start --> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Shipment Details</div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <input type=\"radio\" name=\"fold\" value=\"false\" id=\"foldFalse\" checked /> \n <label for=\"foldFalse\">View details</label> \n <input type=\"radio\" name=\"fold\" value=\"true\" id=\"foldTrue\" /> \n <label for=\"foldTrue\">View summary</label> \n </div> \n </div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Language</div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <input type=\"radio\" name=\"lang\" value=\"ko\" id=\"langKo\" checked /> \n <label for=\"langKo\">Korean</label> \n <input type=\"radio\" name=\"lang\" value=\"en\" id=\"langEn\" /> \n <label for=\"langEn\">English</label> \n </div> \n </div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Customer Filter</div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <input type=\"radio\" name=\"companyFilter\" value=\"true\" id=\"companyFilterOn\" checked /> \n <label for=\"companyFilterOn\">Show filter</label> \n <input type=\"radio\" name=\"companyFilter\" value=\"false\" id=\"companyFilterOff\" /> \n <label for=\"companyFilterOff\">Hide filter</label> \n </div> \n </div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Initial View</div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <input type=\"radio\" name=\"startMode\" value=\"LIST\" id=\"startModeList\" checked /> \n <label for=\"startModeList\">Show shipment list</label> \n <input type=\"radio\" name=\"startMode\" value=\"HIDE_LIST\" id=\"startModeHideList\" /> \n <label for=\"startModeHideList\">Hide shipment list</label> \n <input type=\"radio\" name=\"startMode\" value=\"DETAIL\" id=\"startModeDetail\" /> \n <label for=\"startModeDetail\">View first shipment details</label> \n </div> \n </div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Controller Options</div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <input type=\"checkbox\" name=\"controllers\" value=\"FULL_SCREEN\" id=\"controllersFullScreen\" checked /> \n <label for=\"controllersFullScreen\">Full screen</label> \n <input type=\"checkbox\" name=\"controllers\" value=\"DIMENSION\" id=\"controllersDimension\" /> \n <label for=\"controllersDimension\">2D / 3D toggle</label> \n <input type=\"checkbox\" name=\"controllers\" value=\"LANG_SET\" id=\"controllersLangSet\" /> \n <label for=\"controllersLangSet\">Language toggle</label> \n </div> \n </div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Tabs in Shipment Details</div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <input type=\"checkbox\" name=\"detailTabs\" value=\"SHIPMENT_ROUTE\" id=\"detailTabsShipmentRoute\" checked /> \n <label for=\"detailTabsShipmentRoute\">Details tab</label> \n <input type=\"checkbox\" name=\"detailTabs\" value=\"PORT_CALLS\" id=\"detailTabsPortCalls\" /> \n <label for=\"detailTabsPortCalls\">Route tab</label> \n <input type=\"checkbox\" name=\"detailTabs\" value=\"SAIL_LOG\" id=\"detailTabsSailLog\" /> \n <label for=\"detailTabsSailLog\">Route log tab</label> \n </div> \n </div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Search</div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <select name=\"searchType\" id=\"selectType\"> \n <option value=\"blNo\">B/L</option> \n <option value=\"po\">PO</option> \n <option value=\"trackMstId\">ID</option> \n <option value=\"customerCompany\">Customer</option> \n </select> \n <input type=\"text\" name=\"searchValue\" id=\"keyword\" /> \n </div> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> \n <button type=\"submit\" id=\"button_map\">Search</button> \n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> End of input area --> \n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Map view area start --> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"frame\"> \n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> style=\"border: 1px solid black; height: 700px; width: 100%\" 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> allowfullscreen 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> name=\"viewer\" 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> > 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </iframe> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </div> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> <comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;> End of map view area </comment> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </div> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </div> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </div> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </form> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </body> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> <script> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> window.addEventListener(\"DOMContentLoaded\", () => { 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> // Create <input type="hidden" /> with the token received from middleware 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> fetch(\"{ Auth token endpoint }\") 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> .then((item) => item.text()) 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> .then((authToken) => { 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> const input = document.createElement(\"input\"); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> input.setAttribute(\"type\", \"hidden\"); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> input.setAttribute(\"name\", \"authorization\"); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> input.setAttribute(\"value\", authToken); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> const form = document.getElementById(\"viewer_form\"); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> form.appendChild(input); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> }); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> }); 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> </script> 
</div><div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'></html> 
</div></code></pre><p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' ><strong class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' >MapView Example</b></p><p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' ><img class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' src=https://static-cdn.tradlinx.com/images/ov/mapview_example_250724.png alt=\"mapview_sample\" /></p><p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' ></p></x-turndown></code></p><p class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' ></p></x-turndown>\n\nIssue a JSON Web Token (JWT) used to authenticate requests to Embedded MapView.
\n⚠️
\nClient ID and API Key are sensitive credentials and must be stored securely on the server side.
\nNever expose them to browsers or other public clients.
\n","urlObject":{"path":["partners","auth","authenticate"],"host":["https://api.tradlinx.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c64b4cb-a66a-49c8-b146-bf4df5134404"},{"name":"2. Load Embedded MapView (Form POST)","id":"a5d9ad47-7ff4-44ef-971b-0fab39f0e3f6","request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"authorization","value":"","description":"(required) Authorization key (JWT issued via /partners/auth/authenticate)
\n"},{"key":"searchType","value":"containerNo","description":"\"containerNo\" | \"po\" | \"trackMstId\" | \"customerCompany\" — Type of search query (default \"containerNo\")
\n"},{"key":"searchValue","value":"SAMPLE_CNTR_NO","description":"Value to search for
\n"},{"key":"lang","value":"en","description":"\"ko\" | \"en\" — Language selection (default \"ko\")
\n"},{"key":"detail","value":"SHOW_ALL","description":"(required) \"SHOW_ALL\" | \"HIDE_TABS\" | \"HIDE_ALL\" — Method of displaying shipment details
\n"},{"key":"companyFilter","value":"true","description":"Whether to apply the customer filter (default true)
\n"},{"key":"startMode","value":"LIST","description":"\"LIST\" | \"HIDE_LIST\" | \"DETAIL\" — Initial state of the map view
\n"}]},"url":"https://app.tradlinx.com/partner-mapview/api/container","description":"Request the Container Number Tracking Embedded MapView page.
\nSubmit the request as application/x-www-form-urlencoded form data. The response returns a rendered MapView page that can be displayed directly in an iframe.
\nContainer Tracking Embedded MapView allows you to embed Tradlinx Ocean Visibility map views directly into your own applications.
\nUsing shipment tracking data, users can visualize container movements, vessel positions, routes, and shipment status without building a separate map interface.
\nContainer Tracking Embedded MapView is supported in any environment capable of rendering web content and iframes.
\nRecommended Dimensions
\nFull View (Map + Shipment List): 1440 × 900
\nMap Only: 800 × 600
\nThe Container Tracking Embedded MapView API is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month).
\nTo enable this API, an active Enterprise subscription is required.
\n\nAuthentication must be handled through a backend middleware service implemented by the API user.
\nClient ID and API Key credentials must never be exposed directly to the browser.
\n\n\nBrowser requests a JWT token from the middleware.
\nMiddleware requests a JWT token from Ocean Visibility API.
\nOcean Visibility API returns the JWT token.
\nMiddleware returns the JWT token to the browser.
\nBrowser requests the Embedded MapView using the JWT token.
\nOcean Visibility MapView Server returns the MapView.
\nA sample code snippet is provided for quick testing.
\nYou may implement the integration differently as long as it follows the required request specification.
\nThe code below is for reference only.
\n%3C!DOCTYPE%20html%3E\n<html>\n <head>\n <title>TRADLINX Ocean Visibility Container Embedded MapView TEST</title>\n </head>\n <body>\n <form action=\"https://app.tradlinx.com/partner-mapview/api/container\" name=\"viewer_form\" id=\"viewer_form\" target=\"viewer\" method=\"post\">\n <input type=\"hidden\" name=\"authorization\" value=\"{{ Insert your Authorization Token here }}\" />\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"oceanVisibilityMap\">\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Input area start -->\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Shipment Details</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"fold\" value=\"false\" id=\"foldFalse\" checked />\n <label for=\"foldFalse\">View details</label>\n <input type=\"radio\" name=\"fold\" value=\"true\" id=\"foldTrue\" />\n <label for=\"foldTrue\">View summary</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Language</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"lang\" value=\"en\" id=\"langEn\" checked />\n <label for=\"langEn\">English</label>\n <input type=\"radio\" name=\"lang\" value=\"ko\" id=\"langKo\" />\n <label for=\"langKo\">Korean</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Customer Filter</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"companyFilter\" value=\"true\" id=\"companyFilterOn\" checked />\n <label for=\"companyFilterOn\">Show filter</label>\n <input type=\"radio\" name=\"companyFilter\" value=\"false\" id=\"companyFilterOff\" />\n <label for=\"companyFilterOff\">Hide filter</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Initial View</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"startMode\" value=\"LIST\" id=\"startModeList\" checked />\n <label for=\"startModeList\">Show shipment list</label>\n <input type=\"radio\" name=\"startMode\" value=\"HIDE_LIST\" id=\"startModeHideList\" />\n <label for=\"startModeHideList\">Hide shipment list</label>\n <input type=\"radio\" name=\"startMode\" value=\"DETAIL\" id=\"startModeDetail\" />\n <label for=\"startModeDetail\">View first shipment details</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Controller Options</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"checkbox\" name=\"controllers\" value=\"FULL_SCREEN\" id=\"controllersFullScreen\" checked />\n <label for=\"controllersFullScreen\">Full screen</label>\n <input type=\"checkbox\" name=\"controllers\" value=\"DIMENSION\" id=\"controllersDimension\" />\n <label for=\"controllersDimension\">2D / 3D toggle</label>\n <input type=\"checkbox\" name=\"controllers\" value=\"LANG_SET\" id=\"controllersLangSet\" />\n <label for=\"controllersLangSet\">Language toggle</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Tabs in Shipment Details</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"checkbox\" name=\"detailTabs\" value=\"SHIPMENT_ROUTE\" id=\"detailTabsShipmentRoute\" checked />\n <label for=\"detailTabsShipmentRoute\">Details tab</label>\n <input type=\"checkbox\" name=\"detailTabs\" value=\"PORT_CALLS\" id=\"detailTabsPortCalls\" />\n <label for=\"detailTabsPortCalls\">Route tab</label>\n <input type=\"checkbox\" name=\"detailTabs\" value=\"SAIL_LOG\" id=\"detailTabsSailLog\" />\n <label for=\"detailTabsSailLog\">Route log tab</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>Search</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <select name=\"searchType\" id=\"selectType\">\n <option value=\"containerNo\">Container No</option>\n <option value=\"po\">PO</option>\n <option value=\"trackMstId\">ID</option>\n <option value=\"customerCompany\">Customer</option>\n </select>\n <input type=\"text\" name=\"searchValue\" id=\"keyword\" />\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <button type=\"submit\" id=\"button_map\">Search</button>\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> End of input area -->\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Map view area start -->\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"frame\">\n <iframe style=\"border: 1px solid black; height: 700px; width: 100%\" allowfullscreen name=\"viewer\"> </iframe>\n </div>\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> End of map view area -->\n </div>\n </div>\n </div>\n </form>\n </body>\n</html>\n\nIssue a JSON Web Token (JWT) used to authenticate requests to Embedded MapView.
\n⚠️
\nClient ID and API Key are sensitive credentials and must be stored securely on the server side.
\nNever expose them to browsers or other public clients.
\n","urlObject":{"path":["partners","auth","authenticate"],"host":["https://api.tradlinx.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a1e3a170-ebff-4502-a19d-004921a9634b"},{"name":"2. Load Embedded MapView (Form POST)","id":"bc260e93-ba6a-45b0-90e8-e222c04512e2","request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"authorization","value":"","description":"(required) Authorization key (JWT issued via /partners/auth/authenticate)
\n"},{"key":"searchType","value":"keyword","description":"\"keyword\" | \"trackGroup\" — Type of search query (default \"keyword\")
\n"},{"key":"searchValue","value":"SAMPLE_VESSEL_NAME","description":"Value to search for
\n"},{"key":"lang","value":"en","description":"\"ko\" | \"en\" — Language selection (default \"ko\")
\n"},{"key":"detail","value":"SHOW_ALL","description":"(required) \"SHOW_ALL\" | \"HIDE_TABS\" | \"HIDE_ALL\" — Method of displaying vessel details
\n"},{"key":"trackGroupFilter","value":"true","description":"Whether to apply the vessel group filter (default true)
\n"},{"key":"startMode","value":"LIST","description":"\"LIST\" | \"HIDE_LIST\" | \"DETAIL\" — Initial state of the map view
\n"}]},"url":"https://app.tradlinx.com/partner-mapview/api/vessel","description":"Request the Vessel Tracking Embedded MapView page.
\nSubmit the request as application/x-www-form-urlencoded form data. The response returns a rendered MapView page that can be displayed directly in an iframe.
\nVessel Tracking Embedded MapView allows you to embed Tradlinx Ocean Visibility map views directly into your own applications.
\nUsing shipment tracking data, users can visualize container movements, vessel positions, routes, and shipment status without building a separate map interface.
\nVessel Tracking Embedded MapView is supported in any environment capable of rendering web content and iframes.
\nRecommended Dimensions
\nFull View (Map + Shipment List): 1440 × 900
\nMap Only: 800 × 600
\nThe Vessel Tracking Embedded MapView API is available exclusively to customers on the Ocean Visibility Enterprise Plan (100+ shipments/month).
\nTo enable this API, an active Enterprise subscription is required.
\n\n![](\"https://static-cdn.tradlinx.com/images/ov/vessel_mapview_example_250905.png\")
\n\nAuthentication must be handled through a backend middleware service implemented by the API user.
\nClient ID and API Key credentials must never be exposed directly to the browser.
\n\n\nBrowser requests a JWT token from the middleware.
\nMiddleware requests a JWT token from Ocean Visibility API.
\nOcean Visibility API returns the JWT token.
\nMiddleware returns the JWT token to the browser.
\nBrowser requests the Embedded MapView using the JWT token.
\nOcean Visibility MapView Server returns the MapView.
\nA sample code snippet is provided for quick testing.
\nYou may implement the integration differently as long as it follows the required request specification.
\nThe code below is for reference only.
\n\n<html>\n <head>\n <title>TRADLINX Ocean Visibility Vessel Embedded MapView TEST</title>\n </head>\n <body>\n <form action=\"https://app.tradlinx.com/partner-mapview/api/vessel\" name=\"viewer_form\" id=\"viewer_form\" target=\"viewer\" method=\"post\">\n <div class='preserveHtml' class='preserveHtml' id=\"oceanVisibilityMap\">\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml'> Input area start -->\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>Vessel Details</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"detail\" value=\"SHOW_ALL\" id=\"detailShowAll\" checked />\n <label for=\"detailShowAll\">View All</label>\n <input type=\"radio\" name=\"detail\" value=\"HIDE_TABS\" id=\"detailHideTabs\" />\n <label for=\"detailHideTabs\">View Summary</label>\n <input type=\"radio\" name=\"detail\" value=\"HIDE_ALL\" id=\"detailHideAll\" />\n <label for=\"detailHideAll\">Hide All</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>Language</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"lang\" value=\"ko\" id=\"langKo\" checked />\n <label for=\"langKo\">Korean</label>\n <input type=\"radio\" name=\"lang\" value=\"en\" id=\"langEn\" />\n <label for=\"langEn\">English</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>Vessel Group Filter</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"trackGroupFilter\" value=\"true\" id=\"trackGroupFilterOn\" checked />\n <label for=\"trackGroupFilterOn\">Show filter</label>\n <input type=\"radio\" name=\"trackGroupFilter\" value=\"false\" id=\"trackGroupFilterOff\" />\n <label for=\"trackGroupFilterOff\">Hide filter</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>Initial View</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"radio\" name=\"startMode\" value=\"LIST\" id=\"startModeList\" checked />\n <label for=\"startModeList\">Show vessel list</label>\n <input type=\"radio\" name=\"startMode\" value=\"HIDE_LIST\" id=\"startModeHideList\" />\n <label for=\"startModeHideList\">Hide vessel list</label>\n <input type=\"radio\" name=\"startMode\" value=\"DETAIL\" id=\"startModeDetail\" />\n <label for=\"startModeDetail\">View first vessel details</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>Controller Options</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"checkbox\" name=\"controllers\" value=\"FULL_SCREEN\" id=\"controllersFullScreen\" checked />\n <label for=\"controllersFullScreen\">Full screen</label>\n <input type=\"checkbox\" name=\"controllers\" value=\"DIMENSION\" id=\"controllersDimension\" />\n <label for=\"controllersDimension\">2D / 3D toggle</label>\n <input type=\"checkbox\" name=\"controllers\" value=\"LANG_SET\" id=\"controllersLangSet\" />\n <label for=\"controllersLangSet\">Language toggle</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>Tabs in Vessel Details</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <input type=\"checkbox\" name=\"detailTabs\" value=\"PORT_CALLS\" id=\"detailTabsPortCalls\" />\n <label for=\"detailTabsPortCalls\">Route tab</label>\n <input type=\"checkbox\" name=\"detailTabs\" value=\"SAIL_LOG\" id=\"detailTabsSailLog\" />\n <label for=\"detailTabsSailLog\">Route log tab</label>\n </div>\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>Search</div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <select name=\"searchType\" id=\"selectType\">\n <option value=\"keyword\">Keyword</option>\n <option value=\"trackGroup\">Vessel Group</option>\n </select>\n <input type=\"text\" name=\"searchValue\" id=\"searchValue\" />\n </div>\n <div class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n <button type=\"submit\" id=\"button_map\">Search</button>\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml'> End of input area -->\n <comment class='preserveHtml' class='preserveHtml' class='preserveHtml'> Map view area start -->\n <div class='preserveHtml' class='preserveHtml' id=\"frame\">\n </div><div> style=\"border: 1px solid black; height: 700px; width: 100%\"\n<br></div><div> allowfullscreen\n<br></div><div> name=\"viewer\"\n<br></div><div> >\n<br></div><div> </iframe>\n<br></div><div> </div>\n<br></div><div> <comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;> End of map view area </comment>\n<br></div><div> </div>\n<br></div><div> </div>\n<br></div><div> </div>\n<br></div><div> </form>\n<br></div><div> </body>\n<br></div><div> <script>\n<br></div><div> window.addEventListener(\"DOMContentLoaded\", () => {\n<br></div><div> // Create <input type="hidden" /> with the token received from middleware\n<br></div><div> fetch(\"{ Auth token endpoint }\")\n<br></div><div> .then((item) => item.text())\n<br></div><div> .then((authToken) => {\n<br></div><div> const input = document.createElement(\"input\");\n<br></div><div> input.setAttribute(\"type\", \"hidden\");\n<br></div><div> input.setAttribute(\"name\", \"authorization\");\n<br></div><div> input.setAttribute(\"value\", authToken);\n<br></div><div> const form = document.getElementById(\"viewer_form\");\n<br></div><div> form.appendChild(input);\n<br></div><div> });\n<br></div><div> });\n<br></div><div> </script>\n<br></div><div></html>\n<br></div></code></pre><p ><strong ></b></p><p ></p><p ></p></x-turndown>\nRetrieve port congestion data by providing one or more port codes.
\nMaximum 30 port codes can be included in a single request.
\nDate and time fields in content follow ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssZ.
(required) List of port codes
\n","type":"text/plain"},"key":"port_code_list","value":"[Port Code],[Port Code]"},{"description":{"content":"(required) Period for calculating average metric
\n","type":"text/plain"},"key":"average_period_type_list","value":"[Average Period Type],[Average Period Type]"}],"variable":[]}},"response":[{"id":"d078d7c9-6e0a-4f67-bcc3-c8a81394eaf5","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/port-congestion?port_code_list=[Port Code],[Port Code]&average_period_type_list=[Average Period Type],[Average Period Type]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","port-congestion"],"query":[{"key":"port_code_list","value":"[Port Code],[Port Code]","description":"(required) List of port codes"},{"key":"average_period_type_list","value":"[Average Period Type],[Average Period Type]","description":"(required) Period for calculating average metric"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"transaction_time\": \"2026-01-12T01:22:55.347646\",\n \"content\": [\n {\n \"port_code\": \"KRINC\",\n \"port_name\": \"Incheon\",\n \"average_berth_delay_hours\": [\n {\n \"period_type\": \"THREE_DAYS\",\n \"value\": 13.1\n },\n {\n \"period_type\": \"ONE_WEEK\",\n \"value\": 9.23\n },\n {\n \"period_type\": \"TWO_WEEKS\",\n \"value\": 10.98\n },\n {\n \"period_type\": \"ONE_MONTH\",\n \"value\": 12.38\n }\n ],\n \"berth_pending_vessel_count\": 20,\n \"average_berth_duration_hours\": [\n {\n \"period_type\": \"THREE_DAYS\",\n \"value\": 20.87\n },\n {\n \"period_type\": \"ONE_WEEK\",\n \"value\": 20.33\n },\n {\n \"period_type\": \"TWO_WEEKS\",\n \"value\": 22.08\n },\n {\n \"period_type\": \"ONE_MONTH\",\n \"value\": 24.77\n }\n ],\n \"port_congestion_index_levels\": [\n {\n \"period_type\": \"THREE_DAYS\",\n \"level\": \"STABLE\"\n },\n {\n \"period_type\": \"ONE_WEEK\",\n \"level\": \"STABLE\"\n },\n {\n \"period_type\": \"TWO_WEEKS\",\n \"level\": \"STABLE\"\n },\n {\n \"period_type\": \"ONE_MONTH\",\n \"level\": \"STABLE\"\n }\n ],\n \"berthing_vessel_count\": 6,\n \"latitude\": 37.343784,\n \"longitude\": 126.631836,\n \"updated_datetime\": \"2026-01-12T01:04:02Z\"\n },\n {\n \"port_code\": \"KRPUS\",\n \"port_name\": \"Busan\",\n \"average_berth_delay_hours\": [\n {\n \"period_type\": \"THREE_DAYS\",\n \"value\": 6.98\n },\n {\n \"period_type\": \"ONE_WEEK\",\n \"value\": 7.35\n },\n {\n \"period_type\": \"TWO_WEEKS\",\n \"value\": 8.0\n },\n {\n \"period_type\": \"ONE_MONTH\",\n \"value\": 9.13\n }\n ],\n \"berth_pending_vessel_count\": 109,\n \"average_berth_duration_hours\": [\n {\n \"period_type\": \"THREE_DAYS\",\n \"value\": 14.95\n },\n {\n \"period_type\": \"ONE_WEEK\",\n \"value\": 16.08\n },\n {\n \"period_type\": \"TWO_WEEKS\",\n \"value\": 17.25\n },\n {\n \"period_type\": \"ONE_MONTH\",\n \"value\": 18.7\n }\n ],\n \"port_congestion_index_levels\": [\n {\n \"period_type\": \"THREE_DAYS\",\n \"level\": \"STABLE\"\n },\n {\n \"period_type\": \"ONE_WEEK\",\n \"level\": \"STABLE\"\n },\n {\n \"period_type\": \"TWO_WEEKS\",\n \"level\": \"STABLE\"\n },\n {\n \"period_type\": \"ONE_MONTH\",\n \"level\": \"STABLE\"\n }\n ],\n \"berthing_vessel_count\": 30,\n \"latitude\": 35.10612,\n \"longitude\": 129.08546,\n \"updated_datetime\": \"2026-01-12T01:04:02Z\"\n }\n ]\n}"},{"id":"806c609d-c1fa-4c1a-99e0-0ed33ad28be4","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/port-congestion?port_code_list=[Port Code],[Port Code]&average_period_type_list=[Average Period Type],[Average Period Type]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","port-congestion"],"query":[{"key":"port_code_list","value":"[Port Code],[Port Code]","description":"(required) List of port codes"},{"key":"average_period_type_list","value":"[Average Period Type],[Average Period Type]","description":"(required) Period for calculating average metric"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"[average_period_type_list]: Required field is not provided.\",\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"transaction_time\": \"2025-08-28T07:21:13.367404\"\n}"},{"id":"42a580bf-95eb-49c6-ac6f-5395e50935b3","name":"500 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/port-congestion?port_code_list=[Port Code],[Port Code]&average_period_type_list=[Average Period Type],[Average Period Type]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","port-congestion"],"query":[{"key":"port_code_list","value":"[Port Code],[Port Code]","description":"(required) List of port codes"},{"key":"average_period_type_list","value":"[Average Period Type],[Average Period Type]","description":"(required) Period for calculating average metric"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 500,\n \"type\": \"Internal Server Error\",\n \"message\": \"Internal server error. Please try again in a few minutes.\"\n}"}],"_postman_id":"32f029da-0d42-4efb-8b7a-4d086da86d92"}],"id":"b7de6b39-91aa-4a53-9e9a-ba6b565a8cf1","description":"Port Congestion API provides real-time port congestion insights based on AIS vessel tracking data.
\nBy monitoring vessel activity in berth areas and anchorage areas, customers can identify port congestion levels and assess potential impacts on vessel schedules and cargo operations.
\nThe API provides standardized port congestion metrics across supported ports, helping customers monitor port conditions through a consistent interface.
\nPort Congestion API requires a separate subscription and is not included in the Ocean Visibility Enterprise Plan.
\nFor pricing and availability, please contact our sales team.
\n\n","_postman_id":"b7de6b39-91aa-4a53-9e9a-ba6b565a8cf1"},{"name":"Supply Chain Issue Monitoring","item":[{"name":"1. Retrieve Supply Chain Issue Categories","id":"9e0b3e58-03d1-4d91-9312-bf493258d48f","request":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":"https://api.tradlinx.com/partners/track/v3/supply-chain/categories","description":"Retrieve a list of supply chain issue articles.
\nMaximum 50 articles can be retrieved per request.
\nCategory IDs
\n","type":"text/plain"},"key":"category_ids","value":"[Category ID],[Category ID],[Category ID]"},{"description":{"content":"Publication date range (start, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"published_from","value":"[Published From]"},{"description":{"content":"Publication date range (end, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)
\n","type":"text/plain"},"key":"published_to","value":"[Published To]"},{"description":{"content":"(required) Page number (min: 1)
\n","type":"text/plain"},"key":"page","value":"[Page]"},{"description":{"content":"(required) Page size (range: 1–50)
\n","type":"text/plain"},"key":"size","value":"[Size]"}],"variable":[]}},"response":[{"id":"3542ce42-7e48-460d-898b-00b86e806122","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/supply-chain/articles?category_ids=[Category ID],[Category ID],[Category ID]&published_from=[Published From]&published_to=[Published To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","supply-chain","articles"],"query":[{"key":"category_ids","value":"[Category ID],[Category ID],[Category ID]","description":"Category IDs"},{"key":"published_from","value":"[Published From]","description":"Publication date range (start, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"published_to","value":"[Published To]","description":"Publication date range (end, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"page","value":"[Page]","description":"(required) Page number (min: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1–50)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"api_version\": \"v3\",\n \"content\": [\n {\n \"title\": \"SAMPLE_TITLE_NAME\",\n \"categories\": [\n \"SAMPLE_CATEGORY_NAME\"\n ],\n \"link\": \"SAMPLE_LINK\",\n \"published_at\": \"2025-09-08T00:00:00Z\",\n \"source\": \"SAMPLE_SOURCE_NAME\"\n },\n {\n \"title\": \"SAMPLE_TITLE_NAME\",\n \"categories\": [\n \"SAMPLE_CATEGORY_NAME_1\", \"SAMPLE_CATEGORY_NAME_2\"\n ],\n \"link\": \"SAMPLE_LINK\",\n \"published_at\": \"2025-09-08T00:00:00Z\",\n \"source\": \"SAMPLE_SOURCE_NAME\"\n }\n ],\n \"message\": \"SAMPLE_ERROR_CODE\",\n \"pagination\": {\n \"current_page\": 0,\n \"has_next\": false,\n \"total_page\": 0,\n \"total_size\": 0\n },\n \"size\": 1,\n \"transaction_time\": \"2025-09-08T02:08:01.397Z\"\n}"},{"id":"dd38c573-87d8-46a0-ab64-5231f0e9261e","name":"400 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/supply-chain/articles?category_ids=[Category ID],[Category ID],[Category ID]&published_from=[Published From]&published_to=[Published To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","supply-chain","articles"],"query":[{"key":"category_ids","value":"[Category ID],[Category ID],[Category ID]","description":"Category IDs"},{"key":"published_from","value":"[Published From]","description":"Publication date range (start, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"published_to","value":"[Published To]","description":"Publication date range (end, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"page","value":"[Page]","description":"(required) Page number (min: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1–50)"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error_detail\": \"This feature is not supported on your current plan.\",\n \"transaction_time\": \"2025-09-08 01:54:43\",\n \"message\": \"UNSUPPORTED_FEATURE\"\n}"},{"id":"9d78fbeb-8ee5-4561-85b7-581beca81dd8","name":"500 Error","originalRequest":{"method":"GET","header":[{"key":"tx-clientid","value":""},{"key":"tx-apikey","value":""},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.tradlinx.com/partners/track/v3/supply-chain/articles?category_ids=[Category ID],[Category ID],[Category ID]&published_from=[Published From]&published_to=[Published To]&page=[Page]&size=[Size]","host":["https://api.tradlinx.com"],"path":["partners","track","v3","supply-chain","articles"],"query":[{"key":"category_ids","value":"[Category ID],[Category ID],[Category ID]","description":"Category IDs"},{"key":"published_from","value":"[Published From]","description":"Publication date range (start, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"published_to","value":"[Published To]","description":"Publication date range (end, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)"},{"key":"page","value":"[Page]","description":"(required) Page number (min: 1)"},{"key":"size","value":"[Size]","description":"(required) Page size (range: 1–50)"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": 500,\n\t\"type\": \"Internal Server Error\",\n\t\"message\": \"Internal server error. Please try again in a few minutes.\"\n}"}],"_postman_id":"427f4f98-5560-412c-ad18-60eeb6b32c09"}],"id":"dd8e49ec-81f5-45a7-8b6f-10b85f18c1d5","description":"Supply Chain Issue Monitoring provides supply chain news related to ocean logistics.
\nThe API allows customers to retrieve news and events that may impact logistics operations through a standardized API.
\nSupply Chain Issue Monitoring API requires a separate subscription and is not included with other API subscriptions.
\nFor pricing and availability, please contact our sales team.
\n\n","_postman_id":"dd8e49ec-81f5-45a7-8b6f-10b85f18c1d5"},{"name":"References","item":[{"name":"Error Codes","item":[],"id":"d3fd4336-8955-42df-85de-668b8de51aba","description":"This section provides a mapping between v2 and v3 API error codes and their corresponding reasons.
\nHow error reasons are presented:
\nIn v2 API, the reason field contains an Error Code representing the issue.
\nIn v3 API, the reason field contains a Description instead of a numeric code.
\nExample Response
\nV2 API Example
\n{\n \"api_version\": \"v2\",\n \"transaction_time\": \"2024-11-14T04:40:30.790634\",\n \"content\": {\n \"success\": [],\n \"fail\": [\n {\n \"data\": {\n \"line_cd\": \"HMM\",\n \"bl_no\": \"BL123456789\"\n },\n \"reason\": \"5\"\n }\n ],\n \"total_count\": 1,\n \"success_count\": 0,\n \"fail_count\": 1\n }\n}\n\nV3 API Example
\n{\n \"api_version\": \"v3\",\n \"transaction_time\": \"2024-11-14T04:40:30.790634\",\n \"content\": {\n \"success\": [],\n \"fail\": [\n {\n \"data\": {\n \"line_cd\": \"HMM\",\n \"bl_no\": \"BL123456789\"\n },\n \"reason\": \"COLLECT_NOT_ACCEPT\"\n }\n ],\n \"total_count\": 1,\n \"success_count\": 0,\n \"fail_count\": 1\n }\n}\n\nSummary
\nv2 API: Use Error Code code for reason (e.g. \"5\").
\nv3 API: Use Description for the reason (e.g. \"COLLECT_NOT_ACCEPT\").
\nThe two APIs provide the same error information in different ways.
\nCredit Usage API provides information about credits available for the Tradlinx Ocean Visibility API.
\nThe API allows you to retrieve allocated, used, and remaining credits, along with the validity period for each credit type.
\n","_postman_id":"49084ba1-ea93-4986-ac14-6874bbbfef52"},{"name":"Supported Carriers for Shipment Tracking","item":[],"id":"d095a504-67d1-4e3c-8574-15cfed1f0259","description":"Tradlinx Ocean Visibility supports shipment tracking for a wide range of global and regional ocean carriers.
\nThe table below shows the tracking methods supported by each carrier, including B/L Tracking and Container No. Tracking.
\nThe table below shows the tracking methods supported by each carrier
\n","_postman_id":"d095a504-67d1-4e3c-8574-15cfed1f0259"},{"name":"Port Codes","item":[],"id":"669cec72-2769-455f-8fa7-58ef79002f2e","description":"This page provides the list of port codes used across Tradlinx APIs.
\nThese port codes are commonly used in request and response fields such as POL, POD, and other port-related parameters.
Refer to this list when validating input values or interpreting API responses.
\nPort codes are based on the TRADLINX system and may differ from those used by external systems.
\nWe've compiled answers to the most frequently asked questions below.
\nIf you have any additional questions, please contact your sales representative or email us at tech.support@tradlinx.com.
\nTo use the API, please schedule a meeting with our sales team using the link below.
\nYour Client ID and API Key will be issued after the meeting. → Schedule a Meeting
\nNo. We currently do not provide a separate test (sandbox) environment.
\nAll API testing is performed in the production environment.
\nThis may be caused by an incorrect Client ID or API Key configuration.
\nPlease capture your Account Settings page showing both your Client ID and API Key, then send it to tech.support@tradlinx.com for verification.
\nPlease provide the unavailable API or feature name and contact your sales representative to verify whether the feature is included in your subscription plan.
\nCurrently, Ocean Visibility supports a single login account. Multiple users may share the same account credentials if necessary.
\nB/L Tracking
\nTracks shipments using the Master B/L.
\nProvides tracking information for all containers under the same B/L.
\nContainer Tracking
\nCan be used even when a Master B/L is not available.
\nTracks shipments using the Container Number.
\nPlease use the carrier codes defined by Tradlinx. These may differ from standard SCAC codes.
\nRefer to the Supported Carriers documentation.
\nThe supported carrier list may change depending on carrier integrations and operational updates.
\nWhenever changes are made, we will notify customers by email.
\nreference_no?reference_no is your own identifier.
You may use values such as a PO number or House B/L number to identify your shipments.
\nNo. Tracking numbers belong to other customers and cannot be shared.
\nPlease use your own shipment information for testing.
\nYes.
\nBoth carrier-reported and AIS-based timestamps are provided.
\nYes. Webhook is available for B/L Tracking.
\nIf you would like to enable Webhook, please contact tech.support@tradlinx.com.
\nDifferences may occur for several reasons, including:
\nTemporary synchronization delays due to tracking update intervals.
\nThe carrier provides different information through its website and API.
\nCarrier data is updated at different times.
\nIf the discrepancy persists, please contact cx@tradlinx.com for further investigation.
\nThis usually means the line_cd is incorrect.
Tradlinx uses its own carrier codes rather than standard SCAC codes.
\nPlease refer to the Supported Carriers documentation.
\nNo. Please cancel the existing tracking request and register it again.
\nThe maximum page size is fixed at 50 records.
\nPlease use the pagination fields (page, has_next, and total_page) to retrieve all results.
Credit validity periods are based on UTC.
\nYes. Datetime values without an explicit timezone should be interpreted as UTC.
\nNo. If the previous tracking has not expired, no additional credits are deducted, and the original expiration date is maintained.
\nOnce a vessel has been tracked, the same vessel_track_id is reused.
If Auto Renewal is enabled, credits are deducted one day before expiration, and the expiration date is extended by one month.
\ndata_source field mean?PORT_CALL: AIS-based actual port call information.
\nCarrier Code (MAE, ONE, ZIM, etc.): Schedule information provided by the carrier.
\ndata_source value change?Yes. Before arrival, it may indicate carrier schedule data.
\nOnce the vessel arrives at the monitored port area, it may change to PORT_CALL.
Vessel ID: Fixed
\nIMO: Fixed
\nMMSI: May change
\nVessel Name: May change
\nis_actual?We recommend using data_source instead. PORT_CALL indicates AIS-based actual data, while carrier codes indicate carrier-provided schedule data that may still change.
The expiration date is always one month from the registration date.
\nThe actual number of days may vary depending on the number of days in each month.
\nPort Congestion data is updated daily at approximately 10:00 AM (KST).
\nPlease refer to update_datetime in the response for the actual update time.
average_period_type_list?The following values are supported:
\nTHREE_DAYS
ONE_WEEK
TWO_WEEKS
ONE_MONTH
Only the values specified in the request are returned.
\n