createDetachedHandling

POST

/hna/detachedHandlings:create

Operator - Handlings

Create a handling which is not attached to a visit.

Request

Body Params application/json

terminal

object (HnaTerminal)

required

The terminal location at which the container will be loaded or discharged. Terminal must support the given modality. Only one subfield is required.

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

Terminal code according to the Terminal code table

quayName

string

optional

The name of the quay where a vessel can moor for loading, unloading or e.g. awaiting orders.

Example:

1742

handlingData

object (HnaHandlingData)

required

Cargo handling details as requested by the declarant for the given modality.

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/hna/detachedHandlings:create' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200default response

application/json

Body

handlingId

string

required

Unique identifier of the handling/container which was generated on the creation of the handling.

Example:

d7727b42-b7d3-490e-aa70-619d7717b1d1

Example

{
  "handlingId": "d7727b42-b7d3-490e-aa70-619d7717b1d1"
}

Modified at 2024-08-19 11:18:45

cancelHandling

createHandling