getRateTable: eBay Account API | eBay Developers Program

GET/rate_table/{rate_table_id}

This method retrieves an existing rate table identified by the rate_table_id path parameter.

Shipping rate tables are currently supported by the following marketplaces: United States, Canada, United Kingdom, Germany, Australia, France, Italy, and Spain. A successful call returns detailed information for the specified shipping rate table.

Input

Resource URI

GET https://api.ebay.com/sell/account/v2/rate_table/{rate_table_id}

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

Parameter	Type	Description
rate_table_id	string	This path parameter is the unique identifier for the shipping rate table to retrieve. Use the getRateTables method of the Account API v1 to retrieve rate table IDs. Occurrence: Required

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

eBayUser

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

Copy complete valid JSON to clipboard

{ /* RateTableDetails */

"marketplaceId" : "MarketplaceIdEnum : [EBAY_AT,EBAY_AU,EBAY_BE...]",

"name" : "string",

"rates" : [

{ /* Rate */

"additionalCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"rateId" : "string",

"shippingCategory" : "ShippingCategoryEnum : [ONE_DAY,EXPEDITED,STANDARD...]",

"shippingCost" :

{ /* Amount */

"currency" : "CurrencyCodeEnum : [AED,AFN,ALL...]",

"value" : "string"

"shippingRegionNames" : [

"string"

"shippingServiceCode" : "string"

}

"rateTableBasis" : "ShippingRateCalculationEnum : [ITEM,WEIGHT,SURCHARGE]",

"rateTableId" : "string",

"shippingOptionType" : "ShippingOptionTypeEnum : [DOMESTIC,INTERNATIONAL]"

}

Response fields

Output container/field	Type	Description
marketplaceId	MarketplaceIdEnum	Identifies the eBay marketplace to which the shipping rate table applies. Occurrence: Always
name	string	The seller-defined name for the shipping rate table. Names must be unique for each table assigned to the same seller, shippingOptionType, and eBay marketplace. Max length: 50 Occurrence: Always
rates	array of Rate	An array of rate objects associated with the specified shipping rate table. Each rate object is identified by a unique system-generated ID and defines specific shipping rate information. Occurrence: Always
rates.additionalCost	Amount	An additional shipping cost added to the base shipping rate (i.e., shippingCost). This amount applies only to the following rateTableBasis options: WEIGHT: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. SURCHARGE: This is a flat amount that is added to the base shipping rate. This field is returned only when it is applicable to the specified rate ID. Occurrence: Conditional
rates.additionalCost.currency	CurrencyCodeEnum	The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is `CAD`. Occurrence: Conditional
rates.additionalCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
rates.rateId	string	The unique identifier for rate information. Note: This is a string that is automatically assigned by the system when a rate object is created. Occurrence: Always
rates.shippingCategory	ShippingCategoryEnum	Indicates the level of shipping service to which the shipping rate information applies. Available shipping categories are: ONE_DAY: This option is not supported when shippingOptionType* is INTERNATIONAL.* EXPEDITED STANDARD ECONOMY EXPRESS: This option is supported only when MarketplaceId* is `EBAY_DE` (Germany)* Occurrence: Always
rates.shippingCost	Amount	Specifies the base shipping rate for an item. This amount applies only to the following rateTableBasis options: ITEM: This is a flat rate shipping cost per item being shipped. WEIGHT: This is a cost per unit weight and is calculated using the weight of the item(s) being shipped. Occurrence: Conditional
rates.shippingCost.currency	CurrencyCodeEnum	The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is `CAD`. Occurrence: Conditional
rates.shippingCost.value	string	The monetary amount in the specified currency. Occurrence: Conditional
rates.shippingRegionNames	array of string	An array of Region names to which the shipping rate information applies. Returned values may be: Geographical Regions (e.g., `Worldwide`, `Europe`, and `Middle East`) Individual countries identified by a two-letter code such as `US` (United States), `CA` (Canada), and `GB` (United Kingdom) US states and/or Canadian provinces identified by a two-letter code such as `NY` (New York) or `SK` (Saskatchewan) Domestic Regions such as `AK/HI` (Alaska/Hawaii) Occurrence: Always
rates.shippingServiceCode	string	An enum value that indicates the shipping service used for the specified shipping rate. These enum values align with ShippingService metadata returned by a GeteBayDetails call with DetailName set to `shippingServiceDetails`. Occurrence: Conditional
rateTableBasis	ShippingRateCalculationEnum	The rate calculation type provides three methods of calculating the shipping cost based on the seller's selection/input: ITEM: Specifies the flat rate shipping cost that buyers in the specified shipping region will pay. When this option is selected, information specified in the rate table overrides all shipping options/costs that are specified at the listing level. Buyers in the specified regions will only see the services provided in the rate table. Buyers in other regions that are not specified in the rate table will see the shipping services associated with the listing. WEIGHT: Seller can provide minimum shipping cost and an additional shipping cost per pound. The additional cost will be calculated based on the weight the seller provide at the time of listing. Buyers will see the total shipping cost and won’t see these calculations. Buyers in the specified regions will only see the services provided in the rate table. Buyers in other regions that were not specified in the rate table, will see the shipping services associated with the listing. SURCHARGE: Lists surcharges for buyers within specified regions, or indicates a flat amount added to the shipping cost specified within an item's listing. Buyers will see only the total shipping cost as well as shipping services associated with the item's listing. If a SURCHARGE is specified in the rate table for certain regions, buyers in those regions will see the (shipping cost + SURCHARGE) total. Occurrence: Conditional
rateTableId	string	A unique, system-generated ID assigned to the shipping rate table when it is initially created. Occurrence: Always
shippingOptionType	ShippingOptionTypeEnum	The region serviced by the shipping rate table. Valid values are: DOMESTIC: Indicates that the shipping rate table applies to shipping destinations within the country in which an item has been listed (i.e., the source country). INTERNATIONAL: Indicates that the shipping rate table applies to shipping destinations outside of the country in which an item has been listed. 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.

Status	Meaning
200	OK
404	Not found
500	Internal Server Error

Error codes

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

Code	Domain	Category	Meaning
394001	API_ACCOUNT	REQUEST	The specified rate table ID is invalid. Please input a valid rate table ID. The getRateTables method can be used to retrieve valid rate table IDs
395000	API_ACCOUNT	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.

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: Retrieve a Specific Shipping-Rate Table

This example retrieves a shipping-rate table using the table's unique eBay-assigned ID.

Input

Specify the rate table to be returned using the rate_table_id path parameter. This call does not use a request payload.

GEThttps://api.ebay.com/sell/account/v2/rate_table/5******7

Output

A successful call returns details for the shipping-rate table.