eBay Trading API
|
Use this call to return the shipping cost estimates for every calculated shipping service that the seller has offered with an item listing. This is analogous to the Shipping Calculator seen in both the buyer and seller web pages.
GetItemShipping is another way for a buyer or seller to obtain shipping cost information for an existing item. The caller can be either the buyer or seller and the call can be made at any point in the life of the listing, either before or after a buyer has committed to purchasing the item(s).
This call enables the user to determine the costs associated with a particular shipping service for an item shipped to a specific postal code.
Be aware that it's 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.
With the Global Shipping Program, a seller can easily ship items to buyers in other countries with minimal concern for the complexities of international shipping such as customs duty and taxes, shipping regulations and restrictions. It's currently available only to sellers listing items on the eBay US site.
Sellers are presented with the option to join the Global Shipping Program on various pages of the eBay US site. Sellers will see this offer in promotional emails, at sign-in, on their My eBay page, and in other locations. Opting in to the program is done only from the web UI; there's no way to opt in using an API. Once opted in, sellers need not opt out again. They can simply choose not to offer the Global Shipping Program in their listings.
The features of the Global Shipping Program are implemented using the GlobalShipping field and some existing fields in GetItemShipping and other Trading API calls. For more information, see the Shipping chapter in the Trading API User's Guide.
GetItemShipping retrieves shipping costs for an item based on the postal code to which the seller is shipping (or may ship) the item. Specify the destination postal code in the DestinationPostalCode property. Identify the item for which to retrieve shipping costs in the ItemID property. (The seller's postal code is automatically extracted from the data associated with this item to provide the from and to locations in calculating the shipping costs.)
If the item has already sold, specify the number of items the buyer purchased from the listing in the QuantitySold property. The quantity sold is used with the final item price the buyer paid to calculate insurance fees. The final price is retrieved automatically from the data associated with the item specified in the ItemID property.
You can test GetItemShipping in the Sandbox. GetItemShipping may be called at any time during the life span of an auction; either before or after a buyer has committed to purchasing the item(s). With this, you must have an item listed in the Sandbox environment before you can test GetItemShipping.
For a complete test suite, consider creating several items that represent combinations of details. For example, create:
See Determining Shipping Costs for a Listing.
| Output Detail Controls Samples Change History Top Errors for GetItemShipping User Notes |
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.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?>
<GetItemShippingRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Input Fields -->
<DestinationCountryCode> CountryCodeType </DestinationCountryCode>
<DestinationPostalCode> string </DestinationPostalCode>
<ItemID> ItemIDType (string) </ItemID>
<QuantitySold> int </QuantitySold>
<!-- Standard Input Fields -->
<ErrorLanguage> string </ErrorLanguage>
<MessageID> string </MessageID>
<OutputSelector> string </OutputSelector>
<!-- ... more OutputSelector values allowed here ... -->
<Version> string </Version>
<WarningLevel> WarningLevelCodeType </WarningLevel>
</GetItemShippingRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| DestinationCountryCode | CountryCodeType | Conditional |
Destination country code. If DestinationCountryCode is US, a postal code is required and it represents the 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. |
| Standard Input 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 |
| MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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 | Optional,
repeatable: [0..*] |
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. |
| 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:
|
| 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. |
| Input Detail Controls Samples Change History Top Errors for GetItemShipping User Notes |
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"?>
<GetItemShippingResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- 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>
<ExcludeShipToLocation> string </ExcludeShipToLocation>
<!-- ... more ExcludeShipToLocation values allowed here ... -->
<GetItFast> boolean </GetItFast>
<InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
<InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
<InsuranceWanted> boolean </InsuranceWanted>
<InternationalShippingServiceOption> InternationalShippingServiceOptionsType
<ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
<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 values allowed here ... -->
</InternationalShippingServiceOption>
<!-- ... more InternationalShippingServiceOption nodes allowed 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>
<ImportCharge currencyID="CurrencyCodeType"> AmountType (double) </ImportCharge>
<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 allowed here ... -->
<ShippingType> ShippingTypeCodeType </ShippingType>
<ThirdPartyCheckout> boolean </ThirdPartyCheckout>
</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 ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
</GetItemShippingResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard 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. If a buyer buys multiple quantities of an item and the resultant total weight exceeds the weight limit of the shipping service, GetItemShipping returns the shipping cost and shipping service and internally groups the items in separate packages. A shipping service is removed from ShippingDetails only if the weight of a single item exceeds the weight limit of the shipping service. |
|
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. If your call specifies a large-dimension item listed with UPS, see Dimensional Weight limit on UPS shipping services results in failure of shipping calculator. Not applicable to Half.com. |
|
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 |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. |
| ShippingDetails .CalculatedShippingRate .PackageDepth [ attribute unit ] |
token | Conditionally |
Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. To get the full list of package dimension and weight measurement units (and all alternative spellings and abbreviations) supported by your site, call GeteBayDetails. |
|
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.) |
| ShippingDetails .CalculatedShippingRate .PackageLength [ attribute unit ] |
token | Conditionally |
Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. To get the full list of package dimension and weight measurement units (and all alternative spellings and abbreviations) supported by your site, call GeteBayDetails. |
|
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.) |
| ShippingDetails .CalculatedShippingRate .PackageWidth [ attribute unit ] |
token | Conditionally |
Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. To get the full list of package dimension and weight measurement units (and all alternative spellings and abbreviations) supported by your site, call GeteBayDetails. |
|
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 |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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). This is required for calculated shipping only. To get the applicable ShippingPackage values for your site, call GeteBayDetails with DetailName set to ShippingPackageDetails, and then look for the ShippingPackageDetails.ShippingPackage fields in the response.
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 or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. Required on input when calculated shipping is used. |
| ShippingDetails .CalculatedShippingRate .WeightMajor [ attribute unit ] |
token | Conditionally |
Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. To get the full list of package dimension and weight measurement units (and all alternative spellings and abbreviations) supported by your site, call GeteBayDetails. |
|
ShippingDetails .CalculatedShippingRate .WeightMinor |
MeasureType (decimal) | Conditionally |
See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.) Required on input when calculated shipping is used. |
| ShippingDetails .CalculatedShippingRate .WeightMinor [ attribute unit ] |
token | Conditionally |
Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. To get the full list of package dimension and weight measurement units (and all alternative spellings and abbreviations) supported by your site, call GeteBayDetails. |
|
ShippingDetails .ChangePaymentInstructions |
boolean | Conditionally |
Whether the seller specified payment and shipping instructions during checkout (for example, to update the details of an order). Valid for flat and calculated shipping. Not applicable to Half.com. |
| ShippingDetails.CODCost | AmountType (double) | Conditionally |
This dollar value indicates the money due from the buyer upon delivery of the item. This field should only be specified in the request if 'COD' (cash-on-delivery) is a valid payment method for the site and it is included as a PaymentMethods value in the same request. This field is only returned if set for the listing. To see if 'COD' is a supported payment method for a site, call GeteBayDetails with the DetailName field set to 'PaymentOptionDetails'. Look for a value of 'COD' in one of the PaymentOptionDetails.PaymentOption fields in the response. |
| ShippingDetails.CODCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ShippingDetails .ExcludeShipToLocation |
string | Conditionally,
repeatable: [0..*] |
Use this field to specify an international country or region, or a special domestic location, such as 'PO Box' (in US) or 'Packstation' (in DE), to where you will not ship the associated item. Repeat this element in the call request for each location that you want to exclude as a shipping destination for your item. Set ShipToRegistrationCountry to true to have your ExcludeShipToLocation settings applied to your listing. The locations you have excluded display in the Shipping and Handling section of your item listing. If a buyer's primary ship-to location is a location that you have listed as an excluded ship-to location (or if the buyer does not have a primary ship-to location), they will receive an error message if they attempt to buy or place a bid on your item. The exclude ship-to location values are eBay regions and countries. To see the valid exclude ship-to locations for a specified site, call GeteBayDetails with DetailName set to ExcludeShippingLocationDetails, and then look for the ExcludeShippingLocationDetails.Location fields in the response. Repeat GeteBayDetails for each site on which you list. This field works in conjunction with Item.ShipToLocations to create a set of international countries and regions to where you will, and will not, ship. You can list a region in the ShipToLocations field, then exclude specific countries within that region with this field (for example, you can specify Africa in ShipToLocations, yet exclude Chad with a ExcludeShipToLocation setting). In addition, if your ShipToLocations is Worldwide, you can use this field to specify both regions and countries that you want to exclude from your shipping destinations. You can specify a default set of locations to where you will not ship in My eBay. If you create an Exclude Ship-To List, it is, by default, in effect when you list items. However, if you specify any value in this field on input, it nullifies the default settings in your Exclude Ship-To List. (If you use ExcludeShipToLocation when you list an item, you will need to list all the locations to where you will not ship the associated item, regardless of the default settings in your Exclude Ship-To List.) Specify NONE in this field to override the default Exclude Ship-To List you might have set up in My eBay and indicate that you do not want to exclude any shipping locations from the respective item listing. Note: To enable your default Exclude Ship-To List, you must enable Exclude Shipping Locations and Buyer Requirements in your My eBay Site Preferences. For details, see the KnowledgeBase Article HowTo: ExcludeShipToLocation. Applicable values: See CountryCodeType, ShippingRegionCodeType |
| 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. 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. Valid only on the following sites: FR and IT Applicable to Half.com for GetOrders. Default: 0.00. |
| ShippingDetails.InsuranceFee [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. Optional as input and only allowed if ChangePaymentInstructions is true. If this field is not included in the request, values specified in the InsuranceFee field will be ignored. Note: Note that sellers are responsible for the items they sell until they safely arrive in their customers' hands, and that offering buyer-paid insurance (either as an optional or required service) infers that the buyer is somehow responsible for the safe delivery of the items they purchase. This notion can reduce buyer confidence in the marketplace and the practice of including buyer- paid shipping insurance in your item listings is discouraged. This field is only returned if the value is other than NotOffered. Valid only on the following sites: FR and IT If you include buyer-paid shipping insurance for an item listed on one of the sites that supports this option, a buyer on a site that does not support buyer-paid shipping insurance can still purchase the item. In these cases, the buyer is responsible for all the shipping insurance terms that have been outlined in the item listing. Applicable to Half.com 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 or not the buyer selected to pay for insurance as an option offered by the seller. This only has a value after the buyer has gone through checkout and selected the insurance preference. Valid only on the following sites: FR and IT Applicable to Half.com for GetOrders. |
|
ShippingDetails .InternationalShippingServiceOption |
InternationalShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
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. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). If you specify ShippingDetails when you revise or relist an item but you omit InternationalShippingServiceOption, eBay will drop the international shipping services (except the Global Shipping Program) 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. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. 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 .InternationalShippingServiceOption .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. Min: 0. |
| ShippingDetails .InternationalShippingServiceOption .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
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. Valid only on the following sites: AU, FR, and IT Also applicable to Half.com (for GetOrders). See Shipping. |
| ShippingDetails .InternationalShippingServiceOption .ShippingInsuranceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ShippingDetails .InternationalShippingServiceOption .ShippingService |
token | Conditionally |
An international shipping service being offered by the seller to ship an item to a buyer. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. To view the full list of International shipping service options in the response, look for the ShippingService fields in the ShippingServiceDetails containers that contain a InternationalService=true field, as this indicates that the ShippingService value is an International shipping service option. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. For flat and calculated shipping. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
ShippingDetails .InternationalShippingServiceOption .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. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. |
| ShippingDetails .InternationalShippingServiceOption .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. If a shipping service has been specified, GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. See Shipping. |
| ShippingDetails .InternationalShippingServiceOption .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ShippingDetails .InternationalShippingServiceOption .ShippingServicePriority |
int | Conditionally |
This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to five international shipping services (with five InternationalShippingServiceOption containers), so valid values are 1, 2, 3, 4, and 5. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 5 appears at the bottom of a list of five shipping service options. This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. |
|
ShippingDetails .InternationalShippingServiceOption .ShipToLocation |
string | Conditionally,
repeatable: [0..*] |
An international location or region to where the item seller will ship the item. Use GeteBayDetails with DetailName set to ShippingLocationDetails to determine which locations are valid per site. In the GeteBayDetails response, look for the ShippingLocationDetails.ShippingLocation fields. For the AddItem family of calls, this field is required if any international shipping service is specified.
See Specifying Locations to Where You Ship. Applicable values: See CountryCodeType, ShippingRegionCodeType |
| ShippingDetails.PaymentEdited | boolean | Conditionally |
Whether the seller allows the buyer to edit the payment amount for the order. (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 (or 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 type 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. Use DeletedField to remove this value when revising or relisting an item. Applicable to eBay Motors (usually used to elaborate on the return policy). Not applicable to Half.com. Max length: 1000. See:
|
| ShippingDetails.SalesTax | SalesTaxType | Conditionally |
Sales tax details. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. Flat and calculated shipping. Applicable to Half.com (for GetOrders). |
|
ShippingDetails.SalesTax .SalesTaxAmount |
AmountType (double) | Conditionally |
The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. US (site 0) and Motors (site 100) sites only, excluding vehicle listings. 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 OrderLineItemID to call GetOrderTransactions. Applicable to Half.com (for GetOrders). |
| ShippingDetails.SalesTax .SalesTaxAmount [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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 order. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). 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. To see the valid values for your site, call GeteBayDetails with DetailName set to TaxJurisdiction, and then look for the TaxJurisdiction.JurisdictionID fields in the response. Applicable to 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. Applicable to 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. The message text explains that a postal code is needed to calculate shipping. Only returned when ItemDetails is set to Fine. Not applicable to Half.com or eBay Motors vehicle listings. |
|
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: • Counter (out) "Counter" shipping rate scale. • CustomCode (out) Reserved for internal or future use. • DailyPickup (out) "Daily pickup" shipping rate scale. • OnDemand (out) "On-demand" shipping rate scale. • StandardList (out) "Standard List" shipping rate scale. See Shipping. |
|
ShippingDetails .ShippingServiceOptions |
ShippingServiceOptionsType | Conditionally,
repeatable: [0..*] |
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. A seller can offer up to four domestic shipping services and up to five international shipping services. All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. 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 specified 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.00. 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. |
|
ShippingDetails .ShippingServiceOptions .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. Min: 0. |
| ShippingDetails .ShippingServiceOptions .ImportCharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
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). |
| ShippingDetails .ShippingServiceOptions .ShippingInsuranceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ShippingDetails .ShippingServiceOptions .ShippingService |
token | Conditionally |
A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService=true field, as this indicates that the ShippingService value is an International shipping service option. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). If there are two or more services and one is "pickup", "pickup" must not be specified as the first service. See GeteBayDetails. Applicable values: See ShippingServiceCodeType |
|
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. For single-item listings, it should be zero (or is defaulted to zero if not provided). For flat shipping only. Not applicable to Half.com. |
| ShippingDetails .ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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. If a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. Otherwise, cost is not returned. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For GetItemShipping, promotional shipping savings is reflected in the cost, if applicable. If the promotional shipping option is lower than other shipping services being offered, the savings is reflected in the returned shipping cost. The shipping service named Promotional Shipping Service (or whatever is the localized name for it) is included among the shipping services. If the promotional shipping cost is lower than the cost of other shipping services being offered, it is presented first in the list. (The LOWEST shipping service cost is always presented first, regardless of whether there is promotional shipping.) For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider's warehouse). Also applicable to Half.com (for GetOrders). |
| ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. For a list of possible enumeration values, see CurrencyCodeType. |
|
ShippingDetails .ShippingServiceOptions .ShippingServicePriority |
int | Conditionally |
This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services (with four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A shipping service with a ShippingServicePriority value of 1 appears at the top. Conversely, a shipping service with a ShippingServicePriority value of 4 appears at the bottom of a list of four shipping service options. This field is applicable to Flat and Calculated shipping. This field is not applicable to Half.com listings. |
|
ShippingDetails .ShippingServiceOptions .ShippingSurcharge |
AmountType (double) | Conditionally | An additional fee to charge US buyers who have the item shipped via UPS or FedEx 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 line items in an order have a surcharge, surcharge is added only for those line items. Flat rate shipping only. |
| ShippingDetails .ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ] |
CurrencyCodeType | Conditionally |
Three-digit code representing the currency type being used. In the AddItem family of calls, the currency can be specified in the Item.Currency field in requests 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. In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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.ShippingType | ShippingTypeCodeType | Always |
The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. GetItemShipping and GetItemTransactions: If the type was a mix of flat and calculated services, this is set simply to Flat or Calculated because it is the buyer's selection that results in one of these. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. • NotSpecified (in/out) The seller did not specify the shipping type. (Not all values in ShippingTypeCodeType apply to this field.) |
|
ShippingDetails .ThirdPartyCheckout |
boolean | Conditionally |
Deprecated as of version 729. No longer functional. As of July 1, 2011, third-party applications can no longer be used for checkout. All purchased items must go through the eBay Checkout flow. This field can no longer be passed into the Add Item family of calls. This field will be returned in some calls (that return the ShippingDetails container) if it was set to True at listing time (for listings created before July 1, 2011). If this field was set to True at listing time, the user must include this field and set it to False in the Relist and Revise Item family of calls. Otherwise, the caller may get an error. Deprecation version: 729. See also Deprecated Objects. |
| 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 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 |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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 | Conditionally,
repeatable: [0..*] |
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. See the "Errors by Number" document. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
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 and other Trading API calls 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. |
| Input Output Samples Change History Top Errors for GetItemShipping User Notes |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
| Input Output Detail Controls Change History Top Errors for GetItemShipping User Notes |
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.
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 the item 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:
Item 110030335741 is a listing with at least one domestic calculated shipping service. Since he is bidding on only 1 item, QuantitySold is set 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 the ShippingDetails field, which contains the ShippingServiceCost with respect to the ShippingServiceOptions.
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> <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>
| Input Output Detail Controls Samples Top Errors for GetItemShipping User Notes |
| Version | Description |
|---|---|
| 799 2012-11-07 |
|
| 791 2012-09-12 |
|
| 777 2012-06-06 |
|
| 719 2011-04-27 |
|
| 665 2010-04-14 |
|
| 635 2009-09-16 |
|
| 571 2008-06-25 |
|
| 555 2008-03-05 |
|
| 551 2008-02-07 |
|
| 533 2007-10-03 |
|
| 491 2006-12-13 |
|
| 485 2006-11-01 |
|
| 477 2006-09-06 |
|
| 415 2005-6-29 |
|
| 411 2005-6-1 |
|
| Input Output Detail Controls Samples Change History Top Errors for GetItemShipping User Notes |
Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.