API docs by Redocly

Rate Table API (2.0.0)

Download OpenAPI specification:Download

License: eBay API License Agreement

This API allows sellers to retrieve and manage their custom shipping rate tables.

rate_table

getRateTable

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

getRateTable currently supports the retrieval of rate tables for the following eBay marketplace IDs:

  • EBAY_AU
  • EBAY_CA
  • EBAY_DE
  • EBAY_ES
  • EBAY_FR
  • EBAY_GB
  • EBAY_IT
  • EBAY_US
Note: To retrieve a list of all rateTableId values, issue a getRateTables call (part of Account API V1,) with no countryCode query parameter specifed. This will return a list of all shipping rate tables defined for each marketplace and their corresponding rateTableId values.

A successful call returns detailed information for the specified shipping rate table.

Authorizations:
Authorization_Code
path Parameters
rate_table_id
required
string

The unique identifier for the shipping rate table. This identifier is generated by eBay when a shipping rate table is first created.

Note: To retrieve a list of all rateTableId values, issue a getRateTables call (part of Account API V1,) with no countryCode query parameter specifed. This will return a list of all shipping rate tables defined for each marketplace and their corresponding rateTableId values.

Responses

Response samples

Content type
application/json
{
  • "marketplaceId": "string",
  • "name": "string",
  • "rates": [
    ],
  • "rateTableBasis": "string",
  • "rateTableId": "string",
  • "shippingOptionType": "string"
}

updateShippingCost

This method allows sellers to update shippingCost and/or additionalCost information for an existing shipping rate table identified by the rate_table_id path parameter.

Note: To retrieve a list of all rateTableId values, issue a getRateTables call (part of Account API V1,) with no countryCode query parameter specifed. This will return a list of all shipping rate tables and corresponding rateTableId values.

A successful call returns an HTTP status code of 204 No Content.

Authorizations:
Authorization_Code
path Parameters
rate_table_id
required
string

The unique identifier for the shipping rate table. This identifier is generated by eBay when a shipping rate table is first created.

Note: To retrieve a list of all rateTableId values, issue a getRateTables call (part of Account API V1,) with no countryCode query parameter specifed. This will return a list of all shipping rate tables defined for each marketplace and their corresponding rateTableId values.

Request Body schema: application/json

Request to update the shipping costs for the identified shipping rate table.

Array of objects (RateUpdate)

An array of rate objects for which shippingCost and/or additionalCost are to be updated.

Responses

Request samples

Content type
application/json
{
  • "rates": [
    ]
}