Theme switcher

By Postal Code

API Requests by postal code will respond with a structure similar to the v50 and prior response where multiple rates are returned for all applicable tax jurisdictions overlapping the postal code.

NOTE: The postal code lookups include multiple applicable rates with no adjustments for unincorporated areas or special tax jurisdictions and will not provide an accuracy equivalent to a door-level rate. Use the Address lookup method for the most accurate rate.

Header Parameters

X-API-KEYstring

Adding your API key in the header is an optional way to pass your API key. You can also use the key query parameter to pass your key.

Content-Typestring

Using the correct content type ensures that clients and servers correctly interpret the data being exchanged as JSON, allowing for proper parsing and handling. The default encoding for JSON is UTF-8.

Query Parameters

keystring

Using the key query parameter is an optional method for passing your API key. The recommended method is to use the X-API-KEY header value noted above.

addressstring Required

The full or partial address for the request. Note the address will be normalized into the full door-level address. You can view the normalized address used for the rate query published in the response data.

formatstring

Format options include json or xml. JSON is the default response format. Be sure to update your Content-Type header if you choose to use the xml formatted response.

countryCodestring

Optionally provide a valid ISO 3166-1 alpha-3 country code for rates outside the US. This feature is only available to Pro and Enterprise Plan levels. By default the request will use the USA country code.

taxabilityCodestring

The taxabilityCode is an optional value used for sending product taxability codes to get product tax rules in the response. This feature is only available for Pro and Enterprise level plans.

Path Parameters

versionstring

Provides the API version which determines the feature set available and the response syntax.

Response

200
Object

Response Attributes

versionstring

A string value representing the API response version requested.

rCodenumber

An application response code. A comprehensive table of API response codes is available in the Response Codes section.

resultsarray

The results object includes a list of results for all tax jurisdictions overlapping the provided postal code. See the v50 response documentation for details about this response object.

Show child attributes

addressDetailobject

When a request is made, the address used in the input is translated into a normalized address per the local addressing authority (e.g. the USPS for the United States). The addressDetail object contains information about the normalized address used to provide the response data. NOTE: this object will not provide address details for lookups using the postalcode query param.

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

Base URL

Production:

Sandbox:

Language Box

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?