getRateTables

v1.0.0

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 in My eBay to create and update rate tables.

Input

{
  "type": "object",
  "properties": {
    "country_code": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "This type is the base response of the <b>getRateTables</b> method.",
  "properties": {
    "rateTables": {
      "type": "array",
      "description": "An array of all shipping rate tables defined for a marketplace (or all marketplaces if no <b>country_code</b> query parameter is used). This array will be returned as empty if the seller has no defined shipping rate tables for the specified marketplace.",
      "items": {
        "type": "object",
        "description": "This type is used to provide details about each shipping rate table that is returned in the <b>getRateTables</b> response.",
        "properties": {
          "countryCode": {
            "type": "string",
            "description": "A two-letter <a href=\"https://www.iso.org/iso-3166-country-codes.html \" title=\"https://www.iso.org \" target=\"_blank\">ISO 3166</a> country code representing the eBay marketplace where the shipping rate table is defined. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/ba:CountryCodeEnum'>eBay API documentation</a>"
          },
          "locality": {
            "type": "string",
            "description": "This enumeration value returned here indicates whether the shipping rate table is a domestic or international shipping rate table. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/account/types/api:ShippingOptionTypeEnum'>eBay API documentation</a>"
          },
          "name": {
            "type": "string",
            "description": "The seller-defined name for the shipping rate table."
          },
          "rateTableId": {
            "type": "string",
            "description": "A unique eBay-assigned ID for a seller's shipping rate table. These <b>rateTableId</b> 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."
          }
        }
      }
    }
  }
}