essentials

Lookup

Lookup is the "work horse" of our APIs. Determine applicable tax amounts for items being purchased based on a variety of factors.

post/Lookup

Request

  • Base URL: https://api.taxcloud.net/1.0/TaxCloud
  • URL: https://api.taxcloud.net/1.0/TaxCloud/Lookup
  • Auth: none declared

Request body

apiLoginIDstring required

Find your API ID via <a href="https://app.taxcloud.com/go/stores/" target="_blank">https://app.taxcloud.com/go/stores/</a>

apiKeystring required

Find your API KEY via <a href="https://app.taxcloud.com/go/stores/" target="_blank">https://app.taxcloud.com/go/stores/</a>

customerIDstring required

This should be the abstract identifier used by your system to uniquely identify customers. <i style="color:red;">Note: This should <b>not</b> be your customer's email address or any other form of Personally Identifiable Information (PII).</i>

cartIDstring uuid

CartID is very similar to an Order ID, except most systems do not issue immutable (permanent) identifiers for orders until customers actually place their order (clicking the BUY button).<p/><div><B>IMPORTANT:</B> You must be able to persist the CartID accross all Lookup requests for a particular customer (including situations where a customer puts an item in her cart before logging in, then proceeds ordering after logging in).<p/>If your system does not provide a mechanism to create unique identifiers, you can omit this parameter (or submit as null) and TaxCloud will provide a unique identifier in the response (which you should persist for subsequent <i>Lookup</i> calls and the ultimate <i>Authorized</i> or <i>AuthorizedWithCapture</i> calls).</div>

deliveredBySellerboolean required

If you ship orders to customers via common carrier (USPS, UPS, FedEx, etc) should always be false.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.