1. Home
  2. SOAP API
  3. Get Sale Order Details
Searching...

Get Sale Order Details

API Operations

 

Description:

This API is used to get the details of the Sales Order residing in the system. A Sales Order should record the customer’s originating purchase order which is an external document. A Sales Order is an internal document of the company.

 

API:

<soapenv:Envelope xmlns:ser=”http://uniware.unicommerce.com/services/” xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”>

   <soapenv:Header>

   <wsse:Security soapenv:mustUnderstand=”1″ xmlns:wsse=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd” xmlns:wsu=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd”>

      <wsse:UsernameToken wsu:Id=”UsernameToken-4″>

         <wsse:Username>staging</wsse:Username>

         <wsse:Password Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText”>staging</wsse:Password>

         <wsse:Nonce EncodingType=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary”>dWsyd3j1QGwBDFkPEDHXfQ==</wsse:Nonce>

         <wsu:Created>2014-02-26T10:13:53.787Z</wsu:Created>

      </wsse:UsernameToken>

   </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

   <ser:GetSaleOrderRequest>

      <ser:SaleOrder>

         <ser:Code>?</ser:Code>

      </ser:SaleOrder>

   </ser:GetSaleOrderRequest>

   </soapenv:Body>

</soapenv:Envelope>

API parameters:

 

Request:

<soapenv:Envelope xmlns:ser=”http://uniware.unicommerce.com/services/” xmlns:soapenv=”http://schemas.xmlsoap.org/soap/envelope/”>

   <soapenv:Header>

   <wsse:Security soapenv:mustUnderstand=”1″ xmlns:wsse=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd” xmlns:wsu=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd”>

      <wsse:UsernameToken wsu:Id=”UsernameToken-4″>

         <wsse:Username>staging</wsse:Username>

         <wsse:Password Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText”>staging</wsse:Password>

         <wsse:Nonce EncodingType=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary”>dWsyd3j1QGwBDFkPEDHXfQ==</wsse:Nonce>

         <wsu:Created>2014-02-26T10:13:53.787Z</wsu:Created>

      </wsse:UsernameToken>

   </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

   <ser:GetSaleOrderRequest>

      <ser:SaleOrder>

         <ser:Code>SO1000056</ser:Code>

      </ser:SaleOrder>

   </ser:GetSaleOrderRequest>

   </soapenv:Body>

</soapenv:Envelope>

 

Response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV=”http://schemas.xmlsoap.org/soap/envelope/”>

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

   <GetSaleOrderResponse xmlns=”http://uniware.unicommerce.com/services/”>

      <Successful>true</Successful>

      <SaleOrder>

         <Code>SO1000056</Code>

         <DisplayOrderCode>SO1000056</DisplayOrderCode>

         <Channel>CUSTOM</Channel>

         <DisplayOrderDateTime>2014-02-26T06:56:53Z</DisplayOrderDateTime>

         <Status>PROCESSING</Status>

         <NotificationEmail/>

         <CreatedOn>2014-02-26T06:57:14Z</CreatedOn>

         <UpdatedOn>2014-02-26T06:57:21Z</UpdatedOn>

         <CashOnDelivery>true</CashOnDelivery>

         <Addresses>

            <Address id=”121317″>

               <Name>ashishttt</Name>

               <AddressLine1>jsjsh</AddressLine1>

               <AddressLine2>jjhjh</AddressLine2>

               <City>hjjh</City>

               <State>AN</State>

               <Country>IN</Country>

               <Pincode>122001</Pincode>

               <Phone>0872627222</Phone>

             </Address>

             <SaleOrderItems>

            <SaleOrderItem>

               <Code>SO1000056-0-0</Code>

               <StatusCode>FULFILLABLE</StatusCode>

               <ItemSKU>PRODCODE002</ItemSKU>

               <ShippingMethodCode>STD</ShippingMethodCode>

               <ItemName>TESTITEM002</ItemName>

               <TotalPrice>100.00</TotalPrice>

               <SellingPrice>100.00</SellingPrice>

               <Discount>0.00</Discount>

               <ShippingPackageCode>04P1000035</ShippingPackageCode>

               <FacilityCode>04</FacilityCode>

               <ShippingCharges>0.00</ShippingCharges>

               <ShippingMethodCharges>0.00</ShippingMethodCharges>

               <CashOnDeliveryCharges>0.00</CashOnDeliveryCharges>

               <GiftWrapCharges>0.00</GiftWrapCharges>

               <ShippingAddress ref=”121317″/>

               <Cancellable>true</Cancellable>

               <OnHold>false</OnHold>

               <CreatedOn>2014-02-26T06:57:14Z</CreatedOn>

               <UpdatedOn>2014-02-26T06:57:21Z</UpdatedOn>

               <CustomFields/>

            </SaleOrderItem>

         </SaleOrderItems>

<ShippingPackages>

            <ShippingPackage>

<ShipmentCode>04P1000035</ShipmentCode>

               <StatusCode>PACKED</StatusCode>

               <ShippingPackageType>DEFAULT</ShippingPackageType>

<CreatedOn>2014-02-26T06:57:21Z</CreatedOn>

            </ShippingPackage>

        </ShippingPackages>

         <CustomFields>

            <CustomField>

               <Name>testingOrder</Name>

            </CustomField>

         </CustomFields>

      </SaleOrder>

   </GetSaleOrderResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Error Codes:

With the tag successful tag=false the system throws an error. The error codes are as defined below:

 

Go back to API introduction

Next API: Cancel Sale Order

Related Articles