MPET
  1. Operator - Handlings
MPET
  • HNA-API
    • Operator - Handlings
      • cancelHandling
        POST
      • createDetachedHandling
        POST
      • createHandling
        POST
      • detachHandling
        POST
      • getDetachedHandling
        POST
      • moveHandling
        POST
      • updateDetachedHandling
        POST
      • updateHandling
        POST
    • Operator - Visits
      • cancelVisit
      • createVisit
      • finalizeLoadDischargeList
      • moveVisit
      • sendLoadDischargeList
      • updateVisit
    • Operator - Voyages
      • cancelVoyage
      • createVoyage
      • getVoyage
      • updateCargoDeclarations
      • updateVoyage
      • updateVoyageRestrictions
    • Listening
      • disconnectClient
      • listenToShipmentUpdates
      • listenToUpdate
      • resetPosition
      • updatePosition
  1. Operator - Handlings

getDetachedHandling

POST
/hna/detachedHandlings:get
Operator - Handlings
Retrieve a handling without a visit
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/hna/detachedHandlings:get' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
{
  "type": "string",
  "declarant": {
    "fullName": "string",
    "shortName": "string",
    "emailAddress": "string",
    "address": "string",
    "city": "string",
    "countryUnCode": "string",
    "countryName": "string",
    "zipCode": "string",
    "phoneNumber": "string",
    "faxNumber": "string",
    "contact": "string",
    "customsEORINumber": "string",
    "ean": "string",
    "chamberOfCommerceNumber": "string",
    "scacCode": "string",
    "scacDisplayCode": "string"
  },
  "modality": "string",
  "handlingId": "string",
  "terminal": {
    "shortName": "string",
    "ean": "string",
    "smdgCode": "string",
    "bicsCode": "string",
    "quayName": "1742",
    "location": {
      "name": "string",
      "locationUnCode": "strin"
    },
    "allowedModalities": [
      "string"
    ],
    "tarRequired": true,
    "roadLicenseIdRequired": true,
    "roadStatusRequestAllowed": true,
    "quaySelectByDeclarantForbidden": true,
    "updateAllowed": true,
    "maxSealNumberLength": 0,
    "acceptAfterRejectForbidden": true,
    "terminalSettings": [
      {}
    ],
    "prenotifyOnlyAfterVisitAccepted": true,
    "prenotificationRestrictedToDeclarants": {}
  },
  "plannedQuay": {
    "shortName": "string",
    "ean": "string",
    "smdgCode": "string",
    "bicsCode": "string",
    "quayName": "1742",
    "location": {
      "name": "string",
      "locationUnCode": "strin"
    },
    "allowedModalities": [
      "string"
    ],
    "tarRequired": true,
    "roadLicenseIdRequired": true,
    "roadStatusRequestAllowed": true,
    "quaySelectByDeclarantForbidden": true,
    "updateAllowed": true,
    "maxSealNumberLength": 0,
    "acceptAfterRejectForbidden": true,
    "terminalSettings": [
      {}
    ],
    "prenotifyOnlyAfterVisitAccepted": true,
    "prenotificationRestrictedToDeclarants": {}
  },
  "handlingData": {
    "equipmentNumber": "BICU1234565",
    "weight": 0,
    "tareWeight": 0,
    "sealNumber": "string",
    "reefer": {
      "temperatureFixed": true,
      "temperature": -999,
      "minimumTemperature": -999,
      "maximumTemperature": -999
    },
    "outOfGauge": {
      "left": 0,
      "front": 0,
      "height": 0,
      "right": 0,
      "rear": 0
    },
    "bookingNumber": "string",
    "shippingCompany": {
      "name": "string",
      "scacCode": "stri",
      "scacDisplayCode": "string",
      "smdgCode": "str"
    },
    "sizeType": {
      "code": "22G1",
      "name": "20'x8'x8'6\\\" General Purpose Container"
    },
    "type": "LOADING",
    "full": true,
    "shippersOwned": true,
    "humidity": 0,
    "doorOpen": true,
    "chainWork": true,
    "generator": true,
    "damageRemark": "string",
    "previousPort": "string",
    "remarks": "Connected reefer",
    "category": "string",
    "nextPort": "string",
    "finalPort": "string",
    "modality": "TRUCK",
    "totalContainerWeight": 0,
    "deepSea": {
      "shipName": "string",
      "imoCode": "string",
      "crnNumber": "string"
    },
    "inlandTerminal": {
      "name": "string",
      "location": {
        "name": "string",
        "locationUnCode": "strin"
      }
    },
    "transportNumber": "string"
  },
  "handlingStatus": {
    "equipmentNumber": "string",
    "weight": 0,
    "tareWeight": 0,
    "sealNumber": "string",
    "reefer": {
      "temperatureFixed": true,
      "temperature": -999,
      "minimumTemperature": -999,
      "maximumTemperature": -999
    },
    "outOfGauge": {
      "left": 0,
      "front": 0,
      "height": 0,
      "right": 0,
      "rear": 0
    },
    "window": {
      "start": "string",
      "end": "string"
    },
    "dangerousGoods": [
      {
        "name": "string",
        "unCode": "1150",
        "hazardClass": "1",
        "subsidiaryRisk": "1",
        "emsFireCode": "string",
        "emsSpillageCode": "string",
        "properties": "string",
        "segregationGroup": "string",
        "packingGroup": "string",
        "flashPoint": 0
      }
    ],
    "bookingNumber": "string",
    "shippingCompany": {
      "name": "string",
      "scacCode": "stri",
      "scacDisplayCode": "string",
      "smdgCode": "str"
    },
    "sizeType": {
      "code": "22G1",
      "name": "20'x8'x8'6\\\" General Purpose Container"
    },
    "full": true,
    "shippersOwned": true,
    "type": "string",
    "humidity": 0,
    "doorOpen": true,
    "chainWork": true,
    "generator": true,
    "damageRemark": "string",
    "previousPort": "string",
    "remarks": "string",
    "masterBundleContainerNumber": "string",
    "deepSea": {
      "shipName": "string",
      "imoCode": "string",
      "voyageNUmber": "string",
      "eta": "string",
      "etd": "string",
      "expectedDischargeTime": "string",
      "radioCallSign": "string",
      "shipsStayReference": "string"
    },
    "closestBollard": {
      "bicsCode": "string",
      "number": "string",
      "coordinates": {},
      "metersToNextBollard": 0,
      "mooringSide": "port"
    },
    "releaseForModality": "string",
    "documentsPresent": true,
    "notifications": [
      {
        "level": "string",
        "code": "string",
        "description": "string"
      }
    ],
    "equipmentStatusCode": "string",
    "documentNumbers": [
      "string"
    ],
    "damages": [
      {
        "typeOfDamages": "string",
        "damageArea": "string"
      }
    ]
  },
  "eta": "2019-08-24T14:15:22Z",
  "cancelled": true,
  "attached": true,
  "deepSea": {
    "shipName": "string",
    "imoCode": "string",
    "crnNumber": "string",
    "voyageNumber": "string",
    "eta": "string",
    "etd": "string",
    "expectedDischargeTime": "string",
    "radioCallSign": "string",
    "shipsStayReference": "string",
    "cargoOpeningTime": "string",
    "cargoClosingTime": "string",
    "shippingAgent": "string",
    "source": "TERMINAL",
    "lastUpdated": "string"
  },
  "handlingDeclaration": {
    "declarationUsingUpdateBypass": true,
    "cancelForUpdateByPassAcceptedByTerminal": true,
    "status": "string",
    "acceptStatuses": [
      {
        "type": "COMMERCIAL_RELEASE",
        "ok": true,
        "code": "string",
        "remark": "string"
      }
    ],
    "rejectReasons": [
      {
        "code": "string",
        "terminalDescription": "string",
        "parsedReason": "string"
      }
    ]
  }
}

Request

Body Params application/json
handlingId
string 
required
Unique identifier of the handling/container which was generated on the creation of the handling.
Example:
d7727b42-b7d3-490e-aa70-619d7717b1d1
Examples

Responses

🟢200default response
application/json
Body
type
string 
optional
declarant
object 
HnaDeclarant
optional
fullName
string 
optional
The full name of the organisation
shortName
string 
optional
The short name of the organisation
emailAddress
string  | null 
optional
The email address of the organisation
address
string  | null 
optional
The address of the organisation
city
string  | null 
optional
The city where the organisation is located
countryUnCode
string  | null 
optional
The UN code of the country where the organisation is located
countryName
string  | null 
optional
The name of the country where the organisation is located
zipCode
string  | null 
optional
The zip code of the organisation
phoneNumber
string  | null 
optional
The phone number of the organisation
faxNumber
string  | null 
optional
The fax number of the organisation
contact
string  | null 
optional
The contact person of the organisation
customsEORINumber
string  | null 
optional
The EORI number of the organisation, issued by customs
ean
string  | null 
optional
The EAN code of the organisation
chamberOfCommerceNumber
string  | null 
optional
The chamber of commerce number of the organisation
scacCode
string  | null 
optional
The SCAC code of the organisation
scacDisplayCode
string 
optional
modality
string 
optional
handlingId
string 
optional
terminal
object 
HnaResponseTerminal
optional
shortName
string 
optional
Code to identify the Terminal organisation.
ean
string  | null 
optional
European Article Numbering issued by Secure Logistics to identify the Terminal organisation.
smdgCode
string 
optional
Terminal facility code according to the Ship Message Development Group.
bicsCode
string 
optional
quayName
string 
optional
The name of the quay where a vessel can moor for loading, unloading or e.g. awaiting orders.
Example:
1742
location
object 
HnaLocation
optional
allowedModalities
array[string]
optional
tarRequired
boolean 
optional
roadLicenseIdRequired
boolean 
optional
roadStatusRequestAllowed
boolean 
optional
quaySelectByDeclarantForbidden
boolean 
optional
updateAllowed
boolean 
optional
maxSealNumberLength
integer <int32>
optional
acceptAfterRejectForbidden
boolean 
optional
terminalSettings
array [object] 
optional
prenotifyOnlyAfterVisitAccepted
boolean 
optional
prenotificationRestrictedToDeclarants
object 
optional
plannedQuay
object 
HnaResponseTerminal
optional
shortName
string 
optional
Code to identify the Terminal organisation.
ean
string  | null 
optional
European Article Numbering issued by Secure Logistics to identify the Terminal organisation.
smdgCode
string 
optional
Terminal facility code according to the Ship Message Development Group.
bicsCode
string 
optional
quayName
string 
optional
The name of the quay where a vessel can moor for loading, unloading or e.g. awaiting orders.
Example:
1742
location
object 
HnaLocation
optional
allowedModalities
array[string]
optional
tarRequired
boolean 
optional
roadLicenseIdRequired
boolean 
optional
roadStatusRequestAllowed
boolean 
optional
quaySelectByDeclarantForbidden
boolean 
optional
updateAllowed
boolean 
optional
maxSealNumberLength
integer <int32>
optional
acceptAfterRejectForbidden
boolean 
optional
terminalSettings
array [object] 
optional
prenotifyOnlyAfterVisitAccepted
boolean 
optional
prenotificationRestrictedToDeclarants
object 
optional
handlingData
object 
HnaHandlingData
optional
equipmentNumber
string  | null 
required
Container number. Required except for loading empty and depending on terminal setting
Example:
BICU1234565
weight
number <double> | null 
optional
Required depending on terminal setting. The weight of the cargo in kilograms meaning the tare weight of the container excluded
>= 0<= 99999
tareWeight
number <double> | null 
optional
Tare weight of the container itself in kilograms without the weight of the cargo
>= 0<= 99999
sealNumber
string  | null 
optional
Required depending on terminal setting and max length depending on terminal.
The identification number of the container seal.
reefer
object 
HnaReefer
optional
outOfGauge
object 
HnaOutOfGauge
optional
Required depending on terminal setting. The number of centimeters on which the cargo exceeds the dimensions of the container.
bookingNumber
string 
required
The delivery ref for discharge or the release reference for loading of the container at the terminal.
shippingCompany
required
sizeType
object 
HnaSizeType
required
type
enum<string> 
required
Indication whether the container is loaded onto or unloaded from the hinterland means of transport.
Allowed values:
LOADINGDISCHARGE
full
boolean 
optional
Indication whether the container is full or empty.
shippersOwned
boolean 
optional
Indication whether the container identifier is a ISO 6346 compliant container number (apply true when it does not comply).
humidity
number <double> | null 
optional
The humidity for this container in percentage.
doorOpen
boolean  | null 
optional
Indicates whether the door for this container is open.
chainWork
boolean  | null 
optional
Indicates whether chains are needed to load or discharge this container.
generator
boolean  | null 
optional
Indicates whether this container has a generator.
damageRemark
string  | null 
optional
Can be used to communicate detected damage to the container.
previousPort
string  | null 
optional
The code of the port this container departed from before arriving at MPET.
remarks
string  | null 
optional
Remarks regarding this container.
Example:
Connected reefer
category
string  | null 
optional
The category of the container, free text, for example ‘food grade’.
nextPort
string  | null 
optional
The code of the port this container will be shipped to after departing from Antwerp. Only for export containers (discharging).
finalPort
string  | null 
optional
The code of the port which is the final destination for this container, after departing from Antwerp. Only for export containers (discharging).
modality
enum<string> 
optional
The way in which the transportation of the cargo takes place in the hinterland.
Allowed values:
TRUCKBARGERAIL
Example:
barge
totalContainerWeight
number <double> | null 
optional
The total weight of the container, meaning the 'weight' and the 'tareWeight' added.
deepSea
object 
HnaHandlingDataDeepsea
optional
inlandTerminal
object 
HnaInlandTerminal
optional
transportNumber
string  | null 
optional
Customer's ref number of the hinterland transport.
handlingStatus
object 
HnaHandlingStatus
optional
equipmentNumber
string 
optional
weight
integer <int32>
optional
tareWeight
integer <int32>
optional
sealNumber
string 
optional
reefer
object 
HnaReefer
optional
outOfGauge
object 
HnaOutOfGauge
optional
Required depending on terminal setting. The number of centimeters on which the cargo exceeds the dimensions of the container.
window
object 
HnaWindow
optional
dangerousGoods
array[object (HnaDangerousGoods) {10}] 
optional
bookingNumber
string 
optional
The delivery ref for discharge or the release reference for loading of the container at the terminal.
shippingCompany
optional
sizeType
object 
HnaSizeType
optional
full
boolean 
optional
shippersOwned
boolean 
optional
type
string 
optional
humidity
number <double>
optional
doorOpen
boolean 
optional
chainWork
boolean 
optional
generator
boolean 
optional
damageRemark
string 
optional
previousPort
string 
optional
remarks
string 
optional
masterBundleContainerNumber
string 
optional
deepSea
object 
HnaDeepsea
optional
closestBollard
object 
HnaBollard
optional
releaseForModality
string 
optional
documentsPresent
boolean 
optional
notifications
array[object (HnaNotification) {3}] 
optional
equipmentStatusCode
string 
optional
documentNumbers
array[string]
optional
damages
array[object (HnaDamages) {2}] 
optional
eta
string <date-time>
optional
cancelled
boolean 
optional
attached
boolean 
optional
deepSea
object 
HnaDeepseaVoyage
optional
shipName
string 
optional
imoCode
string 
optional
crnNumber
string 
optional
voyageNumber
string 
optional
eta
string 
optional
etd
string 
optional
expectedDischargeTime
string 
optional
radioCallSign
string 
optional
shipsStayReference
string 
optional
cargoOpeningTime
string 
optional
cargoClosingTime
string 
optional
shippingAgent
string 
optional
source
enum<string> 
optional
Allowed values:
TERMINALAGENT
lastUpdated
string 
optional
handlingDeclaration
object 
HnaHandlingDeclaration
optional
declarationUsingUpdateBypass
boolean 
optional
cancelForUpdateByPassAcceptedByTerminal
boolean 
optional
status
string 
optional
acceptStatuses
array[object (HnaAcceptStatus) {4}] 
optional
rejectReasons
array[object (HnaRejectReason) {3}] 
optional
Modified at 2024-08-19 11:18:45
Previous
detachHandling
Next
moveHandling
Built with