Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Level

Name

Required

Type

Description

Applicable Ports

0

header

PreadviceHeader

No-

Pre-advice header information

1

ShipperNameshipperName

Mandatory

string

Shipper name

ALL

1

ConsigneeNameconsigneeName

Optional

string

Consignee name

NZTRG / NZTIU

1

BookingReferencebookingReference

Mandatory

string

Booking reference

ALL

1

MessageActionmessageAction

Mandatory

string (Create/Cancel)

Message action type

ALL

1

PointOfOriginCodepointOfOriginCode

Mandatory

string

Point of origin code

ALL

1

LoadPortFacilityloadPortFacility

Mandatory

string

Load port facility

ALL

1

Vesselvessel

Mandatory

GenericPreadviceVessel

Vessel information

ALL

2

shipName

Conditional

string

Vessel Name

ALL

2

voyageNumber

Conditional

string

Voyage Number

ALL

2

partnerPortShippingReference

Conditional

string

Port Vessel reference

ALL

1

NotificationEmailsnotificationEmails

Mandatory

string[]

List of notification email addresses

ALL

1

UserNameuserName

Mandatory

string

User name

ALL

1

UserReferenceuserReference

Mandatory

string

User reference

ALL

1

LineOperatorCodelineOperatorCode

Mandatory

string

Line operator code

ALL

1

LoadPortCodeloadPortCode

Mandatory

string

Load port code

ALL

1

PortOfDischargeportOfDischarge

Mandatory

string

Port of discharge

ALL

1

ForeignPortOfDischargeforeignPortOfDischarge

Optional

string

Foreign port of discharge

ALL

1

OverseasDestinationFinaloverseasDestinationFinal

Optional

string

Overseas destination final

ALL

...

Level

Name

Required

Repeats

Type

Description

Applicable Ports

0

containers

PreadviceContainer[]Mandatory

Yes

List of container information

ALL

1

ContainerNumbercontainerNumber

Mandatory

No

string

Container number

ALL

1

AttachedContainerNumbersattachedContainerNumbers

Optional

No

List<string>

List of attached container numbers

NZTRG / NZTIU

1

IsoTypeCodeisoTypeCode

Mandatory

No

string

ISO type code for the container

ALL

1

FlexiTankflexiTank

Optional

No

bool?

Indicates if the container is a flexi tank

NZTRG / NZTIU

1

IsFullisFull

Mandatory

No

bool?

Indicates if the container is full

ALL

1

CommodityCodecommodityCode

Mandatory

No

string

Commodity code

ALL

1

IsNonOperatingReeferisNonOperatingReefer

Optional

No

bool?

Indicates if the container is a non-operating reefer

ALL

1

Refrigerationrefrigeration

Optional

No

GenericPreadviceRefrigeration

Refrigeration details for the container.

Only required if container ISO Type is a Reefer ISO type

ALL

2

isFantainer

Optional

No

bool?

ALL

2

co2Percent

Optional

No

float

ALL

2

o2Percent

Optional

No

float

ALL

2

humidityPercent

Optional

No

float

ALL

2

requiredTemperature

Conditional

No

float

ALL

2

refrigerationType

Optional

No

string

2“Chilled”

humidityPercent

OptionalALL

No

2

RefrigerationTypeoffPowerTemperature

Optional

No

string

“Chilled”

2

offPowerTemperature

Optional

No

float

NZAKL

2

offPowerTimestamp

Optional

No

DateTime

NZAKL

2

onPowerTargetTime

Optional

No

DateTime

NZAKL

1

Ventvent

Optional

No

GenericPreadviceVent

Vent details for the container

ALL

2

ventSettingType

Optional

No

string

ALL

2

ventSetting

Optional

No

float

ALL

1

CargoWeightKgcargoWeightKg

Mandatory

No

float

Cargo weight in kilograms

ALL

1

TotalWeightKgtotalWeightKg

Mandatory

No

float

Total weight of the container in kilograms

ALL

1

Hazardoushazardous

Optional

No

GenericPreadviceHazardous[]

List of hazardous details

ALL

2

hazardousClass

Conditional

Yes

float

ALL

2

unNumber

Conditional

Yes

string

ALL

2

packagingGroup

Conditional

Yes

string

ALL

2

limitedQuantities

Conditional

Yes

bool

ALL

2

marinePollutant

Conditional

Yes

bool

ALL

2

hazardousWeight

Conditional

Yes

float

ALL

2

quantity

Conditional

YesYes

float

ALL

2

emsCode

Conditional

Yes

string

ALL

2

hazardContact

Conditional

Yes

string

ALL

3

name

Conditional

Yes

string

ALL

3

phone

Conditional

Yes

string

ALL

2

medicalFirstAidGuideSet

Conditional

Yes

TRGstring

NZTRG / TIUNZTIU

2

flashPointSet

Conditional

Yes

TRGfloat

NZTRG / TIUNZTIU

1

OverGaugeoverGauge

Optional

No

GenericPreadviceOverDimension[]

List of over-dimension details

ALL

2

area

Conditional

Yes

String

TOP, LEFT, RIGHT, FRONT, BACK

ALL

2

measureCm

Conditional

Yes

float

ALL

1

ContainerSealscontainerSeals

Mandatory

No

GenericPreadviceContainerSeal[]

List of container seals

ALL

2

sealType

Mandatory

Yes

string

ALL

2

sealCode

Mandatory

Yes

string

ALL

1

ArrivalCarrierTypearrivalCarrierType

Mandatory

No

GenericPreadviceArrivalCarrierTypes?

Arrival carrier type

ALL

1

Carriercarrier

Mandatory

No

string

Carrier details

ALL

1

HazardousCertificateBase64hazardousCertificateBase64

Optional

No

string

Base64 encoded hazardous certficate

NZTRG / NZTIU

Test URL:

Code Block
POST https://apitest.portconnect.io/v1/export-preadvices

...

Code Block
languagejson
{
  "header": {
    "shipperName": "ALNEMAH HALAL MEAT LIMITEDSHIPPERCODEA",
    "bookingReference": "1AKL026740",
    "lineOperatorCode": "HSUD",
    "loadPortCode": "NZTRG",
    "portOfDischarge": "USLGB",
    "foreignPortOfDischarge": "USLGB"
    "pointOfOriginCode": "Bay of Plenty",
    "loadPortFacility": "TCT",
    "vessel": {
      "shipName": "DEBUSSY",
      "voyageNumber": "138N",
      "partnerPortShippingReference": "USY138N",
    },
    "notificationEmails": [
      "Cameron.Pitches@portconnect.co.nz"
    ],
    "userReference": "CAMTEST001"
  },
  "containers": [
    {
      "containerNumber": "CDPU3736837",
      "isoTypeCode": "2200",
      "flexiTank": false,
      "isFull": true,
      "commodityCode": "0201"
      },
      "cargoWeightKg": 28000.0,
      "totalWeightKg": 30000.0,
      "containerSeals": [
        {
          "sealType": "Shipper",
          "sealCode": "555"
        }
      ],
      "arrivalCarrierType": "Truck"
    }
  ]
}

...