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

Hold Sale Order

API Operations

Description:

The API enables you to hold a Sale Order Item. The reason to hold a sale order item can vary from the reasons like sanity check of a customer or pending payments. To unhold an order item, it must be already in ‘hold’ state.

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

            <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”>jx0id1DqFiL67bLzXGy2lw==</wsse:Nonce>

            <wsu:Created>2014-05-06T11:34:31.732Z</wsu:Created>

         </wsse:UsernameToken>

      </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

      <ser:HoldSaleOrderItemsRequest>

         <ser:SaleOrder>

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

            <ser:SaleOrderItems>

               <!–1 or more repetitions:–>

               <ser:SaleOrderItem>

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

               </ser:SaleOrderItem>

            </ser:SaleOrderItems>

         </ser:SaleOrder>

      </ser:HoldSaleOrderItemsRequest>

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

            <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”>VSZH2Dr9/RZo1wIW+r1jNA==</wsse:Nonce>

            <wsu:Created>2014-05-06T11:57:49.374Z</wsu:Created>

         </wsse:UsernameToken>

      </wsse:Security>

   </soapenv:Header>

   <soapenv:Body>

      <ser:HoldSaleOrderItemsRequest>

         <ser:SaleOrder>

            <ser:Code>269088833</ser:Code>

            <ser:SaleOrderItems>

               <ser:SaleOrderItem>

                  <ser:Code>477413413</ser:Code>

               </ser:SaleOrderItem>

            </ser:SaleOrderItems>

         </ser:SaleOrder>

      </ser:HoldSaleOrderItemsRequest>

   </soapenv:Body>

</soapenv:Envelope>

Response:

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

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

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

         <Successful>true</Successful>

      </HoldSaleOrderItemsResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>

Error Codes:


Go back to API introduction

Next API: Unhold Sale Order

Related Articles