Skip to main content

GET/rate_table

This method retrieves a seller's shipping rate tables for the country specified in the country_code query parameter. If you call this method without specifying a country code, the call returns all of the seller's shipping rate tables.

The method's response includes a rateTableId for each table defined by the seller. This rateTableId value is used in add/revise item call or in create/update fulfillment business policy call to specify the shipping rate table to use for that policy's domestic or international shipping options.

This call currently supports getting rate tables related to the following marketplaces:

  • EBAY_AU
  • EBAY_CA
  • EBAY_DE
  • EBAY_ES
  • EBAY_FR
  • EBAY_GB
  • EBAY_IT
  • EBAY_US
Note: Rate tables created with the Trading API might not have been assigned a rateTableId at the time of their creation. This method can assign and return rateTableId values for rate tables with missing IDs if you make a request using the country_code where the seller has defined rate tables.

Sellers can define up to 40 shipping rate tables for their account, which lets them set up different rate tables for each of the marketplaces they sell into. Go to Shipping rate tables in My eBay to create and update rate tables.

Input

Resource URI (production)

GET https://api.ebay.com/sell/account/v1/rate_table?

URI parameters

ParameterTypeDescription
country_codeCountryCodeEnumThis query parameter specifies the two-letter ISO 3166 code of country for which you want shipping rate table information. If you do not specify a country code, the request returns all of the seller's defined shipping rate tables for all eBay marketplaces.

Occurrence: Optional

HTTP request headers

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

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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

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

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
rateTablesarray of RateTable

An array of all shipping rate tables defined for a marketplace (or all marketplaces if no country_code query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace.

Occurrence: Always

rateTables.countryCodeCountryCodeEnum

A two-letter ISO 3166 country code representing the eBay marketplace where the shipping rate table is defined.

Occurrence: Always

rateTables.localityShippingOptionTypeEnum

This enumeration value returned here indicates whether the shipping rate table is a domestic or international shipping rate table.

Occurrence: Always

rateTables.namestring

The seller-defined name for the shipping rate table.

Occurrence: Always

rateTables.rateTableIdstring

A unique eBay-assigned ID for a seller's shipping rate table. These rateTableId values are used to associate shipping rate tables to fulfillment business policies or directly to listings through an add/revise/relist call in the Trading API.

Occurrence: Always

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
400Bad Request
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
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: Get the shipping-rate tables for a country

This example retrieves details about the shipping-rate tables defined by a seller for a specific country.

Input

This call does not require a request payload and the countryCode query parameter is optional (if you do not supply a countryCode in the request, the call returns all the seller's shipping-rate tables). The example shown relies on the default countryCode value.

GEThttps://api.ebay.com/sell/account/v1/rate_table

Output

A successful call returns information on the shipping-rate tables defined by the seller. Table information is returned for the country specified in the request and information on up to 40 tables can be returned by this call.