> For the complete documentation index, see [llms.txt](https://developer.securecontainerrelease.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.securecontainerrelease.com/schema/releases.md).

# RELEASES

The fields illustrated in the [releases](/api-reference/releases.md)-reference are explained in the table below in greater detail.

{% tabs %}
{% tab title="FIELDS" %}

| FIELD                | EXPLANATION                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `blNumber`           | The bill of lading number.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `portOfLoading`      | A text description of the port of loading, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `portOfDestination`  | A text description of the port of destination, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `vessel`             | A text description of the incoming vessel, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `agent`              | A text description of the agent that released the container, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `stayNumber`         | The stay number of the incoming vessel, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `lloydsNumber`       | The Lloyds number of the incoming vessel, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `voyageNumber`       | The voyage number of the incoming vessel, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `lineCode`           | The line code of the bill of lading, supplied by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `containerNumber`    | The container number of the container that is released.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `containerStatus`    | The base status of the release, can be amended with extra blocks etc. (see below).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `pickupLocation`     | A text description of the terminal where the full import container can be picked up.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `pickupLoCode`       | The UN Locode of the pickup location.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `turnInLocation`     | A text description of the terminal or depot where the empty import container has to be returned.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `turnInLoCode`       | The UN Locode of the turn in location.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `turnInReference`    | The reference that has to be used when returning the empty container.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `termsAndConditions` | A HTML object in which the carrier can include terms and conditions.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `validFrom`          | The date and time from which the release is valid on the terminal, note that this date can be before the containers is discharged from the vessel and thus does not indicate availability for pick up.                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `validUntil`         | The date and time until which the release is valid on the terminal.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `isoTypeCode`        | The ISO size and type code of the container.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `loadStatus`         | The load status of the container, can contain "full", "empty" or "empty with residue" (default: "full").                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `moveType`           | The move type of the container, can contain "import", "export", "transshipment", "shunting" or "port equalisation" (default: "import").                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `address`            | The unique address of this release.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `deleted`            | A boolean indicating the release was deleted by the carrier, this is a final state.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `blocked`            | A boolean indicating the release was temporarily blocked by the carrier, which means the container cannot be picked up at the terminal                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `encryptedPin`       | The encrypted pin of the release but should not be used, please use the getPin endpoint to retrieve the pin instead.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `gateOut`            | The date and time the container was picked up at the terminal.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `createdAt`          | The date and time the release was created by the carrier.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `updatedAt`          | The date and time the release was last updated.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `owner`              | The address of the owner of the release, but you should use the previous/self/nextOwner fields below instead to identify the owner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `creator`            | <p>The address of the carrier that created the release - possible values:</p><p></p><p><strong>CMA/CGM Belgium</strong>: 0x2e13e5323785818Cb8AFC57E66431377712A4b91</p><p><br><strong>CMA/CGM Nederland</strong>: 0xA82F30D75e4486864Cf65c83e74F8DaB7fc2fEaE</p><p><br><strong>Hapag-Lloyd Benelux</strong>: 0x3041D538A72D73116D6ce13B6cda468d2cECA831</p><p><br><strong>MSC Belgium</strong>: 0xE51e6BBf84e23De4785Edb7096460Ec9956A5B34</p><p><br><strong>MSC Nederland</strong>: 0x9F2377dbb208e233Fb3096539eE5eAA78553c408</p><p><br><strong>One Nederland</strong>: 0xB4F7852d6a3A6537eeCc0465e44C3Dc7112E16D1</p> |
| `version`            | The version of the smart contract of the release, not to be used.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `pinRetrieved`       | A boolean indicating the pin was retrieved.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `previousOwner`      | The address of the previous owner, i.e. the company that transferred the release to your company.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `previousOwnerName`  | The company name of the previous owner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `previousOwnerVat`   | The VAT of the previous owner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `nextOwner`          | The address of the next owner, i.e. the company that you transferred a release to (if you did).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `nextOwnerName`      | The company name of the next owner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `nextOwnerVat`       | The VAT of the next owner.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `selfOwner`          | The address of the company that is calling the API.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `selfOwnerName`      | The company name of the company that is calling the API.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `selfOwnerVat`       | The VAT of the company that is calling the API.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `conditions`         | Not used at the moment.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `greenLights`        | Contains status information we receive from for instance a terminal or PCS (see [here ](/schema/green-lights.md)for details).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| {% endtab %}         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

{% tab title="RESPONSE (example)" %}

```json
[
    {
        "release_data": {
            "billOfLading": {
                "blNumber": "RELEASE-API-TEST-1612",
                "portOfLoading": "BEANR",
                "portOfDestination": "BEANR",
                "vessel": "AAA",
                "agent": "BBB",
                "stayNumber": "00001",
                "lloydsNumber": "0002",
                "voyageNumber": "0003",
                "lineCode": "HPL"
            },
            "container": {
                "containerNumber": "CSQU32345690",
                "containerStatus": "released",
                "pickupLocation": "ECTDCD",
                "turnInLocation": "terminal_locode",
                "turnInReference": "aref",
                "termsAndConditions": "base64 encoded data",
                "validFrom": "2017-01-05T14:00:00.000Z",
                "validUntil": "2025-01-05T14:00:00.000Z",
                "isoTypeCode": "45G1",
                "loadStatus": "full",
                "moveType": "import"
            }
        },
        "address": "0x79ED95e778d1C3284636Ab0Be741Ce6836252Fb0",
        "deleted": false,
        "blocked": false,
        "encryptedPin": "18570bfece4999db5cd9b6102f9cff472acb5d7e1470bdde8a03cc3db01a6dc1aaf7e132984e7b2b6d7a07aa021f79c833636d8d9bfe4a62a3bef06567b701c579673768ad435d216050edda2f2b99709cc542b65c226f0bfd4f30c8500a4eba300cd538bc565409fe01d01d0d0c23d42bab76c7efe283e89f6e94a5f1b663141aecfe3a97bfeb826996656f622d97e05d4dd7f950f15a9312c507a90ed58f435b13878adf09d2c727fb518ba8d566bbb8c9a9fb2a1a6fefa73a55ec6bc05b14dc6f3cacd201a941f9af018ab1e54f88e0d031e92968a99fa16f9359b8fb943409736f7d2d20ee0011ed1a817e1a12cd760b9473077b6daa533521563dcaf322d6674a4b4417dd09a42a228211289bfedcd07529f983cd26387abfe2b1cd4b6817635d788d6d855104055f7ed6102f0604ac4382204eddfb9e62a9a3c199182319c948d0dabfc62080a93b0c8dac0067431751a4e1e9864fd5d548cd93f9c4edb0b95e0edb500f7846ee05dd13d7578f06c26d11ef107dd0713cc1b42f2e70a75a1a70b5ba107c2eeb6b1aba0723dbf3f8eee674a8ba3ff41da47d9fb91587d9e9c4143f4dadb2c9aa61b444c953720108af392ff3ff85a21542a2100eff453b8c9ffc307200b2fce89a2284716ab14a05b133c22b58359cf9183522fdab46cf033a39c7b262bb7e1015be8c6af837a0a48993a31600db207505f3c9ea1f1c3e",
        "gateOut": null,
        "createdAt": "2021-12-20T14:17:05.623Z",
        "updatedAt": "2022-02-16T08:52:13.251Z",
        "owner": "0x79F98099b2Bf4e5a47244E0cDba500F68b567ce5",
        "creator": "0xa2039dC115B5904c224FEc057684fcCcc88E2f05",
        "greenLights": {
            "total": "green",
            "events": {
                "customs": {
                    "color": "green",
                    "value": "released",
                    "updatedAt": "2023-07-10 13:00"
                },
                "pickuplight": {
                    "color": "gray",
                    "value": "unknown",
                    "updatedAt": ""
                },
                "gateoperation": {
                    "color": "green",
                    "value": "gateoutreceived",
                    "updatedAt": "2023-07-12 14:16"
                },
                "terminalready": {
                    "color": "green",
                    "value": "released",
                    "updatedAt": "2023-07-10 12:00"
                },
                "customsprogress": {
                    "color": "gray",
                    "value": "unknown",
                    "updatedAt": ""
                },
                "commercialrelease": {
                    "color": "green",
                    "value": "ok",
                    "updatedAt": "2023-07-05 13:37"
                },
                "terminaloperation": {
                    "color": "green",
                    "value": "discharged",
                    "updatedAt": "2023-07-10 11:50"
                }
            },
            "source": "NxtPort"
        },
        "version": "1.2.1",
        "pinRetrieved": false,
        "previousOwner": "0xa2039dC115B5904c224FEc057684fcCcc88E2f05",
        "nextOwner": null,
        "conditions": []
    }
]
```

{% endtab %}
{% endtabs %}
