This doc page has moved! You should be automatically redirected to the resources page for the eBay Account API. If you are not redirected automatically, follow this link to the Account API.

eBay Account APIVersion 1.2.0

Create a Sales Tax Table Entry

PUT /sales_tax/{countryCode}/{jurisdictionId}

Use this call to create or update 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 tax tables for countries that support differnt tax jurisdictions. Currently, only Canada, India, and the US support separate tax jurisdictions. If you sell into any of these countries, you can set up tax tables for any of the country's jurisdictions. Retrieve valid jurisdiction IDs using Get Sales Tax Jurisdictions in the Metadata API.

Input

See also Samples.

Resource URI (production)

PUT https://api.ebay.com/sell/account/v1/sales_tax/{countryCode}/{jurisdictionId}

URI parameters

Parameter Type Required? Meaning
countryCode string Required A two-letter ISO 3166-1 Alpha-2.

Applicable values are from CountryCodeEnum.
jurisdictionId string Required Unique ID for a sales tax jurisdiction.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



OAuth request scope

This request requires a user access token with the following scope:

https://api.ebay.com/oauth/api_scope/sell.account

See Getting Access Tokens for more information.



Payload model

The following lists all fields that could be included in the request.

{ /* SalesTaxBase */
"salesTaxPercentage": string,
"shippingAndHandlingTaxed": boolean
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
salesTaxPercentage string Required The sales tax rate, as a percentage of the sale.
shippingAndHandlingTaxed boolean Optional Set this value to true to indicate that shipping and handling charges are taxed.

Output

See also Samples.

HTTP status codes

This call can return one of the following HTTP status codes. See the HTTP Status Code Registry for a complete overview of HTTP status codes.

Status Meaning
204 No Content
400 Bad Request
404 Not Found
500 Internal Server Error

Payload model

This call has no response payload.



Error Codes

Code Domain Category Nature Meaning
20400 API_ACCOUNT REQUEST ERROR Invalid request. {additionalInfo}
20401 API_ACCOUNT REQUEST ERROR Missing field {fieldName}. {additionalInfo}
20403 API_ACCOUNT REQUEST ERROR Invalid {fieldName}. {additionalInfo}
20404 API_ACCOUNT REQUEST ERROR {fieldName} not found.
20407 API_ACCOUNT REQUEST ERROR Tax table not supported for {fieldName}.
20500 API_ACCOUNT APPLICATION ERROR System error.



Samples

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: Create or update a sales tax table entry

This call creates or updates a sales tax table entry.

Description

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 New York, a sales tax jurisdiction in the United States.

URL format. See also the non-wrapped version of this URL.

PUT https://api.sandbox.ebay.com/sell/account/v1/sales_tax/US/NY

{
    "salesTaxPercentage": 4.0,
    "shippingAndHandlingTaxed": true
}

Output

This call does not return a response body.

JSON format.
If successful, this call returns an HTTP status code of "204 No content" and an empty response body.



Change History

Change Date Description