browse APIv1_beta.21.0

ShippingOption

The type that defines the fields for the details of a shipping provider.

Type that uses ShippingOption

Calls that use ShippingOption

Fields

Field
Type
Description
additionalShippingCostPerUnit
Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).
cutOffDateUsedForEstimate
The deadline date that the item must be purchased by in order to be received by the buyer within the delivery window ( maxEstimatedDeliveryDate and minEstimatedDeliveryDate fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the Delivery line on the View Item page.

This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.
maxEstimatedDeliveryDate
The end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.
minEstimatedDeliveryDate
The start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.
quantityUsedForEstimate
The number of items used when calculating the estimation information.
shippingCarrierCode
A name of the shipping provider, such as FedEx, or USPS.
shippingCost
The final shipping cost for all the items after all discounts are applied.
shippingCostType
Indicates the class of the shipping cost.

Valid Values: FIXED or CALCULATED.
Code so that your app gracefully handles any future changes to this list.
shippingServiceCode
The type of shipping service. For example, USPS First Class.
shipToLocationUsedForEstimate
The container that returns the country and postal code of where the item is to be shipped. These values come from the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. If the header is not submitted, marketplace is used.
trademarkSymbol
Any trademark symbol, such as ™ or ®, that needs to be shown in superscript next to the shipping service name.
type
The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.