TaxCloud Web Service Base Documentation

Click here for a complete list of operations.

Returned

Return a previously Captured transaction. Supports entire order returns as well as individual item returns and even partial item-level returns.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /1.0/taxcloud.asmx HTTP/1.1
Host: api.taxcloud.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://taxcloud.net/Returned"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Returned xmlns="http://taxcloud.net">
      <apiLoginID>string</apiLoginID>
      <apiKey>string</apiKey>
      <orderID>string</orderID>
      <cartItems>
        <CartItem>
          <Index>int</Index>
          <ItemID>string</ItemID>
          <TIC>int</TIC>
          <Price>double</Price>
          <Qty>float</Qty>
          <Tax>string</Tax>
        </CartItem>
        <CartItem>
          <Index>int</Index>
          <ItemID>string</ItemID>
          <TIC>int</TIC>
          <Price>double</Price>
          <Qty>float</Qty>
          <Tax>string</Tax>
        </CartItem>
      </cartItems>
      <returnedDate>dateTime</returnedDate>
      <returnCoDeliveryFeeWhenNoCartItems>boolean</returnCoDeliveryFeeWhenNoCartItems>
    </Returned>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ReturnedResponse xmlns="http://taxcloud.net">
      <ReturnedResult />
    </ReturnedResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /1.0/taxcloud.asmx HTTP/1.1
Host: api.taxcloud.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <Returned xmlns="http://taxcloud.net">
      <apiLoginID>string</apiLoginID>
      <apiKey>string</apiKey>
      <orderID>string</orderID>
      <cartItems>
        <CartItem>
          <Index>int</Index>
          <ItemID>string</ItemID>
          <TIC>int</TIC>
          <Price>double</Price>
          <Qty>float</Qty>
          <Tax>string</Tax>
        </CartItem>
        <CartItem>
          <Index>int</Index>
          <ItemID>string</ItemID>
          <TIC>int</TIC>
          <Price>double</Price>
          <Qty>float</Qty>
          <Tax>string</Tax>
        </CartItem>
      </cartItems>
      <returnedDate>dateTime</returnedDate>
      <returnCoDeliveryFeeWhenNoCartItems>boolean</returnCoDeliveryFeeWhenNoCartItems>
    </Returned>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ReturnedResponse xmlns="http://taxcloud.net">
      <ReturnedResult />
    </ReturnedResponse>
  </soap12:Body>
</soap12:Envelope>