account APIv1.4.0

getRateTables

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 the seller's shipping rate tables.

The method's response includes a rateTableId for each table defined by the seller. Use a table's ID value in a fulfillment policy to specify the shipping rate table to use for that policy's DOMESTIC or INTERNATIONAL shipping option (make sure the locality of the rate table matches the optionType of the shipping option).

This method supports getting rate tables that were created for the following marketplaces
  • EBAY_AU
  • EBAY_CA
  • 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 My eBay > Account > Site Preferences to create and maintain the rate tables. For more, see Using shipping rate tables.

If you're using the Trading API, use the rate table ID values in the RateTableDetails container of the Add/Revise/Relist calls. If the locality for a rate table is set to DOMESTIC, pass the ID value in the RateTableDetails.DomesticRateTableId field. Otherwise, if locality is INTERNATIONAL, pass the ID value in RateTableDetails.InternationalRateTableId.

Note: For regions that are not yet ramped up with multi-rate table support, this method returns an ID that maps to the seller's default rate table for the country specified.

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-1 Alpha-2 code of country for which you want shipping-rate table information. If you do not specify a county code, the request returns all the seller-defined rate tables.

Occurrence: Optional

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 scope from the following list:

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.

Output

HTTP response headers

Output container/fieldTypeDescription
rateTablesarray of RateTableA list of elements that provide information on the seller-defined shipping rate tables.

Occurrence: Conditional

rateTables.countryCodeCountryCodeEnumA two-letter ISO 3166-1 Alpha-2 country code representing the eBay marketplace where an item is listed.

Occurrence: Conditional

rateTables.localityShippingOptionTypeEnumThe region covered by the shipping rate table, either DOMESTIC or INTERNATIONAL.

DOMESTIC indicates that the shipping rate table applies to regions within the country where an item is listed (the source country) while INTERNATIONAL indicates that the shipping rate table applies to regions outside of the country where an item is listed.

Occurrence: Conditional

rateTables.namestringThe user-defined name for the shipping rate table. Sellers can access Seller Hub (or My eBay > Account > Site Preferences > Shipping preferences) to create and assign names to their shipping rate tables.

Occurrence: Conditional

rateTables.rateTableIdstringA unique eBay-assigned ID for a seller's shipping rate table. Call getRateTables to retrieve the seller's current rate table IDs.

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

Error codes

CodeDomainCategoryMeaning
20403API_ACCOUNTREQUESTInvalid {fieldName}. {additionalInfo}
20500API_ACCOUNTAPPLICATIONSystem error.

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.
GET
https://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.