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

eBay Metadata APIVersion 1.1.0

Get Sales Tax Jurisdictions

GET /country/{countryCode}/sales_tax_jurisdiction

This call retrieves all the sales tax jurisdictions for the country that you specify in the countryCode path parameter. Countries with valid sales tax jurisdictions are Canada, India, and the US.

The response from this call tells you the jurisdictions for which a seller can configure tax tables. Although setting up tax tables is optional, you can use the Create Sales Tax Tables in the Account API call to configure the tax tables for the jurisdictions you sell to.

Input

See also Samples.

Resource URI (production)

GET https://api.ebay.com/sell/metadata/v1/country/{countryCode}/sales_tax_jurisdiction

URI parameters

Parameter Type Required? Meaning
countryCode string Required A two-letter ISO 3166-1 Alpha-2 country code. eBay provides sales tax jurisdiction information for Canada, India, and the United States.Valid values for this path parameter are CA, IN, and US.

Applicable values are from CountryCodeEnum.


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 either a user access token or an application access token with the following scope:

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

See Getting Access Tokens for more information.



Payload model

This call has no request payload.


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
200 Success
400 Bad Request
404 Not Found
500 Internal Server Error

Payload model

Note: For information about the error fields and how to work with them, see Error Handling.

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

{ /* SalesTaxJurisdictions */
"salesTaxJurisdictions": [
    { /* SalesTaxJurisdiction */
    "salesTaxJurisdictionId": string
    }
    /* More SalesTaxJurisdiction nodes here */
  ]
}

Response field descriptions



Output Container/Field Type Occurrence Meaning
salesTaxJurisdictions array of SalesTaxJurisdiction Conditionally A list of sales tax jurisdictions.
salesTaxJurisdictions
  .salesTaxJurisdictionId
string Conditionally The unique ID for a sales tax jurisdiction.



Error Codes

Code Domain Category Nature Meaning
45400 API_METADATA REQUEST ERROR Invalid input. {additionalInfo}
45401 API_METADATA REQUEST ERROR Invalid {fieldName}.
45402 API_METADATA REQUEST ERROR Tax table not supported for {fieldName}.
45500 API_METADATA 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: Get the sales tax jurisdictions for Canada.

This call retrieves the sales tax jurisdictions for the country you specify.

Description

This call retrieves the sales tax jurisdictions for a country. However, not all countries have multiple sales tax jurisdictions. Current support is for Canada, India, and the United States.

Input

This call does not use a payload. Supply the country code as a path parameter. The example below specified Canada (CA).

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

GET https://api.sandbox.ebay.com/sell/metadata/v1/country/CA/sales_tax_jurisdiction

Output

If the call is successful, it returns all the sales tax jurisdictions for the specified country.

JSON format.
{
  "salesTaxJurisdictions": [
    {
      "salesTaxJurisdictionId": "AB"
    },
    {
      "salesTaxJurisdictionId": "BC"
    },
    {
      "salesTaxJurisdictionId": "MB"
    },
    {
      "salesTaxJurisdictionId": "NB"
    },
    {
      "salesTaxJurisdictionId": "NL"
    },
    {
      "salesTaxJurisdictionId": "NS"
    },
    {
      "salesTaxJurisdictionId": "NT"
    },
    {
      "salesTaxJurisdictionId": "NU"
    },
    {
      "salesTaxJurisdictionId": "ON"
    },
    {
      "salesTaxJurisdictionId": "PE"
    },
    {
      "salesTaxJurisdictionId": "QC"
    },
    {
      "salesTaxJurisdictionId": "SK"
    },
    {
      "salesTaxJurisdictionId": "YT"
    }
  ]
}



Change History

Change Date Description