eBay Shopping API Call Reference Version 595 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Shopping API Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History User Notes

Gets shipping costs for an item. This is one of the ways a buyer or seller can obtain shipping cost information for an existing item (for which the caller is either the buyer or seller) at any point in the life of of the listing, before or after a buyer has committed to purchasing the item(s). This call works for both flat rate shipping and calculated shipping. Flat rate shipping costs are established by the seller before bidding occurs. Calculated shipping costs are calculated by eBay with its shipping partners based on postal code, but note that insurance cost can only be determined once the final item price is known when the listing ends. To determine whether a listing has ended, use GetSingleItem.

It is best to call GetShippingCosts only after determining via GetSingleItem or FindItems that the item actually has shipping cost information.

Related calls:

• GetSingleItem - Gets publicly visible details about one listing. This gives you most of the data that eBay shows on the View Item page (title, description, price, and other details).

Back to top

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).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

<?xml version="1.0" encoding="utf-8"?>
<GetShippingCostsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <MessageID> string </MessageID>
  <!-- Call-specific Input Fields -->
  <DestinationCountryCode> CountryCodeType </DestinationCountryCode>
  <DestinationPostalCode> string </DestinationPostalCode>
  <IncludeDetails> boolean </IncludeDetails>
  <ItemID> string </ItemID>
  <QuantitySold> int </QuantitySold>
</GetShippingCostsRequest>

Back to top

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).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetShippingCostsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <ShippingCostSummary> ShippingCostSummaryType 
    <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
    <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
    <ShippingServiceName> string </ShippingServiceName>
    <ShippingType> ShippingTypeCodeType </ShippingType>
  </ShippingCostSummary>
  <ShippingDetails> ShippingDetailsType 
    <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
    <GetItFast> boolean </GetItFast>
    <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
    <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
    <InternationalInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InternationalInsuranceCost>
    <InternationalInsuranceOption> InsuranceOptionCodeType </InternationalInsuranceOption>
    <InternationalShippingServiceOption> InternationalShippingServiceOptionType 
      <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
      <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
      <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      <ShippingServiceName> token </ShippingServiceName>
      <ShippingServicePriority> int </ShippingServicePriority>
      <ShipsTo> string </ShipsTo>
      <!-- ... more ShipsTo nodes here ... -->
    </InternationalShippingServiceOption>
    <!-- ... more InternationalShippingServiceOption nodes here ... -->
    <SalesTax> SalesTaxType 
      <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
      <SalesTaxPercent> float </SalesTaxPercent>
      <SalesTaxState> string </SalesTaxState>
      <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
    </SalesTax>
    <ShippingRateErrorMessage> string </ShippingRateErrorMessage>
    <ShippingServiceOption> ShippingServiceOptionType 
      <ExpeditedService> boolean </ExpeditedService>
      <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
      <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
      <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      <ShippingServiceName> token </ShippingServiceName>
      <ShippingServicePriority> int </ShippingServicePriority>
      <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
      <ShippingTimeMax> int </ShippingTimeMax>
      <ShippingTimeMin> int </ShippingTimeMin>
      <ShipsTo> string </ShipsTo>
      <!-- ... more ShipsTo nodes here ... -->
    </ShippingServiceOption>
    <!-- ... more ShippingServiceOption nodes here ... -->
    <TaxTable> TaxTableType 
      <TaxJurisdiction> TaxJurisdictionType 
        <JurisdictionID> string </JurisdictionID>
        <SalesTaxPercent> float </SalesTaxPercent>
        <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
      </TaxJurisdiction>
      <!-- ... more TaxJurisdiction nodes here ... -->
    </TaxTable>
  </ShippingDetails>
</GetShippingCostsResponse>

Back to top

This call does not use a detail control mechanism.

Back to top

New to making API calls? Please see Making an API 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.

Retrieves summary and detail information about shipping costs for an item ID.

Input

We wish to see details in addition to summary of shipping costs. Therefore, we set IncludeDetails to true and the ShippingDetails container is returned (in addition to the default ShippingSummary container). Note: if QuantitySold were omitted, it would default to 1.

URL format (HTTP GET). See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.

http://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 (HTTP POST). Note that this does not include standard values.

XML format (HTTP POST). Also available are the .txt version of this XML and 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

This particular item was listed with the flat rate shipping cost model, as seen in ShippingCostSummary.ShippingType.

   If you chose XML as the response encoding type, you would get something like this.

XML format. Also available are the .txt version of this XML and the JSON and SOAP equivalents.

<?xml version="1.0" encoding="utf-8"?>
<GetShippingCostsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-06-11T01:29:36.765Z</Timestamp>
  <Ack>Success</Ack>
  <Build>e517_core_APILW_4693054_R1</Build>
  <Version>517/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>

Back to top

Back to top

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

© 2005–2008 eBay, Inc. All rights reserved.