PUT/sales_tax/{countryCode}/{jurisdictionId}
This method creates or updates a sales-tax table entry for a jurisdiction. Specify the tax table entry you want to configure using the two path parameters: countryCode and jurisdictionId.
A tax table entry for a jurisdiction is comprised of two fields: one for the jurisdiction's sales-tax rate and another that's a boolean value indicating whether or not shipping and handling are taxed in the jurisdiction.
You can set up sales-tax tables for countries that support different tax jurisdictions.
Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.
Retrieve valid jurisdiction IDs using getSalesTaxJurisdictions in the Metadata API.
For details about using this call, refer to Establishing sales-tax tables.
Important! In the US, eBay now calculates, collects, and remits sales tax to the proper taxing authorities in all 50 states and Washington, DC. Sellers can no longer specify sales-tax rates for these jurisdictions using a tax table.
However, sellers may continue to use a sales-tax table to set rates for the following US territories:
- American Samoa (AS)
- Guam (GU)
- Northern Mariana Islands (MP)
- Palau (PW)
- US Virgin Islands (VI)
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| countryCode | CountryCodeEnum | This path parameter specifies the two-letter ISO 3166 code for the country for which you want to create a sales tax table entry. Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:
Occurrence: Required |
| jurisdictionId | string | This path parameter specifies the ID of the tax jurisdiction for the table entry to be created. Valid jurisdiction IDs can be retrieved using the getSalesTaxJurisdiction method of the Metadata API. Note: When countryCode is set to US, the only supported values for jurisdictionId are:
Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.account
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| salesTaxPercentage | string | This field is used to set the sales tax rate for the tax jurisdiction set in the call URI. When applicable to an order, this sales tax rate will be applied to sales price. The shippingAndHandlingTaxed value will indicate whether or not sales tax is also applied to shipping and handling charges Occurrence: Required |
| shippingAndHandlingTaxed | boolean | This field is set to Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
This call has no payload.
Response fields
This call has no field definitions.
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20400 | API_ACCOUNT | REQUEST | Invalid request. {additionalInfo} |
| 20401 | API_ACCOUNT | REQUEST | Missing field {fieldName}. {additionalInfo} |
| 20403 | API_ACCOUNT | REQUEST | Invalid {fieldName}. {additionalInfo} |
| 20404 | API_ACCOUNT | REQUEST | {fieldName} not found. |
| 20407 | API_ACCOUNT | REQUEST | Tax table not supported for {fieldName}. |
| 20500 | API_ACCOUNT | APPLICATION | System error. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Create or update a sales tax table entry
This call creates or updates a sales tax table entry for the specified country and sales tax jurisdiction.
Input
This example sets the sales tax table entry for British Columbia, a sales tax jurisdiction in Canada.
PUThttps://api.ebay.com/sell/account/v1/sales_tax/CA/BC
Output
A successful call returns the HTTP status code 204 No content. This method returns an empty response body.