Skip to main content

This container details shipping rate information identified by a unique rate ID. A successful call returns the requested shipping rate information.

Type that uses Rate

RateTableDetails

Call that uses Rate

Fields

Field
Type
Description
additionalCost
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.
rateId
The unique identifier for rate information.

Note: This is a string that is automatically assigned by the system when a rate object is created.
shippingCategory
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)
shippingCost
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.
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)
shippingServiceCode
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.