Versions Compared

Key

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

Purpose

Create/Save a consignment within the OneFlo System. This information will be stored within OneFlo, for Label Generation, Manifesting and Booking. subsequent steps can be done Manually in the App or via API


Info

In this instance I am making a call to GetChargeQuote in my uat environment through postman, Things I need to perform this call:

  1. My Session Credentials form my previous Login Call
    1. Note Session Credentials will expire If
      1. You Have generated a new "Key"
      2. You Have Passed the Expiry Date of the Session
      3. The User has been Deleted/made inactive
  2. Your package/quote information


*Learn how to chain this call in 5) Creating Chained Requests

Endpoint: https://bau-uat-wsthirdpartywcf.azurewebsites.net/Data/ChainITflipgroup.com.au/DataService.svc

This is not the production endpoint. The production endpoint will be provided once all requests have been validated to work correctly.

...

Code Block
languagexml
themeRDark
firstline1
titleWeb Service CallComplex Type Details
linenumberstrue
collapsetrue
This is a complex type. For field information, please see https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/716570801/2-0+Complex+Types#id-2-0)ComplexTypes-complextype_consignmentConsignment

...

Code Block
collapse
languagexml
themeRDark
firstline1
titleWeb Service Call
linenumberstruetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"  xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
  	  <soapenv:Header/>
  	  <soapenv:Body>
		<SaveConsignment>
			<session>
				
        <SaveConsignment>
         <session>
            <AccountID>{{AccountID}}</AccountID>
				            <DistributorID>{{DistributorID}}</DistributorID>
				
            <Expires>{{Expires}}</Expires>
				
            <Key>{{Key}}</Key>
				
            <UserID>{{UserID}}</UserID>
			         </session>
			<consignment>
				
            <consignment>
                <AccountID>{{AccountID}}</AccountID>
				
                <AllowConsolidation>true</AllowConsolidation>
				
                <CloseAt>16:00</CloseAt>
				<ConsignmentDate>2018-08-02 10:09:00</ConsignmentDate>
				<ConsignmentItems>
					<ConsignmentItem>
						<ConsignmentProduct>
							<Cubic>0.0152</Cubic>
							<DangerousGoods>
								<AggQty>4</AggQty>
								<Class>2.1</Class>
								<Group>NONE</Group>
								<Name>AEROSOLS</Name>
								<PSN>AEROSOLS IN A CAN</PSN>
								<Qty>1</Qty>
								<Receptacle>CAN</Receptacle>
								<SubRisk>N/A</SubRisk>
								<UnCode>1950</UnCode>
								<Units>kg</Units>
							</DangerousGoods>
						</ConsignmentProduct>
						<Description>SMALL CARTON</Description>
						<Height>16</Height>                <ConsignmentDate>2019-10-19</ConsignmentDate>
                <ConsignmentItems>
                    <ConsignmentItem>
                        <ConsignmentProduct>
                            <Cubic>0.0152</Cubic>
                            <DangerousGoods>
                                <AggQty>4</AggQty>
                                <Class>2.1</Class>
                                <Group>NONE</Group>
                                <Name>AEROSOLS</Name>
                                <PSN>AEROSOLS IN A CAN</PSN>
                                <Qty>1</Qty>
                                <Receptacle>CAN</Receptacle>
                                <SubRisk>N/A</SubRisk>
                                <UnCode>1950</UnCode>
                                <Units>kg</Units>
                            </DangerousGoods>
                        </ConsignmentProduct>
                        <Description>SMALL CARTON</Description>
                        <Height>16</Height>         
                        <ItemNo>1</ItemNo>          
                        <ItemType>SMALL CARTON</ItemType> 
                        <Length>38</Length>
                        <NoItems>1</NoItems>
                        <PackagingType>CTN</PackagingType> <!-- https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type -->
                        <Reference />
                        <Weight>5</Weight>
                        <Width>25</Width>
                    </ConsignmentItem>
                </ConsignmentItems>
				
                <DeliveryInstructions>Deliver to Front Door.</DeliveryInstructions>
                <Description />
                <DistributorID>101605</DistributorID>
				<Ext>
					<UserField1>123456</UserField1>
				</Ext>
                <ReadyAt>14:00</ReadyAt>
			
			<Receiver>
				<AddressLocation>
                  <Locality>Nunawading</Locality>
                  <State>VIC</State>
                  <Postcode>3131</Postcode>
                  <CountryCode>AU</CountryCode>
				</AddressLocation>
                <ContactName>Peter Test</ContactName>
                <Email>test@email.com</Email>
                <Line1>113 Rooks Rd</Line1>
                <LocationDetails>
                  <Locality>Nunawading</Locality>
                  <State>VIC</State>
                  <Postcode>3131</Postcode>
                  <CountryCode>AU</CountryCode>
                </LocationDetails>
                <Name>Steve</Name>
                <Phone>0425814806</Phone>
                <State>VIC</State>
                <Suburb>Nunawading</Suburb>
            </Receiver>
			
            <Reference>PO123456</Reference>
            <Released>2019-10-19</Released>
			
            <Sender>
               <AccountID>{{AccountID}}</AccountID>
               <AddressLocation>
                  <Locality>Nunawading</Locality>
                  <State>VIC</State>
                  <Postcode>3131</Postcode>
                  <CountryCode>AU</CountryCode>
               </AddressLocation>
               <ContactName>Peter  &amp; O"'"Connor</ContactName>
               <Email>test@email.com</Email>
               <Line1>113 Rooks Rd</Line1>
               <LocationDetails>
                  <Locality>Nunawading</Locality>
                  <State>VIC</State>
                  <Postcode>3131</Postcode>
                  <CountryCode>AU</CountryCode>
               						<ItemNo>1</ItemNo></LocationDetails>
               						<Length>38</Length>
						<NoItems>1</NoItems>
						<Reference />
						<Weight>5</Weight>
						<Width>25</Width>
					</ConsignmentItem>

				</ConsignmentItems>
				<DeliveryInstructions>Deliver to Front Door.</DeliveryInstructions>
				<Description />
				<DistributorID>{{DistributorID}}</DistributorID>
				<ReadyAt>14:00</ReadyAt>
				<Receiver>
					<AddressLocation>
						<CountryCode>AU</CountryCode>
						<SuburbStatePostcode>HALLAM VIC 3803</SuburbStatePostcode>
					</AddressLocation>
					<ATL>false</ATL>
					<Contact>CONTACT PERSON</Contact>
					<Country>AUSTRALIA</Country>
					<CountryCode>AU</CountryCode>
					<Email>hallam@company.com.au</Email>
					<Fax />
					<Line1>89 Wellington Street</Line1>
					<Line2 />
					<Line3 />
					<Name>CUSTOMER F</Name>
					<Phone>03 6334 1000</Phone>

				</Receiver>
				<Reference>PO123456</Reference>
				<Released>2019-08-01T00:00:00</Released>
				<Sender>
					<AddressLocation>
						<CountryCode>AU</CountryCode>
						<SuburbStatePostcode>SCORESBY VIC 3179</SuburbStatePostcode>
					</AddressLocation>

					<Country>AUSTRALIA</Country>
					<CountryCode>AU</CountryCode>
					<Line1>7 Lakeview Drive</Line1>
					<Line2 />
					<Line3 />
					<Name>SENDER ENTITY</Name>
					<Phone />
				</Sender>
				<Service>STEEXP</Service>
				<SpecialInstructions/>
			</consignment>
		</SaveConsignment>
	<Name>Steven Reynolds</Name>
               <Phone>0425814806</Phone>
               <State>VIC</State>
               <Suburb>Nunawading</Suburb>
            </Sender>
			
                <Service>IPECL</Service>
                <SpecialInstructions/>
				
            </consignment>
        </SaveConsignment>
    </soapenv:Body>
</soapenv:Envelope>

...

Code Block
languagexml
themeRDark
firstline1
titleSuccessful Web Service Call Response
linenumberstrue
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <SaveConsignmentResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <SaveConsignmentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <AccountID>116911</AccountID>
                <AllowConsolidation>true</AllowConsolidation>
                <CloseAt>16:08</CloseAt>
                <ConsignmentDate>2018-08-02</ConsignmentDate>
                <ConsignmentID>108802051</ConsignmentID>
                <ConsignmentItems>
                    <ConsignmentItem>
                        <Barcode>TSTZ00000015EXP00001</Barcode>
                        <ConsignmentID>108802051</ConsignmentID>
                        <ConsignmentProduct>
                            <AccountID>0</AccountID>
                            <Code/>
                            <DangerousGoods i:nil="true"/>
                            <DangerousGoodsID>0</DangerousGoodsID>
                            <Error i:nil="true"/>
                            <Height>0</Height>
                            <IsActive>true</IsActive>
                            <Length>0</Length>
                            <Name/>
                            <ProductID>0</ProductID>
                            <Volume>0</Volume>
                            <Weight>0</Weight>
                            <Width>0</Width>
                        </ConsignmentProduct>
                        <Description>SMALL CARTON</Description>
                        <ExchangeReturnable>false</ExchangeReturnable>
                        <Height>16</Height>
                        <ItemNo>1</ItemNo>
                        <ItemType/>
                        <Length>38</Length>
                        <ModifiedBy>0</ModifiedBy>
                        <NoItems>1</NoItems>
                        <ProductID>0</ProductID>
                        <Reference>PO123456</Reference>
                        <Returnable/>
                        <Volume>0.015</Volume>
                        <Weight>5</Weight>
                        <Width>25</Width>
                    </ConsignmentItem>
                </ConsignmentItems>
                <ConsignmentNote>TSTZ00000015</ConsignmentNote>
                <ConsignmentType/>
                <ConsolidatedSus>
                    <ConsolidateConsignment>
                        <Height>16</Height>
                        <ItemType/>
                        <Items>1</Items>
                        <Length>38</Length>
                        <Volume>0.015</Volume>
                        <Weight>5</Weight>
                        <Width>25</Width>
                    </ConsolidateConsignment>
                </ConsolidatedSus>
                <ContainingConsignment>0</ContainingConsignment>
                <DeliveryInstructions>Deliver to Front Door.</DeliveryInstructions>
                <Description/>
                <DistributorID>101605</DistributorID>
                <DownloadID>0</DownloadID>
                <Exception i:nil="true"/>
                <Ext>
                    <ConsignmentID>0</ConsignmentID>
                    <CostCenter/>
                    <ThirdPartyAccount/>
                    <UserField1/>
                    <UserField2/>
                    <UserField3/>
                    <UserField4/>
                    <UserField5/>
                </Ext>
                <ExtraInfo/>
                <Hours>0</Hours>
                <ModifiedBy>0</ModifiedBy>
                <NoItems>1</NoItems>
                <OnForwarder>106008</OnForwarder>
                <PickupInstructions/>
                <ReadyAt>14:00</ReadyAt>
                <Receiver>
                    <ATL>false</ATL>
                    <AccountID>116911</AccountID>
                    <AddressID>11400000</AddressID>
                    <AddressLocation>
                        <LocationID>8017</LocationID>
                        <Locality>HALLAM</Locality>
                        <State>VIC</State>
                        <Postcode>3803</Postcode>
                        <CountryCode>AU</CountryCode>
                        <SuburbStatePostcode>HALLAM VIC 3803</SuburbStatePostcode>
                    </AddressLocation>
                    <ContactName/>
                    <DefaultCarrierAccount i:nil="true"/>
                    <Email>hallam@company.com.au</Email>
                    <Exception i:nil="true"/>
                    <Fax/>
                    <Line1>89 Wellington Street</Line1>
                    <Line2/>
                    <Line3/>
                    <LocationDetails>
                        <LocationID>8017</LocationID>
                        <Locality>HALLAM</Locality>
                        <State>VIC</State>
                        <Postcode>3803</Postcode>
                        <CountryCode>AU</CountryCode>
                        <SuburbStatePostcode>HALLAM VIC 3803</SuburbStatePostcode>
                    </LocationDetails>
                    <LocationID>8017</LocationID>
                    <ModifiedBy>0</ModifiedBy>
                    <Name>CUSTOMER F</Name>
                    <Phone>03 6334 1000</Phone>
                    <State>VIC</State>
                    <Suburb>HALLAM</Suburb>
                </Receiver>
                <Reference>PO123456</Reference>
                <References>
                    <Reference>
                        <ConsignmentReference>PO123456</ConsignmentReference>
                        <RemoveReference>false</RemoveReference>
                    </Reference>
                </References>
                <Released>2019-08-01</Released>
                <Sender>
                    <ATL>false</ATL>
                    <AccountID>116911</AccountID>
                    <AddressID>11399996</AddressID>
                    <AddressLocation>
                        <LocationID>5836</LocationID>
                        <Locality>SCORESBY</Locality>
                        <State>VIC</State>
                        <Postcode>3179</Postcode>
                        <CountryCode>AU</CountryCode>
                        <SuburbStatePostcode>SCORESBY VIC 3179</SuburbStatePostcode>
                    </AddressLocation>
                    <ContactName/>
                    <DefaultCarrierAccount i:nil="true"/>
                    <Email/>
                    <Exception i:nil="true"/>
                    <Fax/>
                    <Line1>7 Lakeview Drive</Line1>
                    <Line2/>
                    <Line3/>
                    <LocationDetails>
                        <LocationID>5836</LocationID>
                        <Locality>SCORESBY</Locality>
                        <State>VIC</State>
                        <Postcode>3179</Postcode>
                        <CountryCode>AU</CountryCode>
                        <SuburbStatePostcode>SCORESBY VIC 3179</SuburbStatePostcode>
                    </LocationDetails>
                    <LocationID>5836</LocationID>
                    <ModifiedBy>0</ModifiedBy>
                    <Name>SENDER ENTITY</Name>
                    <Phone/>
                    <State>VIC</State>
                    <Suburb>SCORESBY</Suburb>
                </Sender>
                <Service>STEEXP</Service>
                <SessionID>0</SessionID>
                <SpecialInstructions/>
                <Volume>0.015</Volume>
                <Weight>5</Weight>
            </SaveConsignmentResult>
        </SaveConsignmentResponse>
    </s:Body>
</s:Envelope>

...


Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@20f86d
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "FLIP"
labelskb-how-to-article

...