GetTaxTable

Use this call to retrieve the tax table for a user on a given site, or to retrieve the valid jurisdictions (if any) for a given site.

When calling GetTaxTable, the user is determined by the authorization token and the Site ID is specified in the HTTP header. The call returns one TaxTable element per call, as determined by the user and Site ID combination.

To return all the valid jurisdictions for the given site (and their settings for the authorized user), set DetailLevel to ReturnAll.

You can test GetTaxTable in the Sandbox. First, call SetTaxTable to set up a tax table for the specified user, then call GetTaxTable to see the results for that user.

See Enabling Multi-jurisdiction Sales Tax.

See also the reference documentation for this call:

SetTaxTable - Sets the tax table for a seller on a given site.

GetTaxTable Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetTaxTableRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Input fields) -->

  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel values allowed here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetTaxTableRequest>

Argument	Type	Occurrence	Meaning

(No call-specific fields)

Standard Input Fields

DetailLevel	DetailLevelCodeType	Optional, repeatable: [0..*]	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: Routing the Request (Gateway URLs) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

GetTaxTable Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetTaxTableResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <LastUpdateTime> dateTime </LastUpdateTime>
  <TaxTable> TaxTableType
    <TaxJurisdiction> TaxJurisdictionType
      <JurisdictionID> string </JurisdictionID>
      <SalesTaxPercent> float </SalesTaxPercent>
      <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
    </TaxJurisdiction>
    <!-- ... more TaxJurisdiction nodes allowed here ... -->
  </TaxTable>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetTaxTableResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

LastUpdateTime	dateTime	Conditionally	The last time (in GMT) that the tax table was updated. Only returned if the user previously created a tax table and if the site has jurisdictions. LastUpdateTime is useful for synchronization. If you cache the user's tax table, you can use GetTaxTable to check if it has changed and whether you need to update the cached tax table. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TaxTable	TaxTableType	Always	A container of tax jurisdiction information unique to a user/site combination. Empty if not set for user. If DetailLevel is not specified, information is only returned for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned but are empty. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TaxTable.TaxJurisdiction	TaxJurisdictionType	Always, repeatable: [1..*]	Sales tax details for zero or more jurisdictions (states, provinces, etc). For GetTaxTable: If DetailLevel is not specified, information is returned only for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned, but are empty. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TaxTable.TaxJurisdiction .JurisdictionID	string	Conditionally	Representative identifier for the jurisdiction. Typically an abbreviation (for example, CA for California). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TaxTable.TaxJurisdiction .SalesTaxPercent	float	Conditionally	The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). For GetTaxTable: this tag has no value if the user's tax table has not been set. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
TaxTable.TaxJurisdiction .ShippingIncludedInTax	boolean	Conditionally	Whether shipping costs are to be part of the base amount that is taxed. For GetTaxTable: This tag is empty if the user did not previously provide information. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

GetTaxTable Detail Controls

Detail Control: DetailLevel

The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)

The none column indicates the fields that are returned when you do not specify a DetailLevel.

Y	The field is always returned.
(Y)	The field is conditionally returned. See the field documentation for clarification of conditions.
-	The field is not returned.

Output Field none ReturnAll

LastUpdateTime (Y) (Y)

TaxTable Y Y

TaxTable.TaxJurisdiction Y Y

TaxTable.TaxJurisdiction.JurisdictionID (Y) (Y)

TaxTable.TaxJurisdiction.SalesTaxPercent (Y) (Y)

TaxTable.TaxJurisdiction.ShippingIncludedInTax (Y) (Y)

Output Field	none	ReturnAll
LastUpdateTime	(Y)	(Y)
TaxTable	Y	Y
TaxTable.TaxJurisdiction	Y	Y
TaxTable.TaxJurisdiction.JurisdictionID	(Y)	(Y)
TaxTable.TaxJurisdiction.SalesTaxPercent	(Y)	(Y)
TaxTable.TaxJurisdiction.ShippingIncludedInTax	(Y)	(Y)

GetTaxTable Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Returns the tax table for the specified user and specified site.

Description

The call has no special input parameters, the user is specified by their authorization token and the Site ID is specified in the HTTP headers.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetTaxTableRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
</GetTaxTableRequest>

Output

XML format. Also available is the .txt version of this XML.

<GetTaxTableResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-06T18:59:24.718Z</Timestamp>
  <Ack>Success</Ack>
  <Version>643</Version>
  <Build>E643_CORE_BUNDLED_10284414_R1</Build>
  <LastUpdateTime>2010-01-06T18:45:01.000Z</LastUpdateTime>
  <TaxTable>
    <TaxJurisdiction>
      <JurisdictionID>CA</JurisdictionID>
      <SalesTaxPercent>8.25</SalesTaxPercent>
      <ShippingIncludedInTax>true</ShippingIncludedInTax>
    </TaxJurisdiction>
    <TaxJurisdiction>
      <JurisdictionID>MI</JurisdictionID>
      <SalesTaxPercent>6.0</SalesTaxPercent>
      <ShippingIncludedInTax>false</ShippingIncludedInTax>
    </TaxJurisdiction>
  </TaxTable>
</GetTaxTableResponse>

GetTaxTable Change History

This section notes changes made since Version 465.

User-Contributed Notes

eBay Trading API Call Reference Version 821