...

DistributorID M

Element

Type

Mandatory / Optional

Length

Direction

Comments

AccountID

int

Status

colour	Red
title	M

-

AccountID retrieved from Session.

DistributorID

int

M

-

Status


colour	Green
title	BOTH

AccountID retrieved from Session.

OnForwarderCloseAt

intTime

O

Status

-

Not required when Service is provided.

ConsignmentID

long

O

-

ID of the record in the OneFlo database.

Not required on creation.

When updating an existing consignment, provide the ConsignmentID.

ConsignmentDate

DateTime

M

-

colour	Red
title	M

-

Status


colour	Green
title	BOTH

hh:mm

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

ConsignmentDate

DateTime

Status

colour	Red
title	M

-

Status


colour	Green
title	BOTH

Date of the creation of the consignment.

Released

DateTime

ConsignmentType

string

Status

title	O

-

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.

ConsignmentNote

string

O

20

Service

string

M

10

Service for use. Must be a service defined in OneFlo as retrieved from the ShipperService Element of the ServicePricing.

Sender

Address

M

1

Details of the sender of the freight.

PickupInstructions

string

O

80

Pickup Instructions. Will appear on Pickup request data when carrier is configured.

Receiver

Address

M

1

Details of the receiver of the freight.

DeliveryInstructions

string

O

80

Delivery Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate).

SpecialInstructions

string

O

80

Additional Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate).

Description

string

O

30

Description of Consignment. Won't appear on labels.

Ext

ConsignmentsExt

O

0...1

Additional information for a consignment.

Hours

float

O

-

Default 0.

NoItems

short

M

-

Item Count Summary for the consignment.

Volume

float

M

-

Total Consignment Volume in cubic metres.

Weight

float

M

-

Total Consignment weight in kilograms.

ConsignmentItems

ConsignmentItem[]

M

1...n

Details the items included in the consignment.

ReadyAt

Time

M

-

hh:mm

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

CloseAt

Time

M

-

hh:mm

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

Reference

string

O

20

Stores the primary business reference (i.e. Sales Order Number, Pick Number, etc)

References

Reference[]

O

0...n

Additional References.

ModifiedBy

int

M

-

UserID as defined in the session.

SessionID

long

O

-

Not recommended for use.

ExtraInfo

string

O

-

Not recommended for use.

ConsolidatedSus

ConsolidateConsignment[]

O

-

Not recommended for use.

ContainingConsignment

long

O

-

Not recommended for use.

DownloadID

int

O

-

Not recommended for use.

ConsignmentType

string

O

-

Not recommended for use.

Exception

SaveException

O

-

Output. Provides detail on the result if there is an error with the data provided.

...

Status

colour	Blue
title	OUTPUT

Not recommended for use.

ConsignmentID

long

Status

title	O

-

Status


colour	Green
title	BOTH

ID of the record in the OneFlo database.

Not required on creation.

When updating an existing consignment, provide the ConsignmentID.

ConsignmentItems

ConsignmentItem[]

Status

colour	Red
title	M

1...n

Status


colour	Green
title	BOTH

Details the items included in the consignment.

ConsignmentNote

string

Status

title	O

20

Status


colour	Green
title	BOTH

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

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

ConsolidatedSus

ConsolidateConsignment[]

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Not recommended for use.

ContainingConsignment

long

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Not recommended for use.

DeliveryInstructions

string

Status

title	O

80

Status


colour	Green
title	BOTH

Delivery Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate).

Description

string

Status

title	O

30

Status


colour	Green
title	BOTH

Description of Consignment. Won't appear on labels.

DistributorID

int

Status

colour	Red
title	M

-

Status


colour	Green
title	BOTH

DistributorID retrieved from Session.

DownloadID

int

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Not recommended for use.

Exception

SaveException

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Output. Provides detail on the result if there is an error with the data provided.

Ext

ConsignmentsExt

Status

title	O

0...1

Status


colour	Green
title	BOTH

Additional information for a consignment.

ExtraInfo

string

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Not recommended for use.

Hours

float

Status

title	O

-

Status


colour	Green
title	BOTH

Default 0.

ModifiedBy

int

Status

colour	Red
title	M

-

Status


colour	Green
title	BOTH

UserID as defined in the session.

NoItems

short

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Item Count Summary for the consignment. Computed from the data provided in ConsignmentItems.

OnForwarder

int

Status

title	O

-

Status


colour	Green
title	BOTH

Not required when Service is provided.

PickupInstructions

string

Status

title	O

80

Status


colour	Green
title	BOTH

Pickup Instructions. Will appear on Pickup request data when carrier is configured.

ReadyAt

Time

Status

colour	Red
title	M

-

Status


colour	Green
title	BOTH

hh:mm

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

Receiver

Address

Status

colour	Red
title	M

1

Status


colour	Green
title	BOTH

Details of the receiver of the freight.

Reference

string

Status

title	O

20

Status


colour	Green
title	BOTH

Stores the primary business reference (i.e. Sales Order Number, Pick Number, etc)

References

Reference[]

Status

title	O

0...n

Status


colour	Green
title	BOTH

Additional References.

Released

DateTime

Status

colour	Red
title	M

-

Status


colour	Green
title	BOTH

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.

Sender

Address

Status

colour	Red
title	M

1

Status


colour	Green
title	BOTH

Details of the sender of the freight.

Service

string

Status

colour	Red
title	M

10

Status


colour	Green
title	BOTH

Service for use. Must be a service defined in OneFlo as retrieved from the ShipperService Element of the ServicePricing.

SessionID

long

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Not recommended for use.

SpecialInstructions

string

Status

title	O

80

Status


colour	Green
title	BOTH

Additional Instructions. Will appear on labels (depending on carrier specification may be limited in terms of number of characters due to real estate).

Volume

float

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Total Consignment Volume in cubic metres. Computed from the data provided in ConsignmentItems.

Weight

float

Status

title	O

-

Status

colour	Blue
title	OUTPUT

Total Consignment weight in kilograms. Computed from the data provided in ConsignmentItems.

Legend:

Mandatory

Determine if the element is required when using this ComplexType.

Status

colour	Red
title	M

Element must be declared.

Status

title	O

Element may be omitted.

Direction

Determine when the element is used.

Status


colour	Green
title	BOTH

Provided as both input and response from the Web Service

Status

colour	Blue
title	OUTPUT

Only provided as a response from Web Service

Example

Code Block

language	xml
theme	RDark
linenumbers	true

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
	<soapenv:Header/>
	<soapenv:Body>
		<cha:SaveConsignment>
			<cha:session>
				<cha:AccountID>115860</cha:AccountID>
				<cha:DistributorID>101605</cha:DistributorID>
				<cha:Expires>2018-09-18T15:30:14.923</cha:Expires>
				<cha:Key>3A1D47BB-40F7-4C71-ADAC-0689A298576B</cha:Key>
				<cha:UserID>64796</cha:UserID>
			</cha:session>
			<cha:consignment>
				<cha:AccountID>115860</cha:AccountID>
				<cha:CloseAt>16:00</cha:CloseAt>
				<cha:ConsignmentDate>2018-09-18T16:00:00</cha:ConsignmentDate>
				<cha:ConsignmentID>0</cha:ConsignmentID>
				<cha:ConsignmentItems>
					<!--Zero or more repetitions:-->
					<cha:ConsignmentItem>
						<cha:Barcode>QRX11236-001</cha:Barcode> <!--unique item code linked to connote as printed on label -->
						<cha:ConsignmentID>0</cha:ConsignmentID>
						<cha:Description>QRX11236</cha:Description>
						<cha:Height>100</cha:Height>
						<cha:ItemNo>1</cha:ItemNo>
						<cha:ItemType>CARTON</cha:ItemType>
						<cha:Length>100</cha:Length>
						<cha:NoItems>1</cha:NoItems>
						<cha:Volume>0.001</cha:Volume>
						<cha:Weight>5</cha:Weight>
						<cha:Width>100</cha:Width>
					</cha:ConsignmentItem>
				</cha:ConsignmentItems>
				<cha:ConsignmentNote>QRX11236</cha:ConsignmentNote>
				<cha:ConsignmentType/>
				<cha:ConsolidatedSus>
		               <cha:ConsolidateConsignment>
		                  <cha:Height>10</cha:Height>
		                  <cha:ItemType>CARTON</cha:ItemType>
		                  <cha:Items>2</cha:Items>
		                  <cha:Length>10</cha:Length>
		                  <cha:Volume>10</cha:Volume>
		                  <cha:Weight>15</cha:Weight>
		                  <cha:Width>20</cha:Width>
		               </cha:ConsolidateConsignment>
		            </cha:ConsolidatedSus>
				<cha:ContainingConsignment>0</cha:ContainingConsignment>
				<cha:DeliveryInstructions>TEST DEL</cha:DeliveryInstructions>
				<cha:Description>Description</cha:Description>
				<cha:DistributorID>101605</cha:DistributorID>
				<cha:DownloadID>0</cha:DownloadID>

				<cha:Ext>
					<cha:ConsignmentID>0</cha:ConsignmentID>
					<cha:CostCenter/>
					<cha:ThirdPartyAccount/>
					<cha:UserField1/>
					<cha:UserField2/>
					<cha:UserField3/>
					<cha:UserField4/>
					<cha:UserField5/>
				</cha:Ext>
				<cha:ExtraInfo/>
				<cha:Hours>0</cha:Hours>
				<cha:ModifiedBy>64796</cha:ModifiedBy>
				<cha:NoItems>1</cha:NoItems>
				<cha:OnForwarder>102261</cha:OnForwarder>
				<cha:PickupInstructions>Test PICK</cha:PickupInstructions>
				
				<cha:ReadyAt>13:00</cha:ReadyAt>
				<cha:Receiver>
					<cha:AccountID>115860</cha:AccountID>
					<cha:AddressID>0</cha:AddressID>
					<cha:AddressLocation>
						<cha:LocationID>0</cha:LocationID>
						<cha:Locality>MELBOURNE</cha:Locality>
						<cha:State>VIC</cha:State>
						<cha:Postcode>3000</cha:Postcode>
						<cha:CountryCode>AU</cha:CountryCode>
						<cha:SuburbStatePostcode>MELBOURNE VIC 3000</cha:SuburbStatePostcode>
					</cha:AddressLocation>
					<cha:Line1>123 Test ST</cha:Line1>
					<cha:Line2/>
					<cha:LocationID>0</cha:LocationID>
					<cha:ModifiedBy>64796</cha:ModifiedBy>
					<cha:ContactName>Dennis</cha:ContactName>
					<cha:Email>dennis@efmlogistics.com.au</cha:Email>
					<cha:Name>HELLO WORLD</cha:Name>
					<cha:Phone>01000000</cha:Phone>

				</cha:Receiver>
				
				<cha:Reference>123456</cha:Reference>
				<cha:References>
					<!--Zero or more repetitions:-->
					<cha:Reference>
						<cha:ConsignmentReference/>
						<cha:RemoveReference>0</cha:RemoveReference>
					</cha:Reference>
				</cha:References>
				<cha:Released>2018-09-05T16:10:00</cha:Released>
				<cha:Sender>
		               <cha:AccountID>115860</cha:AccountID>
		               <cha:AddressID>0</cha:AddressID>
		               <cha:AddressLocation>
		                  <cha:LocationID>0</cha:LocationID>
		                  <cha:Locality>GLEN WAVERLEY</cha:Locality>
		                  <cha:State>VIC</cha:State>
		                  <cha:Postcode>3150</cha:Postcode>
		                  <cha:CountryCode>AU</cha:CountryCode>
		                  <cha:SuburbStatePostcode>GLEN WAVERLEY VIC 3150</cha:SuburbStatePostcode>
		               </cha:AddressLocation>
		               <cha:ContactName>test, user</cha:ContactName>
		               <cha:Email>ed@efm.com</cha:Email>
		               <cha:Line1>c/ EFM</cha:Line1>
		               <cha:Line2></cha:Line2>

		               <cha:LocationID>0</cha:LocationID>
		               <cha:ModifiedBy>64796</cha:ModifiedBy>
		               <cha:Name>OneFlo</cha:Name>
		               <cha:Phone>000000000</cha:Phone>
		               <cha:State>VIC</cha:State>
		               <cha:Suburb>GLEN WAVERLEY</cha:Suburb>
		            </cha:Sender>
		            
				<cha:Service>NPG</cha:Service>
				<cha:SessionID>0</cha:SessionID>
				<cha:SpecialInstructions>TEST SPE</cha:SpecialInstructions>
				<cha:Volume>0.001</cha:Volume>
				<cha:Weight>1</cha:Weight>
			</cha:consignment>
		</cha:SaveConsignment>
	</soapenv:Body>
</soapenv:Envelope>

...

Anchor
complextype_anchor
complextype_anchor
Address

...

Versions Compared

Old Version 3

New Version 4

Key

Example

Anchor
complextype_anchor
complextype_anchor
Address

Page Comparison

Versions Compared

Old Version 3

New Version 4

Key

Example

Anchorcomplextype_anchorcomplextype_anchorAddress

Anchor
complextype_anchor
complextype_anchor
Address