eBay Shopping APIVersion 1085

ShippingServiceOptionType

Container consisting of shipping costs and other details related to a domestic shipping service that is available to ship an item to the shipping destination specified in the GetShippingCosts call request.

Type that uses ShippingServiceOptionType:

Call that uses ShippingServiceOptionType:

Fields



EstimatedDeliveryMaxTime ( dateTime ) [0..1]
The timestamp in this field shows the estimated date and time that the item will be delivered to the buyer based on the corresponding shipping service's stated maximum transit time (specified in the ShippingTimeMax field in business days).

Note: Note that the estimated delivery 'window' that is defined through the EstimatedDeliveryMinTime and EstimatedDeliveryMaxTime should not be considered completely accurate because the seller's stated handling time is not considered in the calculation, and it is also based on the transaction (and payment) occurring right away.
See the Field Index to learn which calls use EstimatedDeliveryMaxTime.

EstimatedDeliveryMinTime ( dateTime ) [0..1]
The timestamp in this field shows the estimated date and time that the item will be delivered to the buyer based on the corresponding shipping service's stated minimum transit time (specified in the ShippingTimeMin field in business days).

Note: Note that the estimated delivery 'window' that is defined through the EstimatedDeliveryMinTime and EstimatedDeliveryMaxTime should not be considered completely accurate because the seller's stated handling time is not considered in the calculation, and it is also based on the transaction (and payment) occurring right away.
See the Field Index to learn which calls use EstimatedDeliveryMinTime.

ExpeditedService ( boolean ) [0..1]
This field is only returned if true, and indicates if the corresponding shipping service is an expedited shipping service.
See the Field Index to learn which calls use ExpeditedService.

FastAndFree ( boolean ) [0..1]
This field is only returned if true, and indicates if the corresponding shipping service is a 'Fast and Free' shipping service. With a 'Fast and Free' shipping service, a buyer in the specified destination can expect to receive their item within four business days at no cost (and the ShippingServiceCost value should be 0.0).
See the Field Index to learn which calls use FastAndFree.

LogisticPlanType ( string ) [0..1]
Reserved for internal or future use.
See the Field Index to learn which calls use LogisticPlanType.

ShippingInsuranceCost ( AmountType (double) ) [0..1]
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use ShippingInsuranceCost.

ShippingServiceAdditionalCost ( AmountType (double) ) [0..1]
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same order line item and uses the shipping service specified in the corresponding ShippingServiceName field. The seller should always supply this value for multiple-quantity, fixed-price listings. Sometimes, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the same order line item, so this value should usually be less than the value set for ShippingServiceCost.

The value of this field can even be set to 0 by the seller if the seller wants to encourage buyers to buy multiple quantity of the item, or it could be that the seller can fit multiple quantities of the order line item in a single shipping package, so the seller is just passing this shipping savings onto the buyer. This field is not applicable for single-quantity listings.

Note: The seller is expected to provide the ShippingServiceAdditionalCost value for all multiple-quantity, fixed-price listings, but it is not a required field when creating, revising or relisting an item. So, if the ShippingServiceAdditionalCost is not returned in GetShippingCosts, it is likely that the seller has not provided this value, in which case the corresponding ShippingServiceCost value may be inaccurate if the user specifies an integer value greater than '1' in the QuantitySold of the call request.
See the Field Index to learn which calls use ShippingServiceAdditionalCost.

ShippingServiceCost ( AmountType (double) ) [0..1]
The cost to ship the quantity of items specified in the QuantitySold field in the call request. If the QuantitySold field is omitted, its value defaults to 1. For example, if the corresponding shipping service charges 5.99 to ship a quantity of 1, and 2.99 to ship each additional unit beyond the first unit, the cost shown in this field will be 8.98 (5.99 + 2.99) if the QuantitySold field in the call request is set to 2. The corresponding ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same order line item.

Note: The seller is expected to provide the ShippingServiceAdditionalCost value for all multiple-quantity, fixed-price listings, but it is not a required field when creating, revising or relisting an item. So, if the ShippingServiceAdditionalCost is not returned in GetShippingCosts, it is likely that the seller has not provided this value, in which case the ShippingServiceCost value may be inaccurate if the user specifies an integer value greater than '1' in the QuantitySold of the call request.
See the Field Index to learn which calls use ShippingServiceCost.

ShippingServiceCutOffTime ( dateTime ) [0..1]
This field is no longer applicable and should not be returned for any international shipping service option.
See the Field Index to learn which calls use ShippingServiceCutOffTime.

ShippingServiceName ( token ) [0..1]
The name of a domestic shipping service option available to ship the item to specified domestic shipping destination. This field is always returned with each ShippingServiceOption container.
See the Field Index to learn which calls use ShippingServiceName.

ShippingServicePriority ( int ) [0..1]
This integer value indicates the seller-preferred presentation order of the domestic shipping service options. A shipping service option with a ShippingServicePriority value of '1' indicates that the shipping service appears in the first position on the listing's View Item and Checkout page. Generally, both the domestic and international shipping service options are returned in order in the GetShippingCosts response. A seller can specify up to four domestic shipping service options. This field should always be returned with each ShippingServiceOption container.
See the Field Index to learn which calls use ShippingServicePriority.

ShippingSurcharge ( AmountType (double) ) [0..1]
This field is only applicable and returned if the corresponding shipping service charges a shipping surcharge to the shipping destination. For example, a shipping surcharge may apply if a buyer from Alaska or Hawaii ordered an item from the Continental US, and the seller is using UPS to ship the item. If a shipping surcharge is applicable, the ShippingServiceCost field will account for this additional charge.
See the Field Index to learn which calls use ShippingSurcharge.

ShippingTimeMax ( int ) [0..1]
The integer value indicates the maximum number of business days that it will take for the item to be shipped (door-to-door) to the buyer using the corresponding shipping service option. The actual shipping carrier defines the maximum transit time, and not the seller. Take into account that the transit time is separate from the seller's stated handling time, so if the seller's handling time is two business days, and the transit time is three business days, the buyer can expect to receive their item in about five business days after payment has been made.
See the Field Index to learn which calls use ShippingTimeMax.

ShippingTimeMin ( int ) [0..1]
The integer value indicates the minimum number of business days that it will take for the item to be shipped (door-to-door) to the buyer using the corresponding shipping service option. The actual shipping carrier defines the minimum transit time, and not the seller. Take into account that the transit time is separate from the seller's stated handling time, so if the seller's handling time is two business days, and the transit time is three business days, the buyer can expect to receive their item in about five business days after payment has been made.
See the Field Index to learn which calls use ShippingTimeMin.

ShipsTo ( string ) [0..*]
A domestic location or region to which the item may be shipped via this particular shipping service. These 'ship-to' locations are provided by the seller when they create, revise, or relist their item, or they can be controlled through a Shipping Business Policy associated with the listing. At a bare minimum, the country of the location specified through the DestinationCountryCode field of the call request shall be returned in this field, or possibly 'Worldwide' if the shipping service option serves multiple countries.
See the Field Index to learn which calls use ShipsTo.