GetShippingCosts

Note: All calls in the Shopping API have been deprecated and will be decommissioned on February 5, 2025. An alternative to this API is the Browse API, which also has advanced search capabilities.

Note: Developers using Shopping API calls must authenticate with an OAuth application access token in the HTTP header X-EBAY-API-IAF-TOKEN and use OAuth application access tokens with a scope that includes https://api.ebay.com/oauth/api_scope. See the client credentials grant flow topic for more information on generating and managing OAuth application access tokens. See the Specifying OAuth scopes topic for more information on OAuth scopes.

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:

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

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

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">
  <!-- 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>

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

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">
  <!-- 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>

Detail Controls

DetailLevel

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

Samples

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 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&
   siteid=0&
   version=517&
   ItemID=1**********1&
   DestinationCountryCode=US&
   DestinationPostalCode=9***8&
   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>1**********1</ItemID>
  <DestinationCountryCode>US</DestinationCountryCode>
  <DestinationPostalCode>9***8</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