eBay Merchant Data APIVersion 1255
 

ShippingServiceOptionsType

Container consisting of shipping costs and other details related to a domestic shipping service. A ShippingServiceOptions container is required for each domestic shipping service option that the seller will make available to buyers in an Add/Revise/Relist call. Up to four domestic shipping service options can be offered per listing.

Types that use ShippingServiceOptionsType:

Calls that use ShippingServiceOptionsType:

Fields



ExpeditedService ( boolean ) [0..1]
This field is returned as true if the domestic shipping service is considered an expedited shipping service. An expedited service is typically a shipping service that can ship an order that will arrive at the buyer's location within one to two business days.
See the Field Index to learn which calls use ExpeditedService.

FreeShipping ( boolean ) [0..1]
This boolean field indicates whether or not the corresponding domestic shipping service option is free to the buyer. In an Add/Revise/Relist call, free shipping can only be offered for the first specified shipping service (so, the corresponding ShippingServicePriority value should be 1 or included first in the call request). If 'free shipping' is for any other shipping service, this field is ignored.

For 'Get' calls, including GetItem, this field is only returned if 1.

Note: If a seller is specifying a shipping service option as 'free shipping', in addition to this FreeShipping boolean field, the seller will also need to include the corresponding ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically.
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]
Not used by any call.

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]
Not used by any call.

Reserved for internal or future use.
See the Field Index to learn which calls use LogisticPlanType.

ShippingInsuranceCost ( AmountType (double) ) [0..1]
Not used by any call.

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.

ShippingPackageInfo ( ShippingPackageInfoType ) [0..*]
This container is no longer applicable, and it was only applicable to eBay Now and 'eBay On Demand Delivery' orders, and neither of these features are available any longer.
See the Field Index to learn which calls use ShippingPackageInfo.

ShippingService ( token ) [0..1]
This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container.

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.

Note: The eBay standard envelope (eSE) is a domestic envelope service with tracking through eBay. This service applies to specific sub-categories of Trading Cards categories, and to Coins & Paper Money, Postcards, and Stamps. To use this service, send envelopes using the USPS mail and set the ShippingService field to US_eBayStandardEnvelope. See eBay standard envelope for details and restrictions. For the REST equivalent, see Using the eBay standard envelope (eSE) 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 one unit of the item using the shipping service specified in the corresponding ShippingService field.

In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item.

Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to 0.0, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost.

Note that if ShippingService is set to LocalPickup, ShippingServiceCost must be set to 0.0. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero.

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.
See the Field Index to learn which calls use ShippingServiceCost.

ShippingServiceCutOffTime ( dateTime ) [0..1]
Not used by any call.

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.

If this field is omitted from domestic shipping service options, the order of the shipping service options in View Item and Checkout pages will be determined by the order that these shipping service options are presented in the request payload of an Add/Revise/Relist call.
See the Field Index to learn which calls use ShippingServicePriority.

ShippingTimeMax ( int ) [0..1]
Not used by any call.

The integer value returned here indicates the maximum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
See the Field Index to learn which calls use ShippingTimeMax.

ShippingTimeMin ( int ) [0..1]
Not used by any call.

The integer value returned here indicates the minimum number of business days that the shipping service (indicated in the corresponding ShippingService field) will take to be delivered to the buyer.

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
See the Field Index to learn which calls use ShippingTimeMin.