How do the JSON output and object table of Tradelens transportation doc transactions API function?

In this article, I will provide a clear understanding of the object table and JSON output of the TradeLens Transportation Doc Transactions API. As a programmer, you may already be familiar with these concepts, but it's important to have a thorough understanding of the specifics when working with this particular API. By the end of this article, you will have a comprehensive understanding of how the object table and JSON output work in the context of TradeLens Transportation Doc Transactions API, and be better equipped to use this information to build efficient and effective applications.

Object and Description table

• hasMore: A Boolean value indicating whether there are more results available for the query.

• newFrom: A string indicating the earliest creation time of a transaction in the next set of results, used for pagination.

• transactionResponseList: A list of transaction responses.

• actions: A list of actions associated with a transaction.

• createConsignmentAction: An action that creates a new consignment.

• actionId: A unique identifier for an action.

• status: The status of a transaction or action.

• bulkTransactionId: The unique identifier for a bulk transaction.

• documents: A list of documents associated with a transaction.

• docIssuanceTime: The time the document was issued.

• docReferences: A list of references to related documents.

• additionalProp1, additionalProp2, additionalProp3: Additional properties that may be associated with a transaction or action.

• docStatus: The status of a document.

• docType: The type of a document.

• docVersion: The version of a document.

• documentId: A unique identifier for a document.

• errorCode: An error code associated with a transaction or action.

• errorMessage: An error message associated with a transaction or action.

The given JSON output is a representation of a response from the TradeLens Transportation Doc Transactions API. It contains several objects including "hasMore", "newFrom" and a "transactionResponseList" which is an array containing a single object. This object contains information about a specific transaction and its associated documents, actions, and properties. For example, the "actions" object contains a single "createConsignmentAction" object which provides an "actionId" and a "status". Similarly, the "documents" object contains an array of documents, each of which contains information such as "docIssuanceTime", "docReferences", "docStatus", "docType", "docVersion", "documentId", "errorCode", and "errorMessage". Additionally, the response includes information about the status of the transaction ("status"), error codes ("errorCode"), and a timestamp of when the transaction started and stopped ("txnStartTime" and "txnStopTime"). This JSON output can be used by developers to retrieve information about specific transactions and documents within the TradeLens platform.

JSON REST output

The given JSON output is a representation of a response from the TradeLens Transportation Doc Transactions API. It contains several objects including "hasMore", "newFrom" and a "transactionResponseList" which is an array containing a single object. This object contains information about a specific transaction and its associated documents, actions, and properties. For example, the "actions" object contains a single "createConsignmentAction" object which provides an "actionId" and a "status". Similarly, the "documents" object contains an array of documents, each of which contains information such as "docIssuanceTime", "docReferences", "docStatus", "docType", "docVersion", "documentId", "errorCode", and "errorMessage". Additionally, the response includes information about the status of the transaction ("status"), error codes ("errorCode"), and a timestamp of when the transaction started and stopped ("txnStartTime" and "txnStopTime"). This JSON output can be used by developers to retrieve information about specific transactions and documents within the TradeLens platform.

{
"hasMore": true,
"newFrom": "string",
"transactionResponseList": [
{
"actions": {
"createConsignmentAction": {
"actionId": "c93b1946-d8f7-11e7-9296-cec278b6b50a",
"status": "INPROGRESS"
}
},
"bulkTransactionId": "c93b1946-d8f7-11e7-9296-cec278b6b50a",
"documents": [
{
"docIssuanceTime": "2018-03-13T11:30:00.000-05:00",
"docReferences": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"docStatus": "string",
"docType": "SHIPPING_INSTRUCTIONS",
"docVersion": 0,
"documentId": "SHIPPING_INSTRUCTIONS",
"errorCode": "string",
"errorMessage": "string",
"fileType": "JSON",
"schemaReference": {
"documentSchemaId": "a0b1c2d3-e4f5-0a1b-2c3d-0123456789ab",
"version": "v1"
},
"tradeObjectType": "string"
}
],
"errorCode": "AF_xxx",
"errorMessage": "Internal server error",
"lastModifiedDate": "2018-09-27T09:08:00Z",
"originator": "gtd-demo-jv-sunny-farms",
"status": "InProgress",
"tradeObjectIdentifiers": {
"consignment": {
"billOfLadingNumber": "BOL8331939",
"carrierBookingNumber": "CBN456789",
"consignmentId": "CID8331939"
},
"shipment": {
"references": [
{
"reference": "myReference",
"type": "proformaInvoiceNumber"
}
],
"shipmentId": "sdkjf68-fdsjf0-jsddj-dskjk"
},
"transportEquipment": {
"billOfLadingNumber": "BOL8331939",
"carrierBookingNumber": "CBN456789",
"equipmentNumber": "ACME1122334",
"transportEquipmentId": "TEID8331939"
}
},
"txnStartTime": 1561585550449,
"txnStopTime": 1561585551449
}
]
}

Conclusion

Now, we discussed the object table and JSON output of the TradeLens Transportation Doc Transactions API. We started by introducing the topic and providing a brief overview of the table and its objects, followed by a more detailed explanation of each object. We then moved on to describe the JSON output of the API, which contains information about specific transactions and their associated documents, actions, and properties. Overall, this information is useful for developers who are looking to work with the TradeLens platform and create applications that can access and manipulate transaction data. By understanding the objects and JSON output of the API, developers can build more effective and efficient applications that meet their specific needs.

Footnote

Developers can request access to the TradeLens Transportation Doc Transactions API through the third-party data marketplace of Worldindata. By accessing the TradeLens API through Worldindata, developers can take advantage of a streamlined registration process and gain additional support and resources for building their applications. Accessing the API through a third-party marketplace can provide developers with a convenient and efficient way to work with TradeLens data and develop powerful applications.