/releases

Get all releases

get

Get all releases that have been transferred to you. This includes all data except the pincode.

Authorizations
Query parameters
limitintegerOptional

The maximum number of records to return

pageintegerOptional

Page number, to be used with limit

sincestringOptional

Timestamp to limit the releases to those modified since then

blstringOptional

The bill of lading number

containerstringOptional

The container number

Responses
200
Successful response
application/json
get
GET /tmining/api/v1/releases HTTP/1.1
Host: url:port
Authorization: Bearer JWT
Accept: */*
[
  {
    "release_data": {
      "billOfLading": {
        "blNumber": "text",
        "portOfLoading": "text",
        "portOfDestination": "text",
        "vessel": "text",
        "agent": "text",
        "stayNumber": "text",
        "lloydsNumber": "text",
        "voyageNumber": "text",
        "lineCode": "text"
      },
      "container": {
        "containerNumber": "text",
        "containerStatus": "released",
        "pickupLocation": "text",
        "turnInLocation": "text",
        "turnInReference": "text",
        "termsAndConditions": "text",
        "validFrom": "2025-06-25T00:36:25.791Z",
        "validUntil": "2025-06-25T00:36:25.791Z",
        "isoTypeCode": "text",
        "loadStatus": "text",
        "moveType": "text"
      }
    },
    "address": "text",
    "deleted": true,
    "blocked": true,
    "encryptedPin": "text",
    "gateOut": "2025-06-25T00:36:25.791Z",
    "createdAt": "2025-06-25T00:36:25.791Z",
    "updatedAt": "2025-06-25T00:36:25.791Z",
    "owner": "text",
    "creator": "text",
    "greenLights": {
      "total": "text",
      "events": {
        "customs": {
          "color": "text",
          "value": "text",
          "updatedAt": "2025-06-25T00:36:25.791Z"
        },
        "pickuplight": {
          "color": "text",
          "value": "text",
          "updatedAt": "2025-06-25T00:36:25.791Z"
        },
        "gateoperation": {
          "color": "text",
          "value": "text",
          "updatedAt": "2025-06-25T00:36:25.791Z"
        },
        "terminalready": {
          "color": "text",
          "value": "text",
          "updatedAt": "2025-06-25T00:36:25.791Z"
        },
        "customsprogress": {
          "color": "text",
          "value": "text",
          "updatedAt": "2025-06-25T00:36:25.791Z"
        },
        "commercialrelease": {
          "color": "text",
          "value": "text",
          "updatedAt": "2025-06-25T00:36:25.791Z"
        },
        "terminaloperation": {
          "color": "text",
          "value": "text",
          "updatedAt": "2025-06-25T00:36:25.791Z"
        }
      }
    }
  }
]

Get one release

get

Get the data of a single release identified by its address, excluding the pincode.

Authorizations
Path parameters
addressstringRequired
Responses
200
Successful response
application/json
get
GET /tmining/api/v1/releases/{address} HTTP/1.1
Host: url:port
Authorization: Bearer JWT
Accept: */*
{
  "release_data": {
    "billOfLading": {
      "blNumber": "text",
      "portOfLoading": "text",
      "portOfDestination": "text",
      "vessel": "text",
      "agent": "text",
      "stayNumber": "text",
      "lloydsNumber": "text",
      "voyageNumber": "text",
      "lineCode": "text"
    },
    "container": {
      "containerNumber": "text",
      "containerStatus": "released",
      "pickupLocation": "text",
      "turnInLocation": "text",
      "turnInReference": "text",
      "termsAndConditions": "text",
      "validFrom": "2025-06-25T00:36:25.791Z",
      "validUntil": "2025-06-25T00:36:25.791Z",
      "isoTypeCode": "text",
      "loadStatus": "text",
      "moveType": "text"
    }
  },
  "address": "text",
  "deleted": true,
  "blocked": true,
  "encryptedPin": "text",
  "gateOut": "2025-06-25T00:36:25.791Z",
  "createdAt": "2025-06-25T00:36:25.791Z",
  "updatedAt": "2025-06-25T00:36:25.791Z",
  "owner": "text",
  "creator": "text",
  "greenLights": {
    "total": "text",
    "events": {
      "customs": {
        "color": "text",
        "value": "text",
        "updatedAt": "2025-06-25T00:36:25.791Z"
      },
      "pickuplight": {
        "color": "text",
        "value": "text",
        "updatedAt": "2025-06-25T00:36:25.791Z"
      },
      "gateoperation": {
        "color": "text",
        "value": "text",
        "updatedAt": "2025-06-25T00:36:25.791Z"
      },
      "terminalready": {
        "color": "text",
        "value": "text",
        "updatedAt": "2025-06-25T00:36:25.791Z"
      },
      "customsprogress": {
        "color": "text",
        "value": "text",
        "updatedAt": "2025-06-25T00:36:25.791Z"
      },
      "commercialrelease": {
        "color": "text",
        "value": "text",
        "updatedAt": "2025-06-25T00:36:25.791Z"
      },
      "terminaloperation": {
        "color": "text",
        "value": "text",
        "updatedAt": "2025-06-25T00:36:25.791Z"
      }
    }
  }
}