Skip to main content

POST/bulk_create_or_replace_sales_tax

This method creates or updates multiple sales-tax table entries.

Sales-tax tables can be set up for countries that support different tax jurisdictions.

Note: Sales-tax tables are only available for the US (EBAY_US) and Canada (EBAY_CA) marketplaces.
Each sales-tax table entry comprises the following parameters:

  • countryCode
  • jurisdictionId
  • salesTaxPercentage
  • shippingAndHandlingTaxed

Valid jurisdiction IDs are retrieved 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)
For additional information, refer to Taxes and import charges.

Input

Resource URI

POST https://api.ebay.com/sell/account/v1/bulk_create_or_replace_sales_tax

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

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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 clipboard

Request fields

Input container/fieldTypeDescription
salesTaxInputListarray of SalesTaxInput

The array of sales-tax table entries to be created or updated.

Occurrence: Required

salesTaxInputList.countryCodestring

This parameter specifies the two-letter ISO 3166 code of the country for which a sales-tax table entry is to be created or updated.

Note: Sales-tax tables are available only for the US and Canada marketplaces. Therefore, the only supported values are:

  • US
  • CA

Occurrence: Required

salesTaxInputList.salesTaxJurisdictionIdstring

This parameter specifies the ID of the tax jurisdiction for which a sales-tax table entry is to be created or updated.

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:

  • AS (American Samoa)
  • GU (Guam)
  • MP (Northern Mariana Islands)
  • PW (Palau)
  • VI (US Virgin Islands)

Occurrence: Required

salesTaxInputList.salesTaxPercentagestring

This parameter specifies the sales tax rate for the specified salesTaxJurisdictionId. When applicable to an order, this sales tax rate will be applied to the sales price. The shippingAndHandlingTaxed value indicates whether or not sales tax is also applied to shipping and handling charges

Although it is a string, a percentage value is set here, such as 7.75.

Occurrence: Required

salesTaxInputList.shippingAndHandlingTaxedboolean

This parameter is set to true if the seller wishes to apply sales tax to shipping and handling charges and not just the total sales price of an order. Otherwise, this parameter's value should be set to false.

Occurrence: Required

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
updatedSalesTaxEntriesarray of UpdatedSalesTaxEntry

The array of new and updated sales-tax table entries.

Occurrence: Conditional

updatedSalesTaxEntries.countryCodestring

The two-letter ISO 3166 code of the country associated with the sales-tax table entry.

Occurrence: Conditional

updatedSalesTaxEntries.jurisdictionIdstring

The ID of the tax jurisdiction associated with the sales-tax table entry.

Occurrence: Conditional

updatedSalesTaxEntries.statusCodeinteger

The HTTP status code for the call.

Note: The system returns one HTTP status code regardless of the number of sales-tax table entries provided. Therefore, the same HTTP statusCode will be listed for all sales-tax table entries returned in the payload.

Occurrence: Conditional

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.

StatusMeaning
200Success
207partial success
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
20400API_ACCOUNTREQUESTInvalid request. {additionalInfo}
20401API_ACCOUNTREQUESTMissing field {fieldName}. {additionalInfo}
20403API_ACCOUNTREQUESTInvalid {fieldName}. {additionalInfo}
20500API_ACCOUNTAPPLICATIONSystem 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: Bulk create or update sales-tax table entries

This call creates or updates sales-tax table entries for the specified countries and sales tax jurisdictions.

Input

This example sets sales-tax table entries for British Columbia, a sales-tax jurisdiction in Canada, and Guam, a sales-tax jurisdiction in the United States.

POSThttps://api.ebay.com/sell/account/v1/bulk_create_or_replace_sales_tax

Output

A successful call returns an array of the countryCode, jurisdictionId, and HTTP statusCode for each sales-tax table entry.

Note: The system returns one HTTP status code regardless of the number of sales-tax table entries provided. Therefore, the same HTTP statusCode will be listed for all sales-tax table entries.