GetTaxTable
Use this call to retrieve information on the seller's tax table. This information includes the all of the site's tax jurisdictions, a boolean field to indicate if sales tax is applied to shipping and handling charges, and the sales tax rate for each jurisdiction (if a sales tax rate is set for that jurisdiction).
When calling GetTaxTable, the seller is determined by the authorization token, and the Site ID is specified in the HTTP header. Sales tax tables are only supported on the eBay US (Site ID 0), Canada English (Site ID 2), and Canada French (Site ID 210) sites.
To return all tax jurisdictions for the given site, even if no sales tax rate is set, include the DetailLevel field and set its value to ReturnAll
. If the DetailLevel field is omitted, only tax jurisdictions where a sales tax rate has been set is returned.
Note: As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. Sellers do not have to take any extra steps to enable the collection of sales tax in affected US states. If the seller is employing a Sales Tax Table for an active listing, and a sales tax rate is established for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay during checkout process. For a list of the US states that already are, or will become subject to 'eBay Collect and Remit', see the eBay sales tax collection help topic. |
See Multi-jurisdiction sales tax.
See also the reference documentation for this call:
- SetTaxTable - This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site.
Output Detail Controls Samples Change History |
Input
See also Samples.
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 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 and 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. 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 GranularityLevel instead, or use GetSellerEvents. If you do use 'ReturnAll' with GetSellerList, use a small Pagination.EntriesPerPage value and a narrow EndTimeFrom/EndTimeTo date range for better performance. Applicable values: (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. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
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., 1149). The version you specify for a call has these basic effects:
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:
|
||||||||||||||||||||||||||||||||||||||||
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 performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Detail Controls Samples Change History |
Output
See also Samples.
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 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. Returned as an empty container if no Sales Tax Table information exists for the seller's account and no DetailLevel is used. If DetailLevel is not specified, information is only returned for the jurisdictions for which the user provided tax information. If DetailLevel is set to 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 | Conditionally,
repeatable: [0..*] |
In a SetTaxTable, a TaxJurisdiction container is required for each tax jurisdiction that the seller wishes to make additions/changes. Sales tax details for zero or more jurisdictions (states, provinces, etc). This can be just one jurisdiction, up to all jurisdictions defined for the site's country. Any values specified through a TaxJurisdiction container will override any existing values defined in the seller's Sales Tax Table. If GetTaxTable is called without the DetailLevel field, only tax jurisdictions where sales tax rates have been set up are returned. However, if the DetailLevel field is included in the request and set to ReturnAll , all tax jurisdictions are returned, regardless of whether or not the seller has modified settings for any/all of these jurisdictions. This container is only returned in order-related 'Get' calls if sales tax is applicable to the order line item. Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
TaxTable.TaxJurisdiction .JurisdictionID |
string | Conditionally |
This is the unique, two-digit identifier of the tax jurisdiction (such as 'CA' for California). To retrieve all JurisdictionID values for a site, a seller can either use a GetTaxTable call with DetailLevel set to ReturnAll , or they can use the GeteBayDetails call with DetailLevel name set to TaxJurisdiction . The JurisdictionID field is always required in a SetTaxTable call, and always returned with each TaxJurisdiction container to identify the tax jurisdiction. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
TaxTable.TaxJurisdiction .SalesTaxPercent |
float | Conditionally |
This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction. Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in GetTaxTable (and other 'Get' calls) if a sales tax percentage rate has been set. Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
TaxTable.TaxJurisdiction .ShippingIncludedInTax |
boolean | Conditionally |
This field is included in a SetTaxTable call and set to true if the seller wants sales tax for the jurisdiction to apply to the cumulative amount of item cost and shipping charges. This value defaults to false if not specified. This field is always returned with each TaxJurisdiction container (whether true or false ). Note: Buyers in all 50 US states and DC are automatically charged sales tax for eBay purchases, and eBay collects and remits this sales tax to the proper taxing authority on the buyer's behalf. Because of this, if a sales tax percentage rate is applied to a listing by a seller in one of these states, this field will be ignored during the checkout process. Currently, sales tax percentage rates can only be specified by sellers in Canada and 5 US territories, including American Samoa (AS), Guam (GU), Northern Mariana Islands (MP), Palau (PW), and Virgin Islands (VI). 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 the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
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. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
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 Errors By Number. |
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 | 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.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
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: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Error handling section of the Making a Trading API call guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
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 the Time Values section in the eBay Features 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 the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
Input Output Samples Change History |
Detail Controls
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) |
Input Output Detail Controls Change History |
Samples
New to making API calls? Please see Making a Call.
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.
Returns the tax table for the specified user and specified site. Since the DetailLevel field is not included and set to 'ReturnAll', only the states/jurisdictions with sales tax rates set up are returned.
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.
<?xml version="1.0" encoding="utf-8"?>
<GetTaxTableRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>A*******3</eBayAuthToken>
</RequesterCredentials>
</GetTaxTableRequest>
Output
XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetTaxTableResponse
xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-05T22:41:26.783Z</Timestamp>
<Ack>Success</Ack>
<Version>1119</Version>
<Build>E1119_CORE_APISHIP_19043790_R1</Build>
<LastUpdateTime>2019-01-14T17:43:29.000Z</LastUpdateTime>
<TaxTable>
<TaxJurisdiction>
<JurisdictionID>AK</JurisdictionID>
<SalesTaxPercent>3.76</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>AL</JurisdictionID>
<SalesTaxPercent>9.01</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>AR</JurisdictionID>
<SalesTaxPercent>9.3</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>AZ</JurisdictionID>
<SalesTaxPercent>8.25</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>CA</JurisdictionID>
<SalesTaxPercent>8.25</SalesTaxPercent>
<ShippingIncludedInTax>true</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>CO</JurisdictionID>
<SalesTaxPercent>7.5</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>CT</JurisdictionID>
<SalesTaxPercent>6.35</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>DC</JurisdictionID>
<SalesTaxPercent>5.75</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>FL</JurisdictionID>
<SalesTaxPercent>6.8</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>GA</JurisdictionID>
<SalesTaxPercent>7.0</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>HI</JurisdictionID>
<SalesTaxPercent>4.35</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>IA</JurisdictionID>
<SalesTaxPercent>6.8</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>ID</JurisdictionID>
<SalesTaxPercent>6.03</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>IL</JurisdictionID>
<SalesTaxPercent>8.64</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>IN</JurisdictionID>
<SalesTaxPercent>7.0</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
<TaxJurisdiction>
<JurisdictionID>KS</JurisdictionID>
<SalesTaxPercent>8.62</SalesTaxPercent>
<ShippingIncludedInTax>false</ShippingIncludedInTax>
</TaxJurisdiction>
</TaxTable>
</GetTaxTableResponse>
Input Output Detail Controls Samples |
Change History
Change Date | Description |
---|---|
1085 2018-10-26 |
|