Versions Compared

Key

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

Table of Contents

...

ElementTypeMandatory / OptionalLengthDirectionComments
Barcodestring
Status
titleO
-
Status
colourGreen
titleBOTH
This is the SSCC barcode. If no SSCC is provided, OneFlo will generate a barcode for you.
ConsignmentIDlong
Status
titleO
-
Status
colourGreen
titleBOTH

ID of the record in the OneFlo database.

Not required on creation.

When updating an existing consignment, provide the ConsignmentID.

ConsignmentProductProduct
Status
titleO
-
Status
colourGreen
titleBOTH

This is a complex type for the definition of Dangerous Goods.

Descriptionstring
Status
titleO
40
Status
colourGreen
titleBOTH
A description of the goods being shipped.
ExchangeReturnableboolean
Status
titleO
-
Status
colourBlue
titleOUTPUT

Heightfloat
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH

Height of item in centimetres (cm).

ItemNoint
Status
titleO
-
Status
colourGreen
titleBOTH

The index (starting 1) or otherwise known as ordinal integer.

e.g. if there are 3 packages, this will enumerate package 1, package 2, and package 3

ItemTypestring
Status
colourRed
titleOM
20
Status
colourGreen
titleBOTH

Item Code - could be your warehouse Shipping Unit code (i.e. Carton_12X or CHEP_Pallet)

Lengthfloat
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
Length of item in centimetres (cm).
ModifiedByint
Status
titleO
-
Status
colourBlue
titleOUTPUT

NoItemsint
Status
colourRed
titleM
1...
Status
colourGreen
titleBOTH
Total Number of SUs for the consignment. Must be a positive integer. Ideally when enumerating items, this must have a value of '1'.
PackagingTypestring
Status
colourRed
titleM
20
Status
colourGreen
titleBOTH
Should be one of the available packaging types in OneFlo. Shipping Items - Packaging Type.
Palletisedboolean
Status
titleO
-
Status
colourGreen
titleBOTH
Non-mandatory, please see Packaging Type.
ProductIDint
Status
titleO
-
Status
colourGreen
titleBOTH

Referencestring
Status
titleO
20
Status
colourGreen
titleBOTH
Item Reference associated to the order. This is useful for consolidated items where items need to be identified into which particular order it's under. This can also be used to indicate specifically which references are associated to the shipping unit.
Returnablestring
Status
titleO
20
Status
colourGreen
titleBOTH

Volumefloat
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
Cubic metres (m3). Up to 3 decimal places.
Weightfloat
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
Weight of the item in kilograms (kg).
Widthfloat
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
Width of item in centimetres (cm).

...