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

Lookup Description

Request

POST https://api.taxcloud.net/1.0/TaxCloud/Lookup

Request body

The request body takes a complete LookupRequest resource, containing the following writable properties:

{
    "apiKey": "string",
    "apiLoginID": "string",
    "cartID": "uuid",
    "cartItems": [
        {
            "Index": "int32",
            "ItemID": "string",
            "Price": "float",
            "Qty": "int32",
            "TIC": "int32",
            "Tax": "float"
        }
    ],
    "customerID": "string",
    "deliveredBySeller": "boolean",
    "destination": {
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip4": "number",
        "Zip5": "number"
    },
    "origin": {
        "Address1": "string",
        "Address2": "string",
        "City": "string",
        "State": "string",
        "Zip4": "number",
        "Zip5": "number"
    }
}

Properties

Name Type Description Additional
apiKey string

Find your API KEY via https://taxcloud.com/go/stores/

apiLoginID string

Find your API ID via https://taxcloud.com/go/stores/

cartID 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).

IMPORTANT: 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).

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 Lookup calls and the ultimate Authorized or AuthorizedWithCapture calls).

Optional
cartItems[] array
cartItems[].Index int32
cartItems[].ItemID string
cartItems[].Price float
cartItems[].Qty int32
cartItems[].TIC int32
cartItems[].Tax float

Tax property is only valid for use with TIC 99999 (in-store sales)

Optional
customerID string

This should be the abstract identifier used by your system to uniquely identify customers. Note: This should not be your customer's email address or any other form of Personally Identifiable Information (PII).

deliveredBySeller boolean

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

destination object Address
destination.Address1 string Address1
destination.Address2 string Address2 Optional
destination.City string City
destination.State string State

Possible values are:

  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • DC
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
destination.Zip4 number Zip4
destination.Zip5 number Zip5
origin object Address
origin.Address1 string Address1
origin.Address2 string Address2 Optional
origin.City string City
origin.State string State

Possible values are:

  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • DC
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • WV
  • WI
  • WY
origin.Zip4 number Zip4
origin.Zip5 number Zip5

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

LookupResponse

Explore this API

LookupRequest
Request Content-Type
Response Content-Type
Try it out!