Skip to main content
inputAdvanceShippingNoticePackageCreationInput

Fields

clientId
String

A temporary identifier chosen by the client to find the package in the answer. It is not stored.

packageNumber
Int

The number of the package within the notice, 1 or more and unique in it. When omitted: the highest number of the notice plus 1.

status
AdvanceShippingNoticePackageStatus

Where the package stands. It is a plain note; nothing reacts to it. When omitted: 'Announced'.

freightType
AdvanceShippingNoticeFreightType

How the package is shipped. When omitted: 'Parcel'.

carrierName
String

The name of the carrier as free text. It must not contain control characters. Null or an empty text stores none; it is then read as null.

trackingNumber
String

The tracking number of the carrier.

trackingUrl
String

The tracking URL of the carrier.

shippedAt
DateTime

When the supplier shipped the package.

expectedDeliveryDate
DateTime

When the package is expected.

weight
Decimal

The weight in kilograms, 0 to 1,000,000.

width
Decimal

The width, 0 to 1,000,000. Centimetres by convention; the ERP stores no unit and does not convert.

height
Decimal

The height, 0 to 1,000,000. Centimetres by convention; the ERP stores no unit and does not convert.

depth
Decimal

The depth, 0 to 1,000,000. Centimetres by convention; the ERP stores no unit and does not convert.

pieceCount
Int

The number of freight pieces, 0 or more.

identifiers
[AdvanceShippingNoticePackageIdentifierInput]!
required

The identifiers of the package. Empty or omitted: none.

note
String

A note on the package. Null or an empty text stores none; it is then read as null.