1. Home
  2. SOAP API
  3. Create Sale Order

Create Sale Order

API Operations

 

Description:

The API creates a new Sale Order to be fulfilled.

 

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

            <wsse:Username>Sandbox</wsse:Username>

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

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

            <wsu:Created>2014-05-15T08:54:00.445Z</wsu:Created>

         </wsse:UsernameToken>

      </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

      <ser:CreateSaleOrderRequest>

         <ser:SaleOrder>

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

            <!–Optional:–>

            <ser:DisplayOrderCode>?</ser:DisplayOrderCode>

            <!–Optional:–>

            <ser:DisplayOrderDateTime>?</ser:DisplayOrderDateTime>

            <!–Optional:–>

            <ser:CustomerCode>?</ser:CustomerCode>

            <!–Optional:–>

            <ser:Channel>?</ser:Channel>

            <!–Optional:–>

            <ser:NotificationEmail>?</ser:NotificationEmail>

            <!–Optional:–>

            <ser:NotificationMobile>?</ser:NotificationMobile>

            <!–Optional:–>

            <ser:CashOnDelivery>?</ser:CashOnDelivery>

            <!–Optional:–>

            <ser:AdditionalInfo>?</ser:AdditionalInfo>

            <!–Optional:–>

            <ser:CurrencyCode>?</ser:CurrencyCode>

            <!–Optional:–>

            <ser:TaxExempted>?</ser:TaxExempted>

            <!–Optional:–>

            <ser:CFormProvided>?</ser:CFormProvided>

            <!–Optional:–>

            <ser:Addresses>

               <!–1 or more repetitions:–>

               <ser:Address id=”?”>

                  <ser:Name>?</ser:Name>

                  <ser:AddressLine1>?</ser:AddressLine1>

                  <!–Optional:–>

                  <ser:AddressLine2>?</ser:AddressLine2>

                  <ser:City>?</ser:City>

                  <ser:State>?</ser:State>

                  <ser:Country>?</ser:Country>

                  <ser:Pincode>?</ser:Pincode>

                  <ser:Phone>?</ser:Phone>

                  <!–Optional:–>

                  <ser:Email>?</ser:Email>

               </ser:Address>

            </ser:Addresses>

            <!–Optional:–>

            <ser:ShippingAddress ref=”?”/>

            <!–Optional:–>

            <ser:BillingAddress ref=”?”/>

            <ser:SaleOrderItems>

               <!–1 or more repetitions:–>

               <ser:SaleOrderItem>

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

                  <ser:ItemSKU>?</ser:ItemSKU>

                  <!–Optional:–>

                  <ser:ChannelSKU>?</ser:ChannelSKU>

                  <ser:ShippingMethodCode>?</ser:ShippingMethodCode>

                  <!–Optional:–>

                  <ser:GiftWrap>?</ser:GiftWrap>

                  <!–Optional:–>

                  <ser:GiftMessage>?</ser:GiftMessage>

                  <ser:TotalPrice>?</ser:TotalPrice>

                  <ser:SellingPrice>?</ser:SellingPrice>

                  <!–Optional:–>

                  <ser:PrepaidAmount>?</ser:PrepaidAmount>

                  <!–Optional:–>

                  <ser:ShippingCharges>?</ser:ShippingCharges>

                  <!–Optional:–>

                  <ser:ShippingMethodCharges>?</ser:ShippingMethodCharges>

                  <!–Optional:–>

                  <ser:CashOnDeliveryCharges>?</ser:CashOnDeliveryCharges>

                  <!–Optional:–>

                  <ser:Discount>?</ser:Discount>

                  <!–Optional:–>

                  <ser:GiftWrapCharges>?</ser:GiftWrapCharges>

                  <!–Optional:–>

                  <ser:VoucherCode>?</ser:VoucherCode>

                  <!–Optional:–>

                  <ser:VoucherValue>?</ser:VoucherValue>

                  <!–Optional:–>

                  <ser:StoreCredit>?</ser:StoreCredit>

                  <!–Optional:–>

                  <ser:PacketNumber>?</ser:PacketNumber>

                  <!–Optional:–>

                  <ser:CombinationIdentifier>?</ser:CombinationIdentifier>

                  <!–Optional:–>

                  <ser:OnHold>?</ser:OnHold>

                  <!–Optional:–>

                  <ser:FacilityCode>?</ser:FacilityCode>

                  <!–Optional:–>

                  <ser:RequiresCustomization>?</ser:RequiresCustomization>

                  <!–Optional:–>

                  <ser:ShippingAddress ref=”?”/>

                  <!–Optional:–>

                  <ser:CustomFields>

                     <!–1 or more repetitions:–>

                     <ser:CustomField name=”?” value=”?”/>

                  </ser:CustomFields>

               </ser:SaleOrderItem>

            </ser:SaleOrderItems>

            <!–Optional:–>

            <ser:ShippingProviders>

               <!–1 or more repetitions:–>

               <ser:ShippingProvider>

                  <ser:PacketNumber>?</ser:PacketNumber>

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

                  <!–Optional:–>

                  <ser:TrackingNumber>?</ser:TrackingNumber>

               </ser:ShippingProvider>

            </ser:ShippingProviders>

            <!–Optional:–>

            <ser:SaleOrderItemCombinations>

               <!–1 or more repetitions:–>

               <ser:SaleOrderItemCombination>

                  <ser:Identifier>?</ser:Identifier>

                  <ser:Description>?</ser:Description>

               </ser:SaleOrderItemCombination>

            </ser:SaleOrderItemCombinations>

            <!–Optional:–>

            <ser:CustomFields>

               <!–1 or more repetitions:–>

               <ser:CustomField name=”?” value=”?”/>

            </ser:CustomFields>

            <!–Optional:–>

            <ser:VerificationRequired>?</ser:VerificationRequired>

            <!–Optional:–>

            <ser:Priority>?</ser:Priority>

         </ser:SaleOrder>

      </ser:Creat​eSaleOrderRequest>

   </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>ashish1</wsse:Username>

         <wsse:Password Type=”http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText”>e13cc8cd-17c8-4798-bb7b-2d1335ad92d6</wsse:Password>

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

         <wsu:Created>2014-04-11T08:33:53.075Z</wsu:Created>

      </wsse:UsernameToken>

   </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

   <ser:CreateSaleOrderRequest>

      <ser:SaleOrder>

         <ser:Code>10023jje</ser:Code>

         <ser:CustomerCode>ashishtt</ser:CustomerCode>

         <ser:SaleOrderItems>

            <!–1 or more repetitions:–>

            <ser:SaleOrderItem>

               <ser:Code>dnndd</ser:Code>

               <ser:ItemSKU>FNTBST11WL30001</ser:ItemSKU>

               <ser:ShippingMethodCode>STD</ser:ShippingMethodCode>

               <ser:TotalPrice>100</ser:TotalPrice>

               <ser:SellingPrice>200</ser:SellingPrice>

               <ser:ItemDetailFields>

                  <!–1 or more repetitions:–>

                  <ser:ItemDetailField>certificate</ser:ItemDetailField>

               </ser:ItemDetailFields>

            </ser:SaleOrderItem>

         </ser:SaleOrderItems>

         <ser:SaleOrderItemCombinations>

            <!–1 or more repetitions:–>

            <ser:SaleOrderItemCombination>

               <ser:Identifier>1</ser:Identifier>

               <ser:Description>dkddd</ser:Description>

            </ser:SaleOrderItemCombination>

         </ser:SaleOrderItemCombinations>

      </ser:SaleOrder>

   </ser:CreateSaleOrderRequest>

   </soapenv:Body>

</soapenv:Envelope>

 

Response:

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

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

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

         <Successful>true</Successful>

      </CreateSaleOrderResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

 

Error Codes:

With the tag <Successful>false</Successful>, the system throws an error. The error codes are as defined below:

 

 


Go back to API introduction

Next API: Create Or Edit Item Type

Related Articles