2-30) Example Web Service Call (SaveConsignment)

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

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
Your package/quote information

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

Endpoint: https://bau-uat-ws.azurewebsites.net/Data/ChainIT/DataService.svc

Headers:

Key: Content-Type Value: text/xml
Key: SoapAction Value: http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices/IChainITService/SaveConsignment

Body:

Web Service Call

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

  <!-- Session Credentials Available By following the "Login Web Service Call"
                            https://flipgroup.atlassian.net/wiki/spaces/FLIP/pages/703102977/2a+Example+Web+Service+Call+Login-->     
         <cha:session>
            <cha:AccountID>115860</cha:AccountID>
            <!--Mandatory:-->
            <cha:DistributorID>101605</cha:DistributorID>
            <!--Mandatory:-->
            <cha:Expires>2018-08-16T15:15:55.89</cha:Expires>
            <!--Mandatory:-->
            <cha:Key>E36D344D-DCA9-45B8-8FCD-2F049B1E73B3</cha:Key>
            <!--Mandatory:-->
            <cha:UserID>64796</cha:UserID>
            <!--Mandatory:-->
         </cha:session>

         <cha:consignment>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:CloseAt>?</cha:CloseAt>
            <!--Optional:-->
            <cha:ConsignmentDate>?</cha:ConsignmentDate>
            <!--Optional:-->
            <cha:ConsignmentID>?</cha:ConsignmentID>
            <!--Optional:-->
            <cha:ConsignmentItems>
               <!--Zero or more repetitions:-->
               <cha:ConsignmentItem>
                  <!--Optional:-->
                  <cha:Barcode>?</cha:Barcode>
                  <!--Optional:-->
                  <cha:ConsignmentID>?</cha:ConsignmentID>
                  <!--Optional:-->
                  <cha:ConsignmentProduct>
                     <!--Optional:-->
                     <cha:AccountID>?</cha:AccountID>
                     <!--Optional:-->
                     <cha:Code>?</cha:Code>
                     <!--Optional:-->
                     <cha:DangerousGoods>
                        <!--Optional:-->
                        <cha:AggrigateQuantity>?</cha:AggrigateQuantity>
                        <!--Optional:-->
                        <cha:ConsignmentID>?</cha:ConsignmentID>
                        <!--Optional:-->
                        <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                        <!--Optional:-->
                        <cha:DgClass>?</cha:DgClass>
                        <!--Optional:-->
                        <cha:Exception>
                           <!--Optional:-->
                           <cha:Message>?</cha:Message>
                           <!--Optional:-->
                           <cha:ModuleName>?</cha:ModuleName>
                           <!--Optional:-->
                           <cha:ProcedureName>?</cha:ProcedureName>
                        </cha:Exception>
                        <!--Optional:-->
                        <cha:Group>?</cha:Group>
                        <!--Optional:-->
                        <cha:ID>?</cha:ID>
                        <!--Optional:-->
                        <cha:ItemNo>?</cha:ItemNo>
                        <!--Optional:-->
                        <cha:LiquidVolume>?</cha:LiquidVolume>
                        <!--Optional:-->
                        <cha:Liquidweight>?</cha:Liquidweight>
                        <!--Optional:-->
                        <cha:Name>?</cha:Name>
                        <!--Optional:-->
                        <cha:PSN>?</cha:PSN>
                        <!--Optional:-->
                        <cha:Quantity>?</cha:Quantity>
                        <!--Optional:-->
                        <cha:Recepticle>?</cha:Recepticle>
                        <!--Optional:-->
                        <cha:SubRisk>?</cha:SubRisk>
                        <!--Optional:-->
                        <cha:UnCode>?</cha:UnCode>
                        <!--Optional:-->
                        <cha:Units>?</cha:Units>
                        <!--Optional:-->
                        <cha:Volume>?</cha:Volume>
                        <!--Optional:-->
                        <cha:Weight>?</cha:Weight>
                     </cha:DangerousGoods>
                     <!--Optional:-->
                     <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                     <!--Optional:-->
                     <cha:Error>
                        <!--Optional:-->
                        <cha:Message>?</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>?</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>?</cha:ProcedureName>
                     </cha:Error>
                     <!--Optional:-->
                     <cha:Height>?</cha:Height>
                     <!--Optional:-->
                     <cha:IsActive>?</cha:IsActive>
                     <!--Optional:-->
                     <cha:Length>?</cha:Length>
                     <!--Optional:-->
                     <cha:Name>?</cha:Name>
                     <!--Optional:-->
                     <cha:ProductID>?</cha:ProductID>
                     <!--Optional:-->
                     <cha:Volume>?</cha:Volume>
                     <!--Optional:-->
                     <cha:Weight>?</cha:Weight>
                     <!--Optional:-->
                     <cha:Width>?</cha:Width>
                  </cha:ConsignmentProduct>
                  <!--Optional:-->
                  <cha:Description>?</cha:Description>
                  <!--Optional:-->
                  <cha:ExchangeReturnable>?</cha:ExchangeReturnable>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemNo>?</cha:ItemNo>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:ModifiedBy>?</cha:ModifiedBy>
                  <!--Optional:-->
                  <cha:NoItems>?</cha:NoItems>
                  <!--Optional:-->
                  <cha:ProductID>?</cha:ProductID>
                  <!--Optional:-->
                  <cha:Reference>?</cha:Reference>
                  <!--Optional:-->
                  <cha:Returnable>?</cha:Returnable>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsignmentItem>
            </cha:ConsignmentItems>
            <!--Optional:-->
            <cha:ConsignmentNote>?</cha:ConsignmentNote>
            <!--Optional:-->
            <cha:ConsignmentType>?</cha:ConsignmentType>
            <!--Optional:-->
            <cha:ConsolidatedSus>
               <!--Zero or more repetitions:-->
               <cha:ConsolidateConsignment>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Items>?</cha:Items>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsolidateConsignment>
            </cha:ConsolidatedSus>
            <!--Optional:-->
            <cha:ContainingConsignment>?</cha:ContainingConsignment>
            <!--Optional:-->
            <cha:DeliveryInstructions>?</cha:DeliveryInstructions>
            <!--Optional:-->
            <cha:Description>?</cha:Description>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:DownloadID>?</cha:DownloadID>
            <!--Optional:-->
            <cha:Exception>
               <!--Optional:-->
               <cha:Message>?</cha:Message>
               <!--Optional:-->
               <cha:ModuleName>?</cha:ModuleName>
               <!--Optional:-->
               <cha:ProcedureName>?</cha:ProcedureName>
            </cha:Exception>
            <!--Optional:-->
            <cha:Ext>
               <!--Optional:-->
               <cha:ConsignmentID>?</cha:ConsignmentID>
               <!--Optional:-->
               <cha:CostCenter>?</cha:CostCenter>
               <!--Optional:-->
               <cha:ThirdPartyAccount>?</cha:ThirdPartyAccount>
               <!--Optional:-->
               <cha:UserField1>?</cha:UserField1>
               <!--Optional:-->
               <cha:UserField2>?</cha:UserField2>
               <!--Optional:-->
               <cha:UserField3>?</cha:UserField3>
               <!--Optional:-->
               <cha:UserField4>?</cha:UserField4>
               <!--Optional:-->
               <cha:UserField5>?</cha:UserField5>
            </cha:Ext>
            <!--Optional:-->
            <cha:ExtraInfo>?</cha:ExtraInfo>
            <!--Optional:-->
            <cha:Hours>?</cha:Hours>
            <!--Optional:-->
            <cha:ModifiedBy>?</cha:ModifiedBy>
            <!--Optional:-->
            <cha:NoItems>?</cha:NoItems>
            <!--Optional:-->
            <cha:OnForwarder>?</cha:OnForwarder>
            <!--Optional:-->
            <cha:PickupInstructions>?</cha:PickupInstructions>
            <!--Optional:-->
            <cha:ReadyAt>?</cha:ReadyAt>
            <!--Optional:-->
            <cha:Receiver>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Receiver>
            <!--Optional:-->
            <cha:Reference>?</cha:Reference>
            <!--Optional:-->
            <cha:References>
               <!--Zero or more repetitions:-->
               <cha:Reference>
                  <!--Optional:-->
                  <cha:ConsignmentReference>?</cha:ConsignmentReference>
                  <!--Optional:-->
                  <cha:RemoveReference>?</cha:RemoveReference>
               </cha:Reference>
            </cha:References>
            <!--Optional:-->
            <cha:Released>?</cha:Released>
            <!--Optional:-->
            <cha:Sender>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Sender>
            <!--Optional:-->
            <cha:Service>?</cha:Service>
            <!--Optional:-->
            <cha:SessionID>?</cha:SessionID>
            <!--Optional:-->
            <cha:SpecialInstructions>?</cha:SpecialInstructions>
            <!--Optional:-->
            <cha:Volume>?</cha:Volume>
            <!--Optional:-->
            <cha:Weight>?</cha:Weight>
         </cha:consignment>
      </cha:SaveConsignment>
   </soapenv:Body>
</soapenv:Envelope>

Web Service Call

<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>
            <AccountID>{{AccountID}}</AccountID>
            <DistributorID>{{DistributorID}}</DistributorID>
            <Expires>{{Expires}}</Expires>
            <Key>{{Key}}</Key>
            <UserID>{{UserID}}</UserID>
         </session>

         <consignment>
            <AccountID>{{AccountID}}</AccountID>
            <CloseAt>18:00</CloseAt>
            <ConsignmentDate>2019-05-21</ConsignmentDate>
				<ConsignmentItems>
                	<ConsignmentItem>
                        <Barcode/>
                        <ConsignmentID>97908306</ConsignmentID>
                        <Description>Truck Parts for the Business</Description>
                        <Height>10</Height>
                        <ItemNo>1</ItemNo>
                        <ItemType>CRT</ItemType>
                        <Length>15</Length>
                        <NoItems>10</NoItems>
                        <ProductID>0</ProductID>
                        <Packaging>Bag</Packaging>
                        <Reference>CNHD2D</Reference>
                        <Volume>1.10</Volume>
                        <Weight>20</Weight>
                        <Width>20</Width>
        	     	</ConsignmentItem>
            	</ConsignmentItems>
			<ConsolidatedSus>	                  
			</ConsolidatedSus>

            <DeliveryInstructions>None</DeliveryInstructions>
            <Description>Description</Description>
            <DistributorID>{{DistributorID}}</DistributorID>

            <ReadyAt>12: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>Test</Reference>
            <References>
               <!--Zero or more repetitions:-->
               <Reference>
                  <ConsignmentReference>ConRefef1</ConsignmentReference>
               </Reference>
                <Reference>
                  <ConsignmentReference>ConsignRefee2</ConsignmentReference>
               </Reference>
            </References>
            
            <Released>2019-05-21</Released>
            
            <Sender>
               <AccountID>{{AccountID}}</AccountID>
               <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>
            </Sender>
            
            
            <Service>STEFPP</Service>
            <SpecialInstructions>Deliver to the front door</SpecialInstructions>
         </consignment>
      </SaveConsignment>
   </soapenv:Body>
</soapenv:Envelope>

Successful Web Service Call Response

TBC

Related articles

Filter by label