Versions Compared

Key

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

Table of Contents

...

ElementTypeMandatory / OptionalLengthDirectionComments
AccountIDint
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
AccountID retrieved from Session.
AllowConsolidationbool
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH

true/false : Indicates whether a consignment can be consolidated.

If it's the first consignment for the day going to a receiver and service, a new consignment will be created. Succeeding consignments going to the same receiver and same service, the new items in this consignment will be appended to the previous consignment (that allows consolidation) and using the same connote number. This doesn't apply to consignments with Dangerous Goods.

CloseAtTime
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH

hh:mm

Time when the facilities will close (for pickup). Will be reflected on the Pickup Request and consignment data sent to carrier.

ConsignmentDateDateTime
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
Date of the creation of the consignment.






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.

ConsignmentItemsConsignmentItem[]
Status
colourRed
titleM
1...n
Status
colourGreen
titleBOTH
Details the items included in the consignment.
ConsignmentNotestring
Status
titleO
20
Status
colourGreen
titleBOTH

When provided, the consignment will be created with the provided Connote number.

When not provided, OneFlo will generate a new connote number from the range.

ConsignmentTypestring
Status
titleO
-
Status
colourBlueGreen
titleOUTPUT
Not recommended for use
BOTH

Indicates the consignment movement:

Populate with "Pickup" for Outbound; "Return" for returns; and, "Transfer" for transfers.

ConsolidatedSusConsolidateConsignment[]
Status
titleO
-
Status
colourBlue
titleOUTPUT
Not recommended for use.
ContainingConsignmentlong
Status
titleO
-
Status
colourBlue
titleOUTPUT
Not recommended for use.
DeliveryInstructionsstring
Status
titleO
80
Status
colourGreen
titleBOTH
Delivery Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate).
Descriptionstring
Status
titleO
30
Status
colourGreen
titleBOTH
Description of Consignment. Won't appear on labels.
DistributorIDint
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
DistributorID retrieved from Session.
DownloadIDint
Status
titleO
-
Status
colourBlue
titleOUTPUT
Not recommended for use.
ExceptionSaveException
Status
titleO
-
Status
colourBlue
titleOUTPUT
Output. Provides detail on the result if there is an error with the data provided.
ExtConsignmentsExt
Status
titleO
0...1
Status
colourGreen
titleBOTH
Additional information for a consignment.
ExtraInfostring
Status
titleO
-
Status
colourBlue
titleOUTPUT
Not recommended for use.
Hoursfloat
Status
titleO
-
Status
colourGreen
titleBOTH
Default 0.
ModifiedByint
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
UserID as defined in the session.
NoItemsshort
Status
titleO
-
Status
colourBlue
titleOUTPUT
Item Count Summary for the consignment. Computed from the data provided in ConsignmentItems. 
OnForwarderint
Status
titleO
-
Status
colourGreen
titleBOTH
Not required when Service is provided.
PickupInstructionsstring
Status
titleO
80
Status
colourGreen
titleBOTH
Pickup Instructions. Will appear on Pickup request data when carrier is configured.
ReadyAt

Time

Status
colourRed
titleM
-
Status
colourGreen
titleBOTH

hh:mm

Time when the consignment is ready to be picked up. Will be reflected on Pickup Request and cosignment data sent to carrier.

ReceiverAddress
Status
colourRed
titleM
1
Status
colourGreen
titleBOTH
Details of the receiver of the freight.
Referencestring
Status
titleO
20
Status
colourGreen
titleBOTH
Stores the primary business reference (i.e. Sales Order Number, Pick Number, etc)
ReferencesReference[]
Status
titleO
0...n
Status
colourGreen
titleBOTH
Additional References.
ReleasedDateTime
Status
colourRed
titleM
-
Status
colourGreen
titleBOTH
Date of the release of the consignment, must be provided but will be updated by the system when the consignment is actually released via the Release*Consignment API.
SenderAddress
Status
colourRed
titleM
1
Status
colourGreen
titleBOTH
Details of the sender of the freight.
Servicestring
Status
colourRed
titleM
10
Status
colourGreen
titleBOTH
Service for use. Must be a service defined in OneFlo as retrieved from the ShipperService Element of the ServicePricing.
SessionIDlong
Status
titleO
-
Status
colourBlue
titleOUTPUT
Not recommended for use.
SpecialInstructionsstring
Status
titleO
80
Status
colourGreen
titleBOTH
Additional Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate).
Volumefloat
Status
titleO
-
Status
colourBlue
titleOUTPUT
Total Consignment Volume in cubic metres. Computed from the data provided in ConsignmentItems.
Weightfloat
Status
titleO
-
Status
colourBlue
titleOUTPUT
Total Consignment weight in kilograms. Computed from the data provided in ConsignmentItems.

...

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. It's not mandatory to provide this because OneFlo will assign it upon saving.

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

Because the representation of each item must be declared in a ConsignmentItem element, this field must always have the value of '1'.

Multiple items of the same type must be declared in separate ConsignmentItem elements.

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).

...