GetItemShipping - Call Reference - eBay Trading Web Services

GetItemShipping

Returns shipping cost estimates for an item for every calculated shipping service that the seller has offered with the listing. This is analogous to the Shipping Calculator seen in both the buyer and seller web pages. It is another way for a buyer or seller to 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).

Note:

Shipping insurance cost can only be determined once the final item price is known.
It is possible for a seller to offer a shipping service which turns out to be a mismatch in some way with the item(s) being shipped. For example, if a buyer purchases more than one of an item, the weight might be too great for First Class mail. In such a case, GetItemShipping will omit that shipping service from the response.

See Determining Shipping Costs for a Listing.

GetItemShipping Input

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

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID 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. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector	string (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input 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 zipcode, for US). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries.
ItemID	ItemIDType (string)	Required	The item ID that uniquely identifies the item listing for which to retrieve the data. Required input. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
QuantitySold	int	Optional	Number of items sold to a single buyer and to be shipped together.

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

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetItemShippingResponse 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 ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <ShippingDetails> ShippingDetailsType 
    <CalculatedShippingRate> CalculatedShippingRateType 
      <InternationalPackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </InternationalPackagingHandlingCosts>
      <OriginatingPostalCode> string </OriginatingPostalCode>
      <PackageDepth unit="token"> MeasureType (decimal) </PackageDepth>
      <PackageLength unit="token"> MeasureType (decimal) </PackageLength>
      <PackageWidth unit="token"> MeasureType (decimal) </PackageWidth>
      <PackagingHandlingCosts currencyID="CurrencyCodeType"> AmountType (double) </PackagingHandlingCosts>
      <ShippingIrregular> boolean </ShippingIrregular>
      <ShippingPackage> ShippingPackageCodeType </ShippingPackage>
      <WeightMajor unit="token"> MeasureType (decimal) </WeightMajor>
      <WeightMinor unit="token"> MeasureType (decimal) </WeightMinor>
    </CalculatedShippingRate>
    <ChangePaymentInstructions> boolean </ChangePaymentInstructions>
    <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
    <GetItFast> boolean </GetItFast>
    <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
    <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
    <InsuranceWanted> boolean </InsuranceWanted>
    <InternationalShippingServiceOption> InternationalShippingServiceOptionsType 
      <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
      <ShippingService> token </ShippingService>
      <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
      <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      <ShippingServicePriority> int </ShippingServicePriority>
      <ShipToLocation> string </ShipToLocation>
      <!-- ... more ShipToLocation nodes here ... -->
    </InternationalShippingServiceOption>
    <!-- ... more InternationalShippingServiceOption nodes here ... -->
    <PaymentEdited> boolean </PaymentEdited>
    <PaymentInstructions> string </PaymentInstructions>
    <SalesTax> SalesTaxType 
      <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
      <SalesTaxPercent> float </SalesTaxPercent>
      <SalesTaxState> string </SalesTaxState>
      <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
    </SalesTax>
    <ShippingRateErrorMessage> string </ShippingRateErrorMessage>
    <ShippingRateType> ShippingRateTypeCodeType </ShippingRateType>
    <ShippingServiceOptions> ShippingServiceOptionsType 
      <ExpeditedService> boolean </ExpeditedService>
      <FreeShipping> boolean </FreeShipping>
      <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
      <ShippingService> token </ShippingService>
      <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
      <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      <ShippingServicePriority> int </ShippingServicePriority>
      <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
      <ShippingTimeMax> int </ShippingTimeMax>
      <ShippingTimeMin> int </ShippingTimeMin>
    </ShippingServiceOptions>
    <!-- ... more ShippingServiceOptions nodes here ... -->
    <TaxTable> TaxTableType 
      <TaxJurisdiction> TaxJurisdictionType 
        <JurisdictionID> string </JurisdictionID>
        <SalesTaxPercent> float </SalesTaxPercent>
        <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
      </TaxJurisdiction>
      <!-- ... more TaxJurisdiction nodes here ... -->
    </TaxTable>
    <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
  </ShippingDetails>
</GetItemShippingResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific 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 Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific 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	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID 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. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
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.
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.
Errors.ErrorParameters	ErrorParameterType (repeatable)	Conditionally	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
ShippingDetails	ShippingDetailsType	Always	Shipping-related details for the specified item. Any error about shipping services (returned by a vendor of eBay's who calculates shipping costs) is returned in ShippingRateErrorMessage. Errors from a shipping service are likely to be related to issues with shipping specifications, such as package size and the selected shipping method not supported by a particular shipping service. It is possible for a seller to offer a shipping service which turns out to be a mismatch in some way with the item(s) being shipped. For example, if a buyer purchases more than one of an item, the weight might be too great for First Class mail. In such a case, GetItemShipping will omit that shipping service from the response.
ShippingDetails .CalculatedShippingRate	CalculatedShippingRateType	Conditionally	Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. Not applicable to Half.com or eBay Motors vehicle listings. If your call may specify a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. For Germany and the UK, this field is ignored when Item.ListingType=Express. Note: At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information.
ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts	AmountType (double)	Conditionally	Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only.
ShippingDetails .CalculatedShippingRate .InternationalPackagingHandlingCosts [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .CalculatedShippingRate .OriginatingPostalCode	string	Conditionally	Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location.
ShippingDetails .CalculatedShippingRate .PackageDepth	MeasureType (decimal)	Conditionally	Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. See Package Dimensions and Weight.
ShippingDetails .CalculatedShippingRate .PackageDepth [ attribute unit ]	token	Conditionally	The unit of measure (e.g., lbs, oz, in). Currently ignored and assumed to be "inches" when used as input for PackageDepth, PackageWidth, PackageLength, WeightMajor, WeightMinor.
ShippingDetails .CalculatedShippingRate .PackageLength	MeasureType (decimal)	Conditionally	Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) See Package Dimensions and Weight.
ShippingDetails .CalculatedShippingRate .PackageLength [ attribute unit ]	token	Conditionally	The unit of measure (e.g., lbs, oz, in). Currently ignored and assumed to be "inches" when used as input for PackageDepth, PackageWidth, PackageLength, WeightMajor, WeightMinor.
ShippingDetails .CalculatedShippingRate .PackageWidth	MeasureType (decimal)	Conditionally	Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) See Package Dimensions and Weight.
ShippingDetails .CalculatedShippingRate .PackageWidth [ attribute unit ]	token	Conditionally	The unit of measure (e.g., lbs, oz, in). Currently ignored and assumed to be "inches" when used as input for PackageDepth, PackageWidth, PackageLength, WeightMajor, WeightMinor.
ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts	AmountType (double)	Conditionally	Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only.
ShippingDetails .CalculatedShippingRate .PackagingHandlingCosts [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .CalculatedShippingRate .ShippingIrregular	boolean	Conditionally	Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.
ShippingDetails .CalculatedShippingRate .ShippingPackage	ShippingPackageCodeType	Conditionally	The nature of the package used to ship the item(s). Required for calculated shipping only. Applicable values: See ShippingPackage.
ShippingDetails .CalculatedShippingRate .WeightMajor	MeasureType (decimal)	Conditionally	WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: <WeightMajor unit="lbs">5</WeightMajor> <WeightMinor unit="oz">2</WeightMinor> See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. For calculated shipping only. Required on input when calculated shipping is used.
ShippingDetails .CalculatedShippingRate .WeightMajor [ attribute unit ]	token	Conditionally	The unit of measure (e.g., lbs, oz, in). Currently ignored and assumed to be "inches" when used as input for PackageDepth, PackageWidth, PackageLength, WeightMajor, WeightMinor.
ShippingDetails .CalculatedShippingRate .WeightMinor	MeasureType (decimal)	Conditionally	See the definition of WeightMajor. For calculated shipping only. Required on input when calculated shipping is used.
ShippingDetails .CalculatedShippingRate .WeightMinor [ attribute unit ]	token	Conditionally	The unit of measure (e.g., lbs, oz, in). Currently ignored and assumed to be "inches" when used as input for PackageDepth, PackageWidth, PackageLength, WeightMajor, WeightMinor.
ShippingDetails .ChangePaymentInstructions	boolean	Conditionally	Whether the seller specified payment and shipping instructions during checkout (for example, to update the details of a transaction). Flat and calculated shipping. Not applicable to Half.com.
ShippingDetails.CODCost	AmountType (double)	Conditionally	Italy site (site ID 101) only. Contains the cash-on-delivery (COD) cost, for COD shipping. See Specifying the Cash on Delivery Option in Shipping Details.
ShippingDetails.CODCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails.GetItFast	boolean	Conditionally	Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. Also applicable to Half.com (for GetOrders).
ShippingDetails.InsuranceFee	AmountType (double)	Conditionally	Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. This field is ignored when InsuranceOption is not specified in the request. This field is ignored when Item.ListingType=Express. Applicable to Half.com for GetOrders. Not applicable to eBay Motors vehicle listings. Default: 0.00.
ShippingDetails.InsuranceFee [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .InsuranceOption	InsuranceOptionCodeType	Conditionally	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Also applicable to Half.com (for GetOrders). This field is ignored when Item.ListingType=Express. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
ShippingDetails .InsuranceWanted	boolean	Conditionally	Whether the buyer selected to pay for insurance offered by the seller as an option. This only has a value after the buyer has gone through checkout and selected the insurance preference. Also applicable to Half.com (for GetOrders).
ShippingDetails .InternationalShippingServiceOption	InternationalShippingServiceOptionsType (repeatable)	Conditionally	Shipping costs and options related to an international shipping service. If used, at least one domestic shipping service must also be provided in ShippingServiceOptions. If you specify multiple InternationalShippingServiceOption nodes, the repeating nodes must be contiguous. That is, you cannot insert other nodes between InternationalShippingServiceOption nodes. If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. Not applicable to Half.com or eBay Motors vehicle listings. This field is ignored when Item.ListingType=Express. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost	AmountType (double)	Conditionally	The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders). See Shipping.
ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .InternationalShippingServiceOption .ShippingService	token	Conditionally	An international shipping service offered for shipping the item. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. See GeteBayDetails.
ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost	AmountType (double)	Conditionally	Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only.
ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost	AmountType (double)	Conditionally	The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. See Shipping.
ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority	int	Conditionally	Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping.
ShippingDetails .InternationalShippingServiceOption .ShipToLocation	string (repeatable)	Conditionally	An international location or region to which the item may be shipped via this particular shipping service. Associated with the shipping service by the seller. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service has been specified. See ShipToLocation.
ShippingDetails.PaymentEdited	boolean	Conditionally	Whether the seller allows the buyer to edit the payment amount for the transaction. (Sellers enable this property in their My eBay user preferences on the eBay site.) Not applicable to Half.com.
ShippingDetails .PaymentInstructions	string	Conditionally	Payment instructions/message from the seller to the buyer. These instructions appear on eBay's View Item page and on eBay's checkout page when the buyer pays for the item. Sellers usually use this field to specify payment instructions, how soon the item will shipped, feedback instructions, and other reminders that the buyer should be aware of when they bid on or buy an item. This field can be specified regardless of the shipping typ eBay only allows 500 characters as input, but due to the way the eBay Web site UI treats characters, this field can return more than 500 characters in the response. Characters like & and ' (apostrophe/single quote) count as 5 characters each. To remove this value when revising or relisting an item, use DeletedField. Applicable to eBay Motors (usually used to elaborate on the return policy). Not applicable to Half.com. Max length: 1000. See: Offering a Clear Return Policy (AddItem) Item.AttributeSetArray (GetItem) Item.AttributeSetArray
ShippingDetails.SalesTax	SalesTaxType	Conditionally	Sales tax details. US site only. Flat and calculated shipping. Also applicable to Half.com (for GetOrders). If your application normally calculates sales tax without using eBay's tax tables, you should understand how purchases via eBay Express will affect the way you process payments. For general information about listings on eBay Express, see the eBay Web Services Guide links below. Not applicable to eBay Motors vehicle listings. See: Enabling Multi-jurisdiction Sales Tax Specify Sales Tax for Express and eBay
ShippingDetails.SalesTax .SalesTaxAmount	AmountType (double)	Conditionally	(US only) The amount of sales tax, calculated for a transaction based on the SalesTaxPercent and pricing information. Also returned for Half.com (for GetOrders). GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the ItemID and TransactionID to call GetOrderTransactions.
ShippingDetails.SalesTax .SalesTaxAmount [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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 value passed in is stored with a precision of 3 digits after the decimal point (##.###). Also applicable to Half.com (for GetOrders).
ShippingDetails.SalesTax .SalesTaxState	string	Conditionally	State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. Also returned for Half.com (for GetOrders).
ShippingDetails.SalesTax .ShippingIncludedInTax	boolean	Conditionally	(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Also returned for Half.com (for GetOrders).
ShippingDetails .ShippingRateErrorMessage	string	Conditionally	For most applicable calls, returns the words No Error or returns an error message related to an attempt to calculate shipping rates. For calculated shipping only. Not applicable to Half.com or eBay Motors vehicle listings. GetSearchResultsExpress returns this when no PostalCode was specified in the request and the item was listed with calculated shipping rates. The message text explains that a postal code is needed to calculate shipping. Only returned when ItemDetails is set to Fine.
ShippingDetails .ShippingRateType	ShippingRateTypeCodeType	Conditionally	A shipping rate scale for shipping through UPS that affects the shipping cost calculated for UPS (lower if ShippingRateType is DailyPickup). ShippingRateType is only returned if ShippingService is one of the UPS shipping services. For calculated shipping only. Not applicable to Half.com or eBay Motors vehicle listings. Applicable values: • CustomCode (out) Reserved for internal or future use. • DailyPickup (out) "Daily pickup" shipping rate scale. • OnDemand (out) "On-demand" shipping rate scale. See Shipping.
ShippingDetails .ShippingServiceOptions	ShippingServiceOptionsType (repeatable)	Conditionally	Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. Not applicable to Half.com or eBay Motors vehicle listings. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
ShippingDetails .ShippingServiceOptions .ExpeditedService	boolean	Conditionally	Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com.
ShippingDetails .ShippingServiceOptions .FreeShipping	boolean	Conditionally	A seller offers free shipping by setting FreeShipping to true. This free shipping applies only to the first domestic shipping service. (It is ignored if set for any other shipping service.) If the seller has required shipping insurance as part of shipping (the seller set InsuranceOption to Required) and then the seller specified FreeShipping, eBay sets the insurance cost to 0. However, if the seller made shipping insurance optional, eBay preserves the cost of shipping insurance; it is up to the buyer whether to buy shipping insurance, regardless of whether the seller specified FreeShipping. See Specifying Free Shipping.
ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost	AmountType (double)	Conditionally	The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders). See Determining Shipping Costs for a Listing.
ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .ShippingServiceOptions .ShippingService	token	Conditionally	A domestic shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). See GeteBayDetails.
ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost	AmountType (double)	Conditionally	The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com. See Determining Shipping Costs for a Listing.
ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .ShippingServiceOptions .ShippingServiceCost	AmountType (double)	Conditionally	The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). For applications processing an Express transaction when the transaction is part of an Express Order, ShippingServiceCost will have a value of 0. This is generally because the ShippingServiceCost of an Order is not returned by each transaction included in that Order when making the GetItemTransactions or GetSellerTransactions call. This is regardless of whether the Order is an Express Order or a regular eBay site Order. This is a known issue and a current product limitation for Orders and Transactions in general. See Determining Shipping Costs for a Listing.
ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .ShippingServiceOptions .ShippingServicePriority	int	Conditionally	Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com.
ShippingDetails .ShippingServiceOptions .ShippingSurcharge	AmountType (double)	Conditionally	An additional fee to charge US buyers who ship via UPS to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only.
ShippingDetails .ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ]	CurrencyCodeType	Conditionally	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingDetails .ShippingServiceOptions .ShippingTimeMax	int	Conditionally	The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.
ShippingDetails .ShippingServiceOptions .ShippingTimeMin	int	Conditionally	The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com.
ShippingDetails.TaxTable	TaxTableType	Conditionally	Tax details for a jurisdiction such as a state or province. If no tax table is associated with the item, no tax table is returned, even if IncludeTaxTable is set to true. If a tax table is associated with the item: - the tax table is returned if DetailLevel is ReturnAll or ItemReturnDescription (and the value of IncludeTaxTable does not matter) - if no DetailLevel is specified or if DetailLevel is ItemReturnAttributes, the tax table is returned only if IncludeTaxTable is true Not applicable to Half.com.
ShippingDetails.TaxTable .TaxJurisdiction	TaxJurisdictionType (repeatable)	Conditionally	Sales tax details for zero or more jurisdictions (states, provinces, etc). For GetTaxTable, if DetailLevel is not specified, information is only returned for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned but are empty.
ShippingDetails.TaxTable .TaxJurisdiction .JurisdictionID	string	Conditionally	Representative identifier for the jurisdiction. Typically an abbreviation (e.g. CA for California).
ShippingDetails.TaxTable .TaxJurisdiction .SalesTaxPercent	float	Conditionally	The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). GetTaxTable: this tag has no value if the user's tax table has not been set.
ShippingDetails.TaxTable .TaxJurisdiction .ShippingIncludedInTax	boolean	Conditionally	Whether shipping costs are to be part of the base amount that is taxed. GetTaxTable: This tag is empty if the user did not previously provide information.
ShippingDetails .ThirdPartyCheckout	boolean	Conditionally	Whether checkout for this is to be handled by a Third-Party Checkout application. The counterpart in the AddItem family of calls is Item.ThirdPartyCheckout. Not applicable to Half.com. See: Third Party Checkout (AddItem) Item.ThirdPartyCheckout

GetItemShipping Detail Controls

Detail Control: DetailLevel

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

GetItemShipping Samples

New to making API calls? Please see Routing the Request.

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

Calculates the shipping cost for an active listing.

Description

User braggybuyer found an item on eBay and, before he bids on the item, he wants to know how much it would cost to ship it to his home in Berea, Kentucky. User magicalbookseller has assigned calculated shippping rates to this listing.

Before making this call, the listing must have been created (e.g. with AddItem) with a listing with at least one domestic calculated shipping service.

Input

The key inputs for this scenario are:

ItemID
QuantitySold
DestinationPostalCode
DestinationCountryCode

Item 110030335741 is a listing with at least one domestic calculated shipping service. Since he is bidding on only 1 item, we will set QuantitySold to 1. The postal code for Berea, Kentucky's is 40404. The country code for the United States is US.

For calculated shipping, the core cost of shipping depends on the distance between the seller's location and the buyer's shipping address and on the number of items purchased.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetItemShippingRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>505</Version>
  <ItemID>110030372638</ItemID>
  <QuantitySold>1</QuantitySold>
  <DestinationPostalCode>40404</DestinationPostalCode>
  <DestinationCountryCode>US</DestinationCountryCode>
</GetItemShippingRequest>

Output

A successful response returns along with the ShippingDetails. The ShippingDetails will display the ShippingServiceCost with respect to the ShippingServiceOptions. Note that the ShippingInsuranceCost can only be determined once the final item price is known.

XML format. Also available is the .txt version of this XML.

<ShippingDetails>
  <CalculatedShippingRate>
    <OriginatingPostalCode>95125</OriginatingPostalCode>
    <PackagingHandlingCosts currencyID="USD">3.0</PackagingHandlingCosts>
    <ShippingIrregular>true</ShippingIrregular>
    <ShippingPackage>LargeEnvelope</ShippingPackage>
    <WeightMajor unit="lbs" measurementSystem="English">0</WeightMajor>
    <WeightMinor unit="oz" measurementSystem="English">2</WeightMinor>
  </CalculatedShippingRate>
  <ShippingRateErrorMessage>No Error</ShippingRateErrorMessage>
  <ShippingRateType>OnDemand</ShippingRateType>
  <ShippingServiceOptions>
    <ShippingInsuranceCost currencyID="USD">0.0</ShippingInsuranceCost>
    <ShippingService>UPS2ndDay</ShippingService>
    <ShippingServiceCost currencyID="USD">26.52</ShippingServiceCost>
    <ShippingServicePriority>1</ShippingServicePriority>
    <ExpeditedService>false</ExpeditedService>
    <ShippingTimeMin>1</ShippingTimeMin>
    <ShippingTimeMax>2</ShippingTimeMax>
  </ShippingServiceOptions>
  <ShippingType>Calculated</ShippingType>
</ShippingDetails>

eBay Trading API Call Reference Version 585

eBay Trading API
Call Reference Version 585