Lookup | TaxCloud

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

Request

Lookup Request

apiLoginIDstringRequired>=7 characters<=8 characters

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

apiKeystringRequired=8 characters

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

customerIDstringRequired>=5 characters<=50 characters

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

deliveredBySellerbooleanRequired

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

originobjectRequired

destinationobjectRequired

cartItemslist of objectsRequired

cartIDstringOptionalformat: "uuid">=5 characters<=50 characters

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

Something went wrong!

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

Response

LookupResultobject or null

1	curl -X POST https://api.taxcloud.net/1.0/TaxCloud/Lookup \
2	-H "Content-Type: application/json" \
3	-d '{
4	"apiLoginID": "2D7D820",
5	"apiKey": "0946110c-2aa9-4387-ad5c-4e1c551b8d0c",
6	"customerID": "CustomerX23",
7	"deliveredBySeller": false,
8	"origin": {
9	"Address1": "162 East Avenue",
10	"City": "Norwalk",
11	"State": null,
12	"Zip5": 6851,
13	"Zip4": 5715
14	},
15	"destination": {
16	"Address1": "162 East Avenue",
17	"City": "Norwalk",
18	"State": null,
19	"Zip5": 6851,
20	"Zip4": 5715
21	},
22	"cartItems": [
23	{
24	"Index": 0,
25	"ItemID": "ProductX23",
26	"TIC": 0,
27	"Price": 19.95,
28	"Qty": 2
29	}
30	]
31	}'

1	{
2	"LookupResult": {
3	"CartID": "Cart2342534235",
4	"CartItemsResponse": [
5	{
6	"CartItemIndex": 0,
7	"TaxAmount": 2.65
8	}
9	],
10	"ResponseType": {
11	"value": 0
12	},
13	"Messages": [
14	"foo"
15	]
16	}
17	}