eBay Shopping APIVersion 1119

GetShippingCosts

This call is used to retrieve the estimated shipping cost to ship an active item to a specified destination country and postal code. Any user can make this call on an active listing (does not have to be the seller or buyer/bidder). It pertains to all shipping types, including flat-rate and calculated.

Shipping cost estimates are dependent on the domestic and international shipping service options that the seller has provided. If the seller does not ship to the provided location (specified through the DestinationCountryCode and DestinationPostalCode fields, an error message such as 'Item has no shipping option' will be returned in the response.

If the IncludeDetails field is omitted, or included but set to false, only the ShippingCostSummary container is returned, summarizing the cheapest shipping service option available to the shipping destination. However, if the IncludeDetails field is included and set to true, the ShippingDetails container is also returned, and this container consists of much more detailed information, including every shipping service option that is available to service the shipping destination, as well as information on sales tax and excluded shipping locations (if applicable).

See also the reference documentation for this call:



Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

<?xml version="1.0" encoding="utf-8"?>
<GetShippingCostsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <DestinationCountryCode> CountryCodeType </DestinationCountryCode>
  <DestinationPostalCode> string </DestinationPostalCode>
  <IncludeDetails> boolean </IncludeDetails>
  <ItemID> string </ItemID>
  <QuantitySold> int </QuantitySold>
  <!-- Standard Input Fields -->
  <MessageID> string </MessageID>
</GetShippingCostsRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
DestinationCountryCode CountryCodeType Conditional Destination country code. If DestinationCountryCode is US, postal code is required and represents US zip code.

Default: US.

Applicable values: See DestinationCountryCode.
DestinationPostalCode string Conditional Destination country postal code (or zip code, for US). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries. Ignored for flat-rate shipping.
IncludeDetails boolean Optional This field should be included and set to true if the user would like the ShippingDetails returned in the response.

Default: false.
ItemID string Required The item ID that uniquely identifies the listing for which to retrieve the data.
Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
QuantitySold int Optional Quantity of items sold to a single buyer and to be shipped together.

Default: 1.
Standard Input Fields  
MessageID string Optional If you pass a value into the MessageID field in a request, the same value is returned in CorrelationID field in the response. If you're making a lot of calls, you can use this for tracking that a response is returned for every request and to match particular responses to particular requests. (In this case, specify a different value for each request.) You can specify any value that is useful to you.



Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

<?xml version="1.0" encoding="utf-8"?>
<GetShippingCostsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <PickUpInStoreDetails> PickUpInStoreDetailsType
    <AvailableForPickupInStore> boolean </AvailableForPickupInStore>
    <EligibleForPickupInStore> boolean </EligibleForPickupInStore>
  </PickUpInStoreDetails>
  <ShippingCostSummary> ShippingCostSummaryType
    <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
    <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
    <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
    <ListedShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ListedShippingServiceCost>
    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
    <ShippingServiceName> string </ShippingServiceName>
    <ShippingType> ShippingTypeCodeType </ShippingType>
  </ShippingCostSummary>
  <ShippingDetails> ShippingDetailsType
    <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
    <ExcludeShipToLocation> string </ExcludeShipToLocation>
    <!-- ... more ExcludeShipToLocation values allowed here ... -->
    <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
    <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
    <InternationalInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InternationalInsuranceCost>
    <InternationalInsuranceOption> InsuranceOptionCodeType </InternationalInsuranceOption>
    <InternationalShippingServiceOption> InternationalShippingServiceOptionType
      <EstimatedDeliveryMaxTime> dateTime </EstimatedDeliveryMaxTime>
      <EstimatedDeliveryMinTime> dateTime </EstimatedDeliveryMinTime>
      <ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
      <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
      <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      <ShippingServiceCutOffTime> dateTime </ShippingServiceCutOffTime>
      <ShippingServiceName> token </ShippingServiceName>
      <ShippingServicePriority> int </ShippingServicePriority>
      <ShipsTo> string </ShipsTo>
      <!-- ... more ShipsTo values allowed here ... -->
    </InternationalShippingServiceOption>
    <!-- ... more InternationalShippingServiceOption nodes allowed here ... -->
    <SalesTax> SalesTaxType
      <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
      <SalesTaxPercent> float </SalesTaxPercent>
      <SalesTaxState> string </SalesTaxState>
      <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
    </SalesTax>
    <ShippingRateErrorMessage> string </ShippingRateErrorMessage>
    <ShippingServiceOption> ShippingServiceOptionType
      <EstimatedDeliveryMaxTime> dateTime </EstimatedDeliveryMaxTime>
      <EstimatedDeliveryMinTime> dateTime </EstimatedDeliveryMinTime>
      <ExpeditedService> boolean </ExpeditedService>
      <FastAndFree> boolean </FastAndFree>
      <LogisticPlanType> string </LogisticPlanType>
      <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
      <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
      <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      <ShippingServiceCutOffTime> dateTime </ShippingServiceCutOffTime>
      <ShippingServiceName> token </ShippingServiceName>
      <ShippingServicePriority> int </ShippingServicePriority>
      <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
      <ShippingTimeMax> int </ShippingTimeMax>
      <ShippingTimeMin> int </ShippingTimeMin>
      <ShipsTo> string </ShipsTo>
      <!-- ... more ShipsTo values allowed here ... -->
    </ShippingServiceOption>
    <!-- ... more ShippingServiceOption nodes allowed here ... -->
    <TaxTable> TaxTableType
      <TaxJurisdiction> TaxJurisdictionType
        <JurisdictionID> string </JurisdictionID>
        <SalesTaxPercent> float </SalesTaxPercent>
        <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
      </TaxJurisdiction>
      <!-- ... more TaxJurisdiction nodes allowed here ... -->
    </TaxTable>
  </ShippingDetails>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetShippingCostsResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
PickUpInStoreDetails PickUpInStoreDetailsType Conditionally This container is only returned in GetShippingCosts if In-Store Pickup is available for the listing.

Note: The In-Store Pickup feature is only available to a limited number of large retail merchants in the US, and can only be applied to multiple-quantity, fixed-price listings.
PickUpInStoreDetails
  .AvailableForPickupInStore
boolean Conditionally This field is returned as true if the listing is eligible for In-Store Pickup or Click and Collect feature (EligibleForPickupInStore returned as true), and the listing has inventory in a store near the destination country/postal code specified in the request. It is quite possible that the listing is eligible for In-Store Pickup/Click and Collect, but no stores near the specified destination has inventory, in which case, this field will return as false.

When a seller is successful at listing an item with the In-Store Pickup/Click and Collect feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see an "available for pickup" option on the View Item page, along with information on the closest phsical store that has the item.
PickUpInStoreDetails
  .EligibleForPickupInStore
boolean Conditionally This field is returned as true if the listing is eligible for In-Store Pickup or Click and Collect features. A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, the In-Store Pickup feature is generally only available to large retail merchants in the US, Canada, UK, Germany, and Australia, and the Click and Collect feature is generally only available to large retail merchants in the UK, Australia, and Germany. Both of these features can only be applied to multiple-quantity, fixed-price listings.

When a seller is successful at listing an item with the In-Store Pickup/Click and Collect feature enabled, prospective buyers within a reasonable distance (25 miles or so) from one of the seller's stores (that has stock available) will see an "available for pickup" option on the View Item page, along with information on the closest phsical store that has the item.
ShippingCostSummary ShippingCostSummaryType Always This container returns a few details of the lowest-priced shipping service option that is available to the shipping destination specified in the call request. For Calculated shipping, the item's location and the destination location are considered when calculating the shipping cost.

Important: To retrieve detailed information on every shipping service option available to the specified shipping destination, the user must include the IncludeDetails boolean field in the call request, and set its value to true. Shipping details on one or more available domestic shipping service options can be found in the ShippingDetails.ShippingServiceOption container(s), and shipping details on one or more available international shipping service options can be found in the ShippingDetails.InternationalShippingServiceOption container(s).
ShippingCostSummary
  .ImportCharge
AmountType (double) Conditionally 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.
ShippingCostSummary
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingCostSummary
  .InsuranceCost
AmountType (double) Conditionally 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.
ShippingCostSummary
  .InsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingCostSummary
  .InsuranceOption
InsuranceOptionCodeType Conditionally 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.

Applicable values:

NotOffered
(out) A seller can no longer offer shipping insurance to the buyer, but the InsuranceOption or InternationalInsuranceOption fields may still be returned with this value.
NotOfferedOnSite
(out) A seller can no longer offer shipping insurance to the buyer, but the InsuranceOption field is still returned with this value.

Code so that your app gracefully handles any future changes to this list.
ShippingCostSummary
  .ListedShippingServiceCost
AmountType (double) Always This is the localized cost to ship the item using the cheapest available domestic or international shipping service option. If the item is located in Germany, but the shipping destination is the US, this field will show the cost in Euros (EUR) and the ShippingServiceCost will show the cost in US dollars (USD).

For GetShippingCosts call, this is the localized base shipping cost to ship the item using the shipping service option in the ShippingServiceName field. The quantity specified in the QuantitySold field in the call request is taken into account when calculating the cost.

For GetSingleItem and GetMultipleItems calls, this is the localized base shipping cost of the cheapest available shipping service option to the country specified in the Site-ID header. The name of the shipping service option is not returned for these calls.
ShippingCostSummary
  .ListedShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally This is the localized cost to ship the item using the cheapest available domestic or international shipping service option. If the item is located in Germany, but the shipping destination is the US, this field will show the cost in Euros (EUR) and the ShippingServiceCost will show the cost in US dollars (USD).

For GetShippingCosts call, this is the localized base shipping cost to ship the item using the shipping service option in the ShippingServiceName field. The quantity specified in the QuantitySold field in the call request is taken into account when calculating the cost.

For GetSingleItem and GetMultipleItems calls, this is the localized base shipping cost of the cheapest available shipping service option to the country specified in the Site-ID header. The name of the shipping service option is not returned for these calls.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingCostSummary
  .ShippingServiceCost
AmountType (double) Always This field shows the base shipping cost using the lowest-priced shipping service option that is available to the eBay user making the call.

For GetShippingCosts call, this is base shipping cost to ship the item using the shipping service option in the ShippingServiceName field. The quantity specified in the QuantitySold field in the call request is taken into account when calculating the cost.

For GetSingleItem and GetMultipleItems calls, this is base shipping cost of the cheapest available domestic shipping service option. The name of the shipping service option is not returned for these calls.
ShippingCostSummary
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field shows the base shipping cost using the lowest-priced shipping service option that is available to the eBay user making the call.

For GetShippingCosts call, this is base shipping cost to ship the item using the shipping service option in the ShippingServiceName field. The quantity specified in the QuantitySold field in the call request is taken into account when calculating the cost.

For GetSingleItem and GetMultipleItems calls, this is base shipping cost of the cheapest available domestic shipping service option. The name of the shipping service option is not returned for these calls.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingCostSummary
  .ShippingServiceName
string Always This field shows the name of the lowest-priced shipping service option that is available to the eBay user making the call. An example of a shipping service option is USPS First Class Package.

This field is only returned by the GetShippingCosts call (and not GetSingleItem or GetMultipleItems calls).
ShippingCostSummary
  .ShippingType
ShippingTypeCodeType Always This enumeration value indicates the shipping cost model associated with the lowest-priced shipping service option that is available to the eBay user making the call. Examples of shipping cost models include flat-rate and calculated shipping.

For GetShippingCosts call, this is the shipping cost model associated with the shipping service option in the ShippingServiceName field. The name of the shipping service option is not returned for the GetSingleItem and GetMultipleItems calls calls.

Applicable values: See ShippingType.
Code so that your app gracefully handles any future changes to this list.
ShippingDetails ShippingDetailsType Conditionally This container consists of shipping details related to the specified item and specified shipping destination. This container is only returned if the IncludeDetails field is included and set to true in the call request. If the specified shipping destination is a domestic location, one or more ShippingServiceOption containers are returned - one for each available shipping service option. If the specified shipping destination is an international location, one or more InternationalShippingServiceOption containers are returned - one for each available shipping service option.

The available domestic and international shipping service options will contain details such as shipping service name, shipping cost, ship-to locations, and estimated delivery window (which is based on the seller's stated handling time plus the expected shipping time of the shipping service).
ShippingDetails.CODCost AmountType (double) Conditionally 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.
ShippingDetails.CODCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .ExcludeShipToLocation
string Conditionally,
repeatable: [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.
ShippingDetails.InsuranceCost AmountType (double) Conditionally 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.
ShippingDetails.InsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .InsuranceOption
InsuranceOptionCodeType Conditionally 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.

Applicable values:

NotOffered
(out) A seller can no longer offer shipping insurance to the buyer, but the InsuranceOption or InternationalInsuranceOption fields may still be returned with this value.
NotOfferedOnSite
(out) A seller can no longer offer shipping insurance to the buyer, but the InsuranceOption field is still returned with this value.

Code so that your app gracefully handles any future changes to this list.
ShippingDetails
  .InternationalInsuranceCost
AmountType (double) Conditionally 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.
ShippingDetails
  .InternationalInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .InternationalInsuranceOption
InsuranceOptionCodeType Conditionally 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.

Applicable values:

NotOffered
(out) A seller can no longer offer shipping insurance to the buyer, but the InsuranceOption or InternationalInsuranceOption fields may still be returned with this value.
NotOfferedOnSite
(out) A seller can no longer offer shipping insurance to the buyer, but the InsuranceOption field is still returned with this value.

Code so that your app gracefully handles any future changes to this list.
ShippingDetails
  .InternationalShippingServiceOption
InternationalShippingServiceOptionType Conditionally,
repeatable: [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.
ShippingDetails
  .InternationalShippingServiceOption
  .EstimatedDeliveryMaxTime
dateTime Conditionally This timestamp indicates the latest date/time that the item should reach the seller's destination based on the seller's stated handling time and the shipping service's transit time. This timestamp is based on an immediate purchase of the item at checkout.
ShippingDetails
  .InternationalShippingServiceOption
  .EstimatedDeliveryMinTime
dateTime Conditionally This timestamp indicates the earliest date/time that the item could possibly reach the seller's destination based on the seller's stated handling time and the shipping service's transit time. This timestamp is based on an immediate purchase of the item at checkout.
ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge
AmountType (double) Conditionally The estimated cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This field is only applicable for international orders being handled through the Global Shipping Program; otherwise, it will not be returned.
ShippingDetails
  .InternationalShippingServiceOption
  .ImportCharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally The estimated cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This field is only applicable for international orders being handled through the Global Shipping Program; otherwise, it will not be returned.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally 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.
ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
AmountType (double) Conditionally 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.
ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceCutOffTime
dateTime Conditionally This field is no longer applicable and should not be returned for any international shipping service option.
ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServiceName
token Conditionally The name of an international shipping service option available to ship the item to specified international shipping destination. This field is always returned with each InternationalShippingServiceOption container.

Note: If the seller is using eBay's Global Shipping Program (GSP) to ship the item to the international location, the string value returned in this field is 'International Priority Shipping'.
ShippingDetails
  .InternationalShippingServiceOption
  .ShippingServicePriority
int Conditionally This integer value indicates the seller-preferred presentation order of the international 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 five international shipping service options (including the Global Shipping Program option). This field should always be returned with each InternationalShippingServiceOption container.
ShippingDetails
  .InternationalShippingServiceOption
  .ShipsTo
string Conditionally,
repeatable: [0..*]
An international 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, and possibly many other countries that are serviced by this shipping service option (or GSP).
ShippingDetails.SalesTax SalesTaxType Conditionally This container is only returned if sales tax is applicable to the specified shipping destination.
ShippingDetails.SalesTax
  .SalesTaxAmount
AmountType (double) Conditionally This is the expected tax amount based on the item cost (and shipping costs if ShippingIncludedInTax is true), the sales tax percentage, and the shipping destination.
ShippingDetails.SalesTax
  .SalesTaxAmount
  [ attribute currencyID ]
CurrencyCodeType Conditionally This is the expected tax amount based on the item cost (and shipping costs if ShippingIncludedInTax is true), the sales tax percentage, and the shipping destination.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails.SalesTax
  .SalesTaxPercent
float Conditionally Percent of an item's price to be charged as the sales tax for the transaction. The sales tax percentage value is stored with a precision of three digits after the decimal point (##.###).
ShippingDetails.SalesTax
  .SalesTaxState
string Conditionally State or jurisdiction for which the sales tax is applicable. Only returned if the seller specified a value. This should be the same value that is passed into the DestinationPostalCode in the call request.
ShippingDetails.SalesTax
  .ShippingIncludedInTax
boolean Conditionally This field is returned as true if shipping costs (in addition to item cost) are considered when calculating the sales tax amount. Shipping costs can only be taxed for US listings.
ShippingDetails
  .ShippingRateErrorMessage
string Conditionally This field is only returned if an unexpected error occurs during the attempted calculation of shipping costs.
ShippingDetails
  .ShippingServiceOption
ShippingServiceOptionType Conditionally,
repeatable: [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.
ShippingDetails
  .ShippingServiceOption
  .EstimatedDeliveryMaxTime
dateTime Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .EstimatedDeliveryMinTime
dateTime Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .ExpeditedService
boolean Conditionally This field is only returned if true, and indicates if the corresponding shipping service is an expedited shipping service.
ShippingDetails
  .ShippingServiceOption
  .FastAndFree
boolean Conditionally 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).
ShippingDetails
  .ShippingServiceOption
  .LogisticPlanType
string Conditionally Reserved for internal or future use.
ShippingDetails
  .ShippingServiceOption
  .ShippingInsuranceCost
AmountType (double) Conditionally This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
ShippingDetails
  .ShippingServiceOption
  .ShippingInsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .ShippingServiceOption
  .ShippingServiceAdditionalCost
AmountType (double) Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .ShippingServiceAdditionalCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .ShippingServiceOption
  .ShippingServiceCost
AmountType (double) Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .ShippingServiceCost
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .ShippingServiceOption
  .ShippingServiceCutOffTime
dateTime Conditionally This field is no longer applicable and should not be returned for any international shipping service option.
ShippingDetails
  .ShippingServiceOption
  .ShippingServiceName
token Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .ShippingServicePriority
int Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .ShippingSurcharge
AmountType (double) Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .ShippingSurcharge
  [ attribute currencyID ]
CurrencyCodeType Conditionally 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.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails
  .ShippingServiceOption
  .ShippingTimeMax
int Conditionally 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.
ShippingDetails
  .ShippingServiceOption
  .ShippingTimeMin
int Conditionally 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.
ShippingDetails
  .ShippingServiceOption.ShipsTo
string Conditionally,
repeatable: [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.
ShippingDetails.TaxTable TaxTableType Always 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.
ShippingDetails.TaxTable
  .TaxJurisdiction
TaxJurisdictionType Conditionally,
repeatable: [0..*]
A TaxJurisdiction container is returned for each tax jurisdiction where the seller has defined a sales tax rate (using the Sales Tax Table UI in My eBay), and each of these containers show the sales tax rate for the corresponding tax jurisdiction (and not just the tax jurisdiction associated with the specified DestinationPostalCode in the call request).

Note: As of November 1, 2019, buyers in over 30 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic.
ShippingDetails.TaxTable
  .TaxJurisdiction
  .JurisdictionID
string Conditionally Unique identifier of the sales tax jurisdiction (typically, a state or province). In the US, the two-digit acronyms for the states are used (such as 'CA' for California).
ShippingDetails.TaxTable
  .TaxJurisdiction
  .SalesTaxPercent
float Conditionally The sales tax percentage that will be applied to orders shipped to this jurisdiction. Sellers define sales tax rates for different tax jurisdictions using the Sales Tax Table UI in My eBay. The sales tax percent value supports a precision of 3 digits after the decimal point (##.###).

Note: As of November 1, 2019, buyers in over 30 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic.
ShippingDetails.TaxTable
  .TaxJurisdiction
  .ShippingIncludedInTax
boolean Conditionally This boolean field indicates whether or not shipping costs are to be part of the base order amount that is taxed. This value is 'false' by default, and the seller will have to mark this setting to 'true' in the Sales Tax Table UI in My eBay.

Note: As of November 1, 2019, buyers in over 30 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of US states that are subject to eBay 'Collect and Remit' taxes (and effective dates), see the eBay sales tax collection help topic.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
Build string Always This refers to the particular software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. Only returned if MessageID was used.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors or warnings (if any) that were raised when eBay processed the request.

Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request.

Only returned if there were warnings or errors.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Code so that your app gracefully handles any future changes to this list.

See Errors by Number.

Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

See Errors by Number.

Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page.

See Errors by Number.

Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page.
Errors.ErrorParameters.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.

See Errors by Number.

Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error caused the request to fail.

If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.

If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

Code so that your app gracefully handles any future changes to this list.

See:
    Errors by Number
    Error Handling

Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.

See Errors by Number.

Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about this time format and converting to and from the GMT time zone.
Version string Always The version of the API call that eBay used to process the request.

Note: Note that some calls are not always updated with each WSDL release, so it is possible that version numbers will differ by API call.
If a field in the response returns the token "CustomCode", it usually means that the field is a code type (a token or enumeration), and that in your request URL (or HTTP header) you specified a version that is older than the version in which the token was added to the call.

See Schema Versioning Strategy.



Detail Controls


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Retrieves both summary and detailed shipping cost information associated with a specific ItemID.

Input

To see item details in addition to a summary of shipping costs, set IncludeDetails to true. Doing so returns the ShippingDetails container in addition to the default ShippingSummary container. Note that if QuantitySold were omitted, it would default to 1.

URL format. See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.
https://open.api.ebay.com/shopping?
   callname=GetShippingCosts&
   responseencoding=XML&
   appid=YourAppIDHere&
   siteid=0&
   version=517&
   ItemID=180126682091&
   DestinationCountryCode=US&
   DestinationPostalCode=95128&
   IncludeDetails=true&
   QuantitySold=1

   Here is the same input in XML format. Note that this does not include standard values.

XML format. Also available is the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<GetShippingCostsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <ItemID>180126682091</ItemID>
  <DestinationCountryCode>US</DestinationCountryCode>
  <DestinationPostalCode>95128</DestinationPostalCode>
  <IncludeDetails>true</IncludeDetails>
  <QuantitySold>1</QuantitySold>
</GetShippingCostsRequest>

Output

The result shows that the item was listed with the flat rate shipping cost model, as seen in value for ShippingCostSummary.ShippingType.

XML format. Also available is the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<GetShippingCostsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-05-11T01:29:36.765Z</Timestamp>
  <Ack>Success</Ack>
  <Build>e967_core_APILW_4693054_R1</Build>
  <Version>967/Version>
  <ShippingDetails>
    <InsuranceOption>NotOffered</InsuranceOption>
    <ShippingRateErrorMessage>No Error</ShippingRateErrorMessage>
    <ShippingServiceOption>
      <ShippingServiceName>Standard Flat Rate Shipping Service</ShippingServiceName>
      <ShippingServiceCost currencyID="USD">2.45</ShippingServiceCost>
      <ShippingTimeMin>0</ShippingTimeMin>
      <ShippingTimeMax>0</ShippingTimeMax>
    </ShippingServiceOption>
    <TaxTable/>
  </ShippingDetails>
  <ShippingCostSummary>
    <ShippingServiceName>Standard Flat Rate Shipping Service</ShippingServiceName>
    <ShippingServiceCost currencyID="USD">2.45</ShippingServiceCost>
    <ShippingType>Flat</ShippingType>
  </ShippingCostSummary>
</GetShippingCostsResponse>



Change History

Change Date Description
1119
2019-08-02
  • GetShippingCosts (modified): Shopping API endpoint updated to support 'https' protocol. So, the following production endpoint should be used for all Shopping API calls: https://open.api.ebay.com/shopping. The http://open.api.ebay.com/shopping endpoint will still be supported for the time being, but is subject to be wired off.
  • null
0869
2014-04-08
  • PickupInStoreDetails (added): A new container that is returned if the listing is enabled for the In-Store Pickup option.
0861
2014-02-11
  • ShippingServiceCutOffTime (added): 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 seller offers the listing with a qualifying time-sensitive shipping service, such as eBay Now delivery.
0781
2012-07-04
  • ShippingServiceOption.FastAndFree (added): This field will appear as 'true' if the shipping service is fast (less than four days) and free for the buyer.
0777
2012-06-06
  • ImportCharge (added): The total cost of customs and taxes that will be applied to a item shipped internationally using the Global Exchange Program. ImportCharge is returned in ShippingDetails.InternationalShippingServiceOption and in ShippingCostSummary. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
0665
2010-04-14
  • ShippingCostSummary.ListedShippingServiceCost (modified): This is now returned as documented (bug fix).
  • ExcludeShipToLocation, ShipTo (added): With a request version of 665 or greater, ExcludeShipToLocation and ShipTo are returned if they were set via Trading API.
  • ShippingSurcharge (modified): With a request version of 665 or greater, the total shipping cost includes any surcharge, and surcharge is no longer returned as an individual tag.
  • Shipping services (modified): Prior to request version 665, services are not filtered out. With a request version of 665 or greater, the buyer is presented with services only if they are valid for the buyer's country.
  • ShippingServiceAdditionalCost (both Summary and non-Summary uses, domestic and international) (modified): The cost of shipping each additional item beyond the first item (flat shipping). For single-item listings, if this is not provided, it is defaulted to zero. For multi-quantity listings, if this is not provided, it is set to the value of (in)ShippingServiceCost (unless the request version is lower than 665, in which case ShippingServiceAdditionalCost is required and is not defaulted).
  • ShippingServiceCost (both Summary and non-Summary uses, domestic and international) (modified): If flat shipping: if only one item is being shipped, this matches (in)ShippingServiceCost; if more than one item is being shipped, this is the total of (in)ShippingServiceCost plus ((in)ShippingServiceAdditionalCost times the number of items beyond the first item). (Flat shipping behavior prior to version 665: (out)ShippingServiceCost matches (in)ShippingServiceCost even for multi-quantity listings for which multiple items are shipped.)
0637
2009-09-30
  • ShippingCostSummaryType.ListedShippingServiceCost (added): The listed shipping cost for an item.
0555
2008-03-05
  • ShippingDetails.CODCost (added): Italy site (site ID 101) only. Contains the cost of cash-on-delivery shipping.
0517
2007-06-13
  • InternationalShippingServiceOption.ShipsTo, ShippingCostSummaryType.InsuranceOption, ShippingDetailsType.InternationalInsuranceCost, and ShippingDetailsType.InternationalInsuranceOption (added): Fixed a bug so that now these elements are returned.
0515
2007-06-10
  • (added) New call.