eBay Trading APIVersion 1019

ShippingServiceOptionsType

Container consisting of shipping costs and other details related to a domestic shipping service. An exception to the domestic shipping service rule is seen in the ShippingServiceSelected container returned under the Order and Transaction containers in order and order line item retrieval calls such as GetOrders or GetItemTransactions. In this scenario, the SelectedShippingService container consists of either domestic or international shipping service data, based on the selected service according to the buyer's shipping address.

If one or more international shipping services are provided, the seller must specify at least one domestic shipping service as well.

Note: For GetItemTransactions and GetSellerTransactions, this container does not return accurate shipping service and cost information for multiple line item orders. Use GetOrders instead, and provide the order's combined OrderID to retrieve this information.

Types that use ShippingServiceOptionsType:

Calls that use ShippingServiceOptionsType:

Fields



ExpeditedService ( boolean ) [0..1]
Indicates whether the service is an expedited shipping service.
See the Field Index to learn which calls use ExpeditedService.

FreeShipping ( boolean ) [0..1]
Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service.

If the seller specifies FreeShipping but requires shipping insurance (InsuranceOption = Require), eBay sets the insurance cost to 0.00. However, if shipping insurance is optional and the buyer chooses shipping insurance, eBay preserves the cost of shipping insurance. It is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping.
See the Field Index to learn which calls use FreeShipping.

ImportCharge ( AmountType (double) ) [0..1]
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
See the Field Index to learn which calls use ImportCharge.

LocalPickup ( boolean ) [0..1]
The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option. The LocalPickup flag can also be used with other fields to indicate if there is no fee for local pickup.

For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.
See the Field Index to learn which calls use LocalPickup.

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]
The insurance cost associated with shipping a single item with this shipping service.

Exception: For GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingInsuranceCost.

ShippingPackageInfo ( ShippingPackageInfoType ) [0..*]
This container is returned in order management calls.

If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times.

For non-eBay Now orders, this container returns an estimated delivery window.
See the Field Index to learn which calls use ShippingPackageInfo.

ShippingService ( token ) [0..1]
A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = true field, as this indicates that the ShippingService value is an International shipping service option.

For flat and calculated shipping. Also applicable to Half.com (for GetOrders).

If there are two or more services and one is "pickup", "pickup" must not be specified as the first service.
See the Field Index to learn which calls use ShippingService.

ShippingServiceAdditionalCost ( AmountType (double) ) [0..1]
The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. This field is required when creating a multiple-quantity, fixed-price listing. Generally, the seller will give the buyer a shipping discount if that buyer purchases multiple quantity of the 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 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 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.
See the Field Index to learn which calls use ShippingServiceAdditionalCost.

ShippingServiceCost ( AmountType (double) ) [0..1]
The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item.

When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned.

If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable.
  • If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services.
  • If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.)
Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingServiceCost.

ShippingServiceCutOffTime ( dateTime ) [0..1]
The last time of day that an order using the specified shipping service will be accepted by the seller for the current listing. The cut off time applies and is returned only when the ShippingService field contains the name of a qualifying time-sensitive shipping service, such as eBayNowImmediateDelivery.

The cut off time is set by eBay and determined in part by the policies and locations of the seller and the shipping carrier.
See the Field Index to learn which calls use ShippingServiceCutOffTime.

ShippingServicePriority ( int ) [0..1]
Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page.

Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings.
See the Field Index to learn which calls use ShippingServicePriority.

ShippingSurcharge ( AmountType (double) ) [0..1]
An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only.
See the Field Index to learn which calls use ShippingSurcharge.

ShippingTimeMax ( int ) [0..1]
The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
See the Field Index to learn which calls use ShippingTimeMax.

ShippingTimeMin ( int ) [0..1]
The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier).
See the Field Index to learn which calls use ShippingTimeMin.