eBay Shopping APIVersion 1173

ShippingDetailsType

Type used to express the shipping-related details for an order line item.

Type that uses ShippingDetailsType:

Call that uses ShippingDetailsType:

Fields

CODCost ( AmountType (double) )
ExcludeShipToLocation ( string )
GetItFast ( boolean )
InsuranceCost ( AmountType (double) )
InsuranceOption ( InsuranceOptionCodeType )
InternationalInsuranceCost ( AmountType (double) )
InternationalInsuranceOption ( InsuranceOptionCodeType )
InternationalShippingServiceOption ( InternationalShippingServiceOptionType )
SalesTax ( SalesTaxType )
ShippingRateErrorMessage ( string )
ShippingServiceOption ( ShippingServiceOptionType )
TaxTable ( TaxTableType )


CODCost ( AmountType (double) ) [0..1]
This field returns the cost of cash-on-delivery for the listing. This field is only applicable to the Italy site (site ID 101), and is only returned if cash-on-delivery is the only available logistics type for the listing.
See the Field Index to learn which calls use CODCost.

ExcludeShipToLocation ( string ) [0..*]
One or more ExcludeShipToLocation fields are returned at the shipping service option level if the seller has excluded one or more geographical regions (such as 'Middle East' or 'Southeast Asia'), individual countries, individual states/provinces, or special domestic regions (such as Alaska/Hawaii or PO Boxes for the US). If a seller decides to exclude Hawaii and Alaska, an ExcludeShipToLocation field would be returned with a value of Alaska/Hawaii for each domestic shipping service option. For international shipping, if a seller ships globally but decides to exclude the 'Middle East', an ExcludeShipToLocation field would be returned with a value of Middle East for each international shipping service option.

'Ship-to' locations and excluded shipping locations are set by the seller through Shipping Rate Tables in My eBay, through a Shipping/Fulfillment Business Policy associated with a listing, or through the ShipToLocation and ExcludeShipToLocation fields in an Add/Revise/Relist call in the Trading API.
See the Field Index to learn which calls use ExcludeShipToLocation.

GetItFast ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use GetItFast.

InsuranceCost ( AmountType (double) ) [0..1]
If this field is returned at all, its value is always '0.0' as it is no longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use InsuranceCost.

InsuranceOption ( InsuranceOptionCodeType ) [0..1]
If this field is returned at all, its value should be NotOfferedOnSite, as it is no longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use InsuranceOption.

InternationalInsuranceCost ( AmountType (double) ) [0..1]
If this field is returned at all, its value is always '0.0' as it is no longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use InternationalInsuranceCost.

InternationalInsuranceOption ( InsuranceOptionCodeType ) [0..1]
If this field is returned at all, its value should be NotOfferedOnSite, as it is no longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use InternationalInsuranceOption.

InternationalShippingServiceOption ( InternationalShippingServiceOptionType ) [0..*]
This container consists of detailed information for an international shipping service option that is available to an international buyer located at the shipping destination specified in the call request. A InternationalShippingServiceOption container is returned for each available international shipping service option. A seller can specify up to five international shipping service options (including the Global Shipping Program) in an eBay listing.

No InternationalShippingServiceOption containers are returned if the shipping destination specified in the call request is a domestic destination. If the shipping destination is a domestic location, see the ShippingServiceOption container instead.
See the Field Index to learn which calls use InternationalShippingServiceOption.

SalesTax ( SalesTaxType ) [0..1]
This container is only returned if sales tax is applicable to the specified shipping destination.
See the Field Index to learn which calls use SalesTax.

ShippingRateErrorMessage ( string ) [0..1]
This field is only returned if an unexpected error occurs during the attempted calculation of shipping costs.
See the Field Index to learn which calls use ShippingRateErrorMessage.

ShippingServiceOption ( ShippingServiceOptionType ) [0..*]
This container consists of detailed information for a domestic shipping service option that is available to a buyer located at the shipping destination specified in the call request. A ShippingServiceOption container is returned for each available domestic shipping service option. A seller can specify up to four domestic shipping service options in an eBay listing.

No ShippingServiceOption containers are returned if the shipping destination specified in the call request is an international destination. If the shipping destination is an international location, see the InternationalShippingServiceOption container instead.
See the Field Index to learn which calls use ShippingServiceOption.

TaxTable ( TaxTableType ) [0..1]
This container includes sales tax percentage rates for one or more jurisdictions where the seller has configured and applied account-level sales tax settings for the listing. Changes to sales tax settings can be made in Sales Tax Table in My eBay, or through the SetTaxTable call of the Trading API. This container is returned as an empty element if no sales tax rates have been set up for any jurisdictions.
See the Field Index to learn which calls use TaxTable.



Copyright © 2006–2020 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.