Changes since
the last release

com.ebay.sdk.call
Class GetItemShippingCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetItemShippingCall

public class GetItemShippingCall
extends ApiCall

Wrapper class of the GetItemShipping call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: ItemID - The unique identifier of the listing for which to retrieve estimated shipping costs for all offered shipping service options. The ItemID value passed into this field should be for an listing that offers at least one calculated shipping service option, and for an item that has yet to be shipped.
Input property: QuantitySold - This field is used to specify the quantity of the item. The QuantitySold value defaults to 1 if not specified. If a value greater than 1 is specified in this field, the shipping service costs returned in the response will reflect the expense to ship multiple quantity of an item.
Input property: DestinationPostalCode - The destination postal code (or zip code for US) is supplied in this field. GetItemShipping requires the destination of the shipment. Some countries will require both the DestinationPostalCode and the lt;b>DestinationCountryCode, and some countries will accept either one or the other.
Input property: DestinationCountryCode - The destination country code is supplied in this field. GetItemShipping requires the destination of the shipment. Some countries will require both the DestinationPostalCode and the lt;b>DestinationCountryCode, and some countries will accept either one or the other.

Two-digit country codes can be found in CountryCodeType.
Output property: ReturnedShippingDetails - This container will be returned if at least one domestic or international shipping service option is available for the item. A ShippingServiceOptions (for domestic shipping) and/or an InternationalShippingServiceOptions container (for international shipping) is returned for each available calculated shipping service option. These shipping service option containers consists of estimated shipping cost and estimated shipping times.

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.
Output property: ReturnedPickUpInStoreDetails - This container is returned in GetItemShipping if In-Store Pickup or Click and Collect is enabled for the listing.

In a future release, a fulfillment duration element will be added to this container and will be used to determine when the item will be ready for pickup in a store (immediately, two hours after sale, two days after sale, etc.).

Note: At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multiple-quantity, fixed-price listings.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetItemShippingCall()
          Constructor.
GetItemShippingCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 CountryCodeType getDestinationCountryCode()
          Gets the GetItemShippingRequestType.destinationCountryCode.
 String getDestinationPostalCode()
          Gets the GetItemShippingRequestType.destinationPostalCode.
 String getItemID()
          Gets the GetItemShippingRequestType.itemID.
 ShippingDetailsType getItemShipping()
          This is the base request type of the GetItemShipping call.
 Integer getQuantitySold()
          Gets the GetItemShippingRequestType.quantitySold.
 PickupInStoreDetailsType getReturnedPickUpInStoreDetails()
          Valid after executing the API.
 ShippingDetailsType getReturnedShippingDetails()
          Valid after executing the API.
 void setDestinationCountryCode(CountryCodeType destinationCountryCode)
          Sets the GetItemShippingRequestType.destinationCountryCode.
 void setDestinationPostalCode(String destinationPostalCode)
          Sets the GetItemShippingRequestType.destinationPostalCode.
 void setItemID(String itemID)
          Sets the GetItemShippingRequestType.itemID.
 void setQuantitySold(Integer quantitySold)
          Sets the GetItemShippingRequestType.quantitySold.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetItemShippingCall

public GetItemShippingCall()
Constructor.


GetItemShippingCall

public GetItemShippingCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getItemShipping

public ShippingDetailsType getItemShipping()
                                    throws ApiException,
                                           SdkException,
                                           Exception
This is the base request type of the GetItemShipping call. This call takes an ItemID value for an item that has yet to be shipped, and then returns estimated shipping costs for every shipping service that the seller has offered with the listing. This call will also return PickUpInStoreDetails.EligibleForPickupDropOff and PickUpInStoreDetails.EligibleForPickupInStore flags if the item is available for buyer pick-up through the In-Store Pickup or Click and Collect features.

Returns:
The ShippingDetailsType object.
Throws:
ApiException
SdkException
Exception

getDestinationCountryCode

public CountryCodeType getDestinationCountryCode()
Gets the GetItemShippingRequestType.destinationCountryCode.

Returns:
CountryCodeType

setDestinationCountryCode

public void setDestinationCountryCode(CountryCodeType destinationCountryCode)
Sets the GetItemShippingRequestType.destinationCountryCode.

Parameters:
destinationCountryCode - CountryCodeType

getDestinationPostalCode

public String getDestinationPostalCode()
Gets the GetItemShippingRequestType.destinationPostalCode.

Returns:
String

setDestinationPostalCode

public void setDestinationPostalCode(String destinationPostalCode)
Sets the GetItemShippingRequestType.destinationPostalCode.

Parameters:
destinationPostalCode - String

getItemID

public String getItemID()
Gets the GetItemShippingRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the GetItemShippingRequestType.itemID.

Parameters:
itemID - String

getQuantitySold

public Integer getQuantitySold()
Gets the GetItemShippingRequestType.quantitySold.

Returns:
Integer

setQuantitySold

public void setQuantitySold(Integer quantitySold)
Sets the GetItemShippingRequestType.quantitySold.

Parameters:
quantitySold - Integer

getReturnedPickUpInStoreDetails

public PickupInStoreDetailsType getReturnedPickUpInStoreDetails()
Valid after executing the API. Gets the returned GetItemShippingResponseType.returnedPickUpInStoreDetails.

Returns:
PickupInStoreDetailsType

getReturnedShippingDetails

public ShippingDetailsType getReturnedShippingDetails()
Valid after executing the API. Gets the returned GetItemShippingResponseType.returnedShippingDetails.

Returns:
ShippingDetailsType

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.