Optimize Your E-commerce Calculations with Zip2Tax Sales & Use Tax Rates.
Optimize Your E-commerce Calculations with Zip2Tax Sales & Use Tax Rates.
Sales Tax API Response Fields
Ready to purchase the API?
What is in an API subscription?
API - Developer's API Menu
Response fields for XML and JSON
Programming Note:
Consider when using the API response, it should be read using the field names and not the relative position. This will avoid problems to your program if we add additional fields as the service improves and grows.
We will never remove a field name to ensure constant success of legacy coding.
| Output container/field | Type | Description |
|---|---|---|
| z2tLookup | Root container | |
| z2tLookup/errorInfo | Node | Contains summary information about request processing. Occurrence: Always |
| z2tLookup/errorInfo/errorCode | Element | Describe result of request processing. Format: Digital Code Occurrence: Always See the page sidebar menu for a list of error codes. |
| z2tLookup/errorInfo/errorMessage | Element | Describe result of request processing. Format: String Occurrence: Always |
| z2tLookup/errorInfo/errorMessageVerbose | Element | Textual value of described exception. Format: String Occurrence: Conditional |
| z2tLookup/errorInfo/elapsedTime | Element | Describes duration time of request processing. Format: Time (hh:mm:dd.ms) Occurrence: Always |
| z2tLookup/errorInfo/startTime | Element | Describes date and time request received. Format: Time (hh:mm:dd.ms) Occurrence: Always |
| z2tLookup/errorInfo/endTime | Element | Describes date and time request completed. Format: Time (hh:mm:dd.ms) Occurrence: Always |
| z2tLookup/errorInfo/ServerName | Element | Server name where request received. Format: String Occurrence: Always |
| z2tLookup/errorInfo/Version | Element | Current version of API processor. Format: String Occurrence: Always |
| z2tLookup/errorInfo/warnings | Node | List of warnings during request processing. Occurrence: Always |
| z2tLookup/errorInfo/warnings/warning | Element | List of warnings during request processing. Format: String Occurrence: Conditional |
| z2tLookup/addressInfo | Node | Result of request processing. Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addressResolution | Element | Describe address resolution used in processing. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses | Array of Nodes | List of tax jurisdiction objects. Format: Array Occurrence: Always |
| z2tLookup/addressInfo/addresses/address | Node | Describer tax jurisdiction object. Format: Object Occurrence: Conditional |
|
z2tLookup/addressInfo/addresses/address/ addressLine1 |
Element | Street address used for processing. (if any). Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ place | Element | City used for processing (if any). Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ state | Element | State used for processing (if any). Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ zipCode | Element | ZIP code used for processing / detected during processing. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ county | Element | County detected during processing. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ latitude | Element | Latitude as per geolocation (for Spot-On resolution). Blank for zip resolution Format: decimal (12,6) Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ longitude | Element | Longitude as per geolocation (for Spot-On resolution). Blank for zip resolution Format: Decimal (12,6) Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax | Node | Describer sales tax rate for current address object Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax/taxRate | Element | Total value of sales tax rate for current address. Format: Percentage Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax/rateInfo | Array of Nodes | Detailed description of sales tax by jurisdiction level. Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax/rateInfo/rateDetails | Node | Detailed jurisdiction level for sales tax. Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax/rateInfo/rateDetails/jurisdictionLevel | Element | Jurisdiction level name. Format: string Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax/rateInfo/rateDetails/jurisdictionCode | Element | Jurisdiction level code. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax/rateInfo/rateDetails/taxRate | Element | Jurisdiction level sales tax rate value. Format: percentage Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ salesTax/rateInfo/rateDetails/rateDetail/authorityName | Element | Authority name. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/useTax | Node | Describer use tax rate for current address object Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/useTax/taxRate | Element | Total value of use tax rate for current address. Format: Percentage Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ useTax/rateInfo | Array of Nodes | Detailed description of use tax by jurisdiction level. Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ useTax/rateInfo/rateDetails | Node | Detailed jurisdiction level for use tax. Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ useTax/rateInfo/rateDetails/jurisdictionLevel | Element | Jurisdiction level name. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ useTax/rateInfo/rateDetails/jurisdictionCode | Element | Jurisdiction level code. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ useTax/rateInfo/rateDetails/taxRate | Element | Jurisdiction level use tax rate value. Format: Percentage Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ useTax/rateInfo/rateDetails/rateDetail/authorityName | Element | Authority name. Format: String Occurrence: Always |
| z2tLookup/addressInfo/addresses/ address/notes | Node | Any notes for current address. Format: Object Occurrence: Always |
| z2tLookup/addressInfo/addresses/address/ notes/noteDetails | Array of Nodes | List of notes. Format: Array Occurrence: Conditional |
| z2tLookup/addressInfo/addresses/address/ notes/noteDetails/noteDetail/jurisdiction | Element | Jurisdiction level for note. Format: String Occurrence: Conditional |
| z2tLookup/addressInfo/addresses/address/ notes/noteDetails/noteDetail/category | Element | Category of note. Format: String Occurrence: Conditional |
| z2tLookup/addressInfo/addresses/address/ notes/noteDetails/noteDetail/note | Element | Category of note. Format: string Occurrence: Conditional |
