Skip to main content

Supply Chain Issue Monitoring API

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

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

Common API Guidelines:

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

🔔 API Update & Backward Compatibility Notice

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

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

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

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

1. Retrieve Supply Chain Issue Categories​

  • Retrieves the list of supply chain issue categories.

Request

GET /partners/track/v3/supply-chain/categories
curl -X GET "https://api.tradlinx.com/partners/track/v3/supply-chain/categories" \
-H "tx-clientid: [Client ID]" \
-H "tx-apikey: [API Key]" \
-H "Content-Type: application/json"

Response

{
"apiVersion": "v3",
"result": [
{
"category_id": 1,
"name": "SAMPLE_CATEGORY_NAME",
"display_name": "SAMPLE_CATEGORY_NAME",
"level": 1,
"parent_id": null
},
{
"category_id": 2,
"name": "SAMPLE_CATEGORY_NAME",
"display_name": "SAMPLE_UPPER_CATEGORY_NAME > SAMPLE_CATEGORY_NAME",
"level": 2,
"parent_id": 1
}
]
}

Response - Response Body

FieldTypeDescriptionRemark
api_versionstringAPI versionv3
contentSupplyChainCategoryV3Response[]Supply chain issue category info
messagestringServer messageProvided if necessary
transaction_timestringResponse timestampyyyy-MM-dd'T'HH:mm:ss.SSSSSS

Supply Chain Issue Category Info - SupplyChainCategoryV3Response

FieldTypeDescription
category_idnumberCategory ID
namestringCategory name
display_namestringFull hierarchical name
levelnumberCategory level

400 Error

{
"error_detail": "This feature is not supported on your current plan.",
"transaction_time": "2025-09-08 01:54:43",
"message": "UNSUPPORTED_FEATURE"
}

500 Error

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

2. Retrieve Supply Chain Issue Articles​

  • Retrieves the list of supply chain issue articles.
  • Up to 50 articles can be retrieved at once.

Request

GET /partners/track/v3/supply-chain/articles

Query Parameter

FieldTypeDescription
category_idsList<Long>Category IDs
published_fromstringPublication date range (start, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)
published_tostringPublication date range (end, ISO 8601: yyyy-MM-dd'T'HH:mm:ssXXX)
*pagenumberPage number (min: 1)
*sizenumberPage size (range: 1–50)
curl -X GET "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]" \
-H "tx-clientid: [Client ID]" \
-H "tx-apikey: [API Key]" \
-H "Content-Type: application/json" \

Response

{
"api_version": "v3",
"content": [
{
"title": "SAMPLE_TITLE_NAME",
"categories": [
"SAMPLE_CATEGORY_NAME"
],
"link": "SAMPLE_LINK",
"published_at": "2025-09-08T00:00:00Z",
"source": "SAMPLE_SOURCE_NAME"
},
{
"title": "SAMPLE_TITLE_NAME",
"categories": [
"SAMPLE_CATEGORY_NAME_1", "SAMPLE_CATEGORY_NAME_2"
],
"link": "SAMPLE_LINK",
"published_at": "2025-09-08T00:00:00Z",
"source": "SAMPLE_SOURCE_NAME"
}
],
"message": "SAMPLE_ERROR_CODE",
"pagination": {
"current_page": 0,
"has_next": false,
"total_page": 0,
"total_size": 0
},
"size": 1,
"transaction_time": "2025-09-08T02:08:01.397Z"
}

Response - Response Body

FieldTypeDescriptionRemark
api_versionstringAPI versionv3
contentSupplyChainArticlesV3Response[]Supply chain Issue articles
messagestringServer messageProvided if necessary
transaction_timestringResponse timestampyyyy-MM-dd'T'HH:mm:ss.SSSSSS

Supply Chain Issue Articles - SupplyChainArticlesV3Response

FieldTypeDescription
titlestringArticle title
categoriesstring[]Category names
linkstringArticle link
published_atstringPublication date (yyyy-MM-dd’T’HH:mm:ssZ)
sourcenumberArticle source name

400 Error

{
"error_detail": "This feature is not supported on your current plan.",
"transaction_time": "2025-09-08 01:54:43",
"message": "UNSUPPORTED_FEATURE"
}

500 Error

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