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:
Next API: Cancel Sale Order