logistics APIv1_beta.0.0

Rate

This complex type contains live quote information about a shipping service that's available for a given shipping quote request, including the shipping carrier and service, delivery window, shipping cost, and additional shipping options.

Type that uses Rate

Calls that use Rate

Fields

Field
Type
Description
additionalOptions
Contains service and pricing information for one or more shipping options that are offered by the carrier and can be purchased in addition to the base shipping service provided by this rate. Shipping options can include items such as INSURANCE and SIGNATURE.
baseShippingCost
A live quote for the cost that the carrier (identified by shippingCarrierCode) is charging for the shipping service being offered (identified by shippingServiceCode), excluding any additional shipping options.
destinationTimeZone
The name of the time zone region, as defined in the IANA Time Zone Database, to which the package is being shipped.

Delivery dates are calculated relative to this time zone.

Note: This is different from a Coordinated Universal Time (UTC) offset. For example, the America/Los_Angeles time zone identifies a region with the UTC standard time offset of -08:00, but so do several other time zones, including America/Tijuana,America/Dawson, and Pacific/Pitcairn.
maxEstimatedDeliveryDate
The latest stated date and time the shipment will be delivered at this rate.

The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS].[SSS]Z
Example: 2018-08-20T07:09:00.000Z
minEstimatedDeliveryDate
The estimated earliest date and time the shipment will be delivered at this rate. The time stamp is formatted as an ISO 8601 UTC string.
pickupNetworks
array of string
A list of pickup networks compatible with the shipping service.
pickupSlots
array of PickupSlot
A list of available pickup slots for the package.
pickupType
The type of pickup or drop-off service associated with the pickupSlots time frames.
rateId
The unique eBay-assigned ID for this shipping rate.
rateRecommendation
A list of reasons this rate is recommended. Available values are:
  • BUYER_CHOSEN — The rate meets or exceeds the requirements of the buyer's preferred shipping option.
  • CHEAPEST_ON_TIME — The rate is the cheapest rate available that will provide delivery within the seller's time frame commitment.
  • EBAY_PLUS_OK — The rate complies with the shipping requirements of the eBay Plus program.
  • FASTEST_ON_TIME — The rate has the fastest shipping time, and will provide delivery within the seller's time frame commitment.
  • GUARANTEED_DELIVERY_OK — The rate complies with the shipping requirements of the eBay Guaranteed Delivery program.
shippingCarrierCode
The code name of the shipping carrier who will provide the service identified by shippingServiceCode.
shippingCarrierName
The common name of the shipping carrier.
shippingServiceCode
The code name of the shipping service to be provided by the carrier identified by shippingCarrierCode.
shippingServiceName
The common name of the shipping service.