Skip to main content

The "rate" that has been selected and purchased for the shipment, as referenced by the rateId value.

Type that uses PurchasedRate

Shipment

Calls that use PurchasedRate

Fields

Field
Type
Description
additionalOptions
An list of additional, optional features that have been purchased for the shipment.
baseShippingCost
The amount of the "base cost" for the shipment as set by the given carrier for the specified service. This cost excludes any addition costs accrued from the addition of any optional shipping options.
destinationTimeZone
The time zone of the destination according to Time Zone Database. For example, "America/Los_Angeles".
maxEstimatedDeliveryDate
A string value representing maximum (latest) estimated delivery time, 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
A string value representing minimum (earliest) estimated delivery time, formatted as an ISO 8601ISO 8601 UTC string.
pickupNetworks
array of string
A list of pickup networks compatible with the shipping service.
pickupSlotId
This unique eBay-assigned ID value is returned only if the shipment has been configured for a scheduled pickup.
pickupType
The type of pickup or drop off configured for the shipment.
rateId
The eBay-generated ID of the shipping rate that the seller has chosen to purchase for the shipment.
shippingCarrierCode
The ID code for the carrier that was selected for the package shipment.
shippingCarrierName
The name of the shipping carrier.
shippingQuoteId
The unique eBay-generated ID of the shipping quote from which the seller selected a shipping rate (rateId).
shippingServiceCode
String ID code for the shipping service selected for the package shipment. This is a service that the shipping carrier supplies.
shippingServiceName
The name of the shipping service.
totalShippingCost
The total shipping cost, which is the sum cost of the base shipping cost and the cost of all the selected shipping options.