This doc page has moved! You should be automatically redirected to the resources page for the eBay Account API. If you are not redirected automatically, follow this link to the Account API.

eBay Account APIVersion 1.2.0

ShippingService

A complex type defining the available shipping services.

Type that uses ShippingService:

Calls that use ShippingService:

Fields



additionalShippingCost ( Amount ) [0..?]
Additional shipping cost, such as handling costs. This cost cannot be greater than the base shipping cost.
See the Field Index to learn which calls use additionalShippingCost.

buyerResponsibleForPickup ( boolean ) [0..?]
This field is only applicable to vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for picking up the vehicle. Otherwise, the seller should specify the vehicle pickup arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

Default: false
See the Field Index to learn which calls use buyerResponsibleForPickup.

buyerResponsibleForShipping ( boolean ) [0..?]
This field is applicable for only items listed in vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for the shipment of the vehicle. Otherwise, the seller should specify the vehicle shipping arrangements in the item description.

If the vehicle has bids or the listing ends within 12 hours, the seller cannot modify this flag.

Default: false
See the Field Index to learn which calls use buyerResponsibleForShipping.

cashOnDeliveryFee ( Amount ) [0..?]
The value indicates the Cash on Delivery (COD) fee that the seller charges if the buyer uses the CASH_ON_DELIVERY payment method. This fee is added to the total cost of the item, and the total cost is due from the buyer upon the delivery of the item. This field is applicable only if the buyer-selected payment method is 'COD' and the selected shipping service option supports a Cash on Delivery option.

To see if a domestic shipping service supports the Cash on Delivery option, call GeteBayDetails and set DetailName to 'ShippingServiceDetails'. In the response, see if CODService is set to 'true' for the targeted shipping service.
See the Field Index to learn which calls use cashOnDeliveryFee.

freeShipping ( boolean ) [0..?]
The seller can set this flag to true if they want to offer free shipping to the buyer. This field can only be included and set to 'true' for the first specified domestic shipping service option (it is ignored if set for subsequent shipping service options). The first specified shipping service option has a sortOrder value of '1', or (if the sortOrderId field is not used) it is the shipping service option specified first in the API call.
See the Field Index to learn which calls use freeShipping.

shippingCarrierCode ( string ) [0..?]
The shipping carrier, such as 'USPS,' 'FedEx' and so on.
See the Field Index to learn which calls use shippingCarrierCode.

shippingCost ( Amount ) [0..?]
The estimated total cost of shipping based for the selected shipping carrier and service. This field is required in the input for all listings where flat-rate shipping is used, and it is not applicable to calculated shipping.

The seller can set this value at their discretion, however, the value should reflect the approximate total cost of the selected shipping service plus any additional charges (such as the seller's handling charges).

This value is set to '0.0' if freeShipping is set to 'true'.

See the Field Index to learn which calls use shippingCost.

shippingServiceCode ( string ) [0..?]
The shipping service that the shipping carrier uses to ship an item. For example, an overnight, two-day delivery, or other type of service. For a list of valid shippingServiceCode values, call GeteBayDetails with ShippingServiceDetails set to DetailName. In the response, review the ShippingServiceDetails containers for the supported values.
See the Field Index to learn which calls use shippingServiceCode.

shipToLocations ( RegionSet ) [0..?]
An international region (such as Asia, Europe, or Latin America) or country to where the seller will ship an item.

Each eBay marketplace supports its own set of allowable shipping locations, specified as regions and countries. Obtain the valid 'Ship-To locations' for a marketplace by calling GeteBayDetails in the Trading API, and set DetailName to ShipppingLocationDetails in the request; in the response, review the ShippingLocationDetails.ShippingLocation values for the shipping locations supported by the marketplace. The seller may include as many valid shipToLocation values as necessary based on where they are willing to ship an item.

If this value is not set, eBay automatically uses the seller's listing country as the default Ship-To Location.

To offer shipping to every region and country supported by the eBay shipping services, pass 'WORLDWIDE' as a shipToLocation value. To exclude one or more countries from a region you want to ship to, use the excludeShipToLocation field. Also, if the seller wants to offer international shipping as part of their shipping policy, they must set at least one international location in shipToLocation.
See the Field Index to learn which calls use shipToLocations.

sortOrder ( integer ) [0..?]
This integer value controls the order that this shipping service option appears in the View Item and Checkout pages, as related to the other specified shipping service options.

Sellers can specify up to four domestic shipping services (in four separate shippingService containers), so valid values are 1, 2, 3, and 4. A shipping service option with a sortOrder value of '1' appears at the top of View Item and Checkout pages. Conversely, a shipping service option with a sortOrder value of '4' appears at the bottom of the list.

Sellers can specify up to five international shipping services (in five separate shippingService containers, so valid values for international shipping services are 1, 2, 3, 4, and 5. Similarly to domestic shipping service options, the sortOrder value of a international shipping service option controls the placement of that shipping service option in the View Item and Checkout pages. Set up different domestic and international services by configuring two shippingOptions containers, where you set shippingOptions.optionType to either DOMESTIC or INTERNATIONAL to indicate the area supported by the listed shipping services.

If the sortOrder field is not supplied, the order of domestic and international shipping service options is determined by the order in which they are listed in the API call.

Min: 1. Max: 4 (for domestic shipping service) or 5 (for international shipping service).
See the Field Index to learn which calls use sortOrder.

surcharge ( Amount ) [0..?]
The surcharge amount that they buyer must pay.
See the Field Index to learn which calls use surcharge.