Changes since
the last release

com.ebay.soap.eBLBaseComponents
Class ShipmentType

java.lang.Object
  extended by com.ebay.soap.eBLBaseComponents.ShipmentType
All Implemented Interfaces:
Serializable

public class ShipmentType
extends Object
implements Serializable

Type defining the Shipment container, which is used by the seller in CompleteSale to provide shipping information. The Shipment container is also returned in the GetSellingManagerSaleRecord response.

Java class for ShipmentType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ShipmentType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="EstimatedDeliveryDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="InsuredValue" type="{urn:ebay:apis:eBLBaseComponents}AmountType" minOccurs="0"/>
         <element name="PackageDepth" type="{urn:ebay:apis:eBLBaseComponents}MeasureType" minOccurs="0"/>
         <element name="PackageLength" type="{urn:ebay:apis:eBLBaseComponents}MeasureType" minOccurs="0"/>
         <element name="PackageWidth" type="{urn:ebay:apis:eBLBaseComponents}MeasureType" minOccurs="0"/>
         <element name="PayPalShipmentID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ShipmentID" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="PostageTotal" type="{urn:ebay:apis:eBLBaseComponents}AmountType" minOccurs="0"/>
         <element name="PrintedTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="ShipFromAddress" type="{urn:ebay:apis:eBLBaseComponents}AddressType" minOccurs="0"/>
         <element name="ShippingAddress" type="{urn:ebay:apis:eBLBaseComponents}AddressType" minOccurs="0"/>
         <element name="ShippingCarrierUsed" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ShippingFeature" type="{urn:ebay:apis:eBLBaseComponents}ShippingFeatureCodeType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ShippingPackage" type="{urn:ebay:apis:eBLBaseComponents}ShippingPackageCodeType" minOccurs="0"/>
         <element name="ShippingServiceUsed" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="ShipmentTrackingNumber" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="WeightMajor" type="{urn:ebay:apis:eBLBaseComponents}MeasureType" minOccurs="0"/>
         <element name="WeightMinor" type="{urn:ebay:apis:eBLBaseComponents}MeasureType" minOccurs="0"/>
         <element name="ItemTransactionID" type="{urn:ebay:apis:eBLBaseComponents}ItemTransactionIDType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="DeliveryDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="DeliveryStatus" type="{urn:ebay:apis:eBLBaseComponents}ShipmentDeliveryStatusCodeType" minOccurs="0"/>
         <element name="RefundGrantedTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="RefundRequestedTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="Status" type="{urn:ebay:apis:eBLBaseComponents}ShipmentStatusCodeType" minOccurs="0"/>
         <element name="ShippedTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="Notes" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ShipmentTrackingDetails" type="{urn:ebay:apis:eBLBaseComponents}ShipmentTrackingDetailsType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ShipmentLineItem" type="{urn:ebay:apis:eBLBaseComponents}ShipmentLineItemType" minOccurs="0"/>
         <any/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Field Summary
protected  List<Object> any
           
protected  Calendar deliveryDate
           
protected  ShipmentDeliveryStatusCodeType deliveryStatus
           
protected  Calendar estimatedDeliveryDate
           
protected  AmountType insuredValue
           
protected  List<ItemTransactionIDType> itemTransactionID
           
protected  String notes
           
protected  MeasureType packageDepth
           
protected  MeasureType packageLength
           
protected  MeasureType packageWidth
           
protected  String payPalShipmentID
           
protected  AmountType postageTotal
           
protected  Calendar printedTime
           
protected  Calendar refundGrantedTime
           
protected  Calendar refundRequestedTime
           
protected  AddressType shipFromAddress
           
protected  Long shipmentID
           
protected  ShipmentLineItemType shipmentLineItem
           
protected  List<ShipmentTrackingDetailsType> shipmentTrackingDetails
           
protected  String shipmentTrackingNumber
           
protected  Calendar shippedTime
           
protected  AddressType shippingAddress
           
protected  String shippingCarrierUsed
           
protected  List<ShippingFeatureCodeType> shippingFeature
           
protected  ShippingPackageCodeType shippingPackage
           
protected  String shippingServiceUsed
           
protected  ShipmentStatusCodeType status
           
protected  MeasureType weightMajor
           
protected  MeasureType weightMinor
           
 
Constructor Summary
ShipmentType()
           
 
Method Summary
protected  List<Object> _getAny()
           
protected  List<ItemTransactionIDType> _getItemTransactionID()
           
protected  List<ShipmentTrackingDetailsType> _getShipmentTrackingDetails()
           
protected  List<ShippingFeatureCodeType> _getShippingFeature()
           
 Object[] getAny()
           
 Object getAny(int idx)
           
 int getAnyLength()
           
 Calendar getDeliveryDate()
          Gets the value of the deliveryDate property.
 ShipmentDeliveryStatusCodeType getDeliveryStatus()
          Gets the value of the deliveryStatus property.
 Calendar getEstimatedDeliveryDate()
          Gets the value of the estimatedDeliveryDate property.
 AmountType getInsuredValue()
          Gets the value of the insuredValue property.
 ItemTransactionIDType[] getItemTransactionID()
           
 ItemTransactionIDType getItemTransactionID(int idx)
           
 int getItemTransactionIDLength()
           
 String getNotes()
          Gets the value of the notes property.
 MeasureType getPackageDepth()
          Gets the value of the packageDepth property.
 MeasureType getPackageLength()
          Gets the value of the packageLength property.
 MeasureType getPackageWidth()
          Gets the value of the packageWidth property.
 String getPayPalShipmentID()
          Gets the value of the payPalShipmentID property.
 AmountType getPostageTotal()
          Gets the value of the postageTotal property.
 Calendar getPrintedTime()
          Gets the value of the printedTime property.
 Calendar getRefundGrantedTime()
          Gets the value of the refundGrantedTime property.
 Calendar getRefundRequestedTime()
          Gets the value of the refundRequestedTime property.
 AddressType getShipFromAddress()
          Gets the value of the shipFromAddress property.
 Long getShipmentID()
          Gets the value of the shipmentID property.
 ShipmentLineItemType getShipmentLineItem()
          Gets the value of the shipmentLineItem property.
 ShipmentTrackingDetailsType[] getShipmentTrackingDetails()
           
 ShipmentTrackingDetailsType getShipmentTrackingDetails(int idx)
           
 int getShipmentTrackingDetailsLength()
           
 String getShipmentTrackingNumber()
          Gets the value of the shipmentTrackingNumber property.
 Calendar getShippedTime()
          Gets the value of the shippedTime property.
 AddressType getShippingAddress()
          Gets the value of the shippingAddress property.
 String getShippingCarrierUsed()
          Gets the value of the shippingCarrierUsed property.
 ShippingFeatureCodeType[] getShippingFeature()
           
 ShippingFeatureCodeType getShippingFeature(int idx)
           
 int getShippingFeatureLength()
           
 ShippingPackageCodeType getShippingPackage()
          Gets the value of the shippingPackage property.
 String getShippingServiceUsed()
          Gets the value of the shippingServiceUsed property.
 ShipmentStatusCodeType getStatus()
          Gets the value of the status property.
 MeasureType getWeightMajor()
          Gets the value of the weightMajor property.
 MeasureType getWeightMinor()
          Gets the value of the weightMinor property.
 Object setAny(int idx, Object value)
           
 void setAny(Object[] values)
           
 void setDeliveryDate(Calendar value)
          Sets the value of the deliveryDate property.
 void setDeliveryStatus(ShipmentDeliveryStatusCodeType value)
          Sets the value of the deliveryStatus property.
 void setEstimatedDeliveryDate(Calendar value)
          Sets the value of the estimatedDeliveryDate property.
 void setInsuredValue(AmountType value)
          Sets the value of the insuredValue property.
 ItemTransactionIDType setItemTransactionID(int idx, ItemTransactionIDType value)
           
 void setItemTransactionID(ItemTransactionIDType[] values)
           
 void setNotes(String value)
          Sets the value of the notes property.
 void setPackageDepth(MeasureType value)
          Sets the value of the packageDepth property.
 void setPackageLength(MeasureType value)
          Sets the value of the packageLength property.
 void setPackageWidth(MeasureType value)
          Sets the value of the packageWidth property.
 void setPayPalShipmentID(String value)
          Sets the value of the payPalShipmentID property.
 void setPostageTotal(AmountType value)
          Sets the value of the postageTotal property.
 void setPrintedTime(Calendar value)
          Sets the value of the printedTime property.
 void setRefundGrantedTime(Calendar value)
          Sets the value of the refundGrantedTime property.
 void setRefundRequestedTime(Calendar value)
          Sets the value of the refundRequestedTime property.
 void setShipFromAddress(AddressType value)
          Sets the value of the shipFromAddress property.
 void setShipmentID(Long value)
          Sets the value of the shipmentID property.
 void setShipmentLineItem(ShipmentLineItemType value)
          Sets the value of the shipmentLineItem property.
 ShipmentTrackingDetailsType setShipmentTrackingDetails(int idx, ShipmentTrackingDetailsType value)
           
 void setShipmentTrackingDetails(ShipmentTrackingDetailsType[] values)
           
 void setShipmentTrackingNumber(String value)
          Sets the value of the shipmentTrackingNumber property.
 void setShippedTime(Calendar value)
          Sets the value of the shippedTime property.
 void setShippingAddress(AddressType value)
          Sets the value of the shippingAddress property.
 void setShippingCarrierUsed(String value)
          Sets the value of the shippingCarrierUsed property.
 ShippingFeatureCodeType setShippingFeature(int idx, ShippingFeatureCodeType value)
           
 void setShippingFeature(ShippingFeatureCodeType[] values)
           
 void setShippingPackage(ShippingPackageCodeType value)
          Sets the value of the shippingPackage property.
 void setShippingServiceUsed(String value)
          Sets the value of the shippingServiceUsed property.
 void setStatus(ShipmentStatusCodeType value)
          Sets the value of the status property.
 void setWeightMajor(MeasureType value)
          Sets the value of the weightMajor property.
 void setWeightMinor(MeasureType value)
          Sets the value of the weightMinor property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

estimatedDeliveryDate

protected Calendar estimatedDeliveryDate

insuredValue

protected AmountType insuredValue

packageDepth

protected MeasureType packageDepth

packageLength

protected MeasureType packageLength

packageWidth

protected MeasureType packageWidth

payPalShipmentID

protected String payPalShipmentID

shipmentID

protected Long shipmentID

postageTotal

protected AmountType postageTotal

printedTime

protected Calendar printedTime

shipFromAddress

protected AddressType shipFromAddress

shippingAddress

protected AddressType shippingAddress

shippingCarrierUsed

protected String shippingCarrierUsed

shippingFeature

protected List<ShippingFeatureCodeType> shippingFeature

shippingPackage

protected ShippingPackageCodeType shippingPackage

shippingServiceUsed

protected String shippingServiceUsed

shipmentTrackingNumber

protected String shipmentTrackingNumber

weightMajor

protected MeasureType weightMajor

weightMinor

protected MeasureType weightMinor

itemTransactionID

protected List<ItemTransactionIDType> itemTransactionID

deliveryDate

protected Calendar deliveryDate

deliveryStatus

protected ShipmentDeliveryStatusCodeType deliveryStatus

refundGrantedTime

protected Calendar refundGrantedTime

refundRequestedTime

protected Calendar refundRequestedTime

status

protected ShipmentStatusCodeType status

shippedTime

protected Calendar shippedTime

notes

protected String notes

shipmentTrackingDetails

protected List<ShipmentTrackingDetailsType> shipmentTrackingDetails

shipmentLineItem

protected ShipmentLineItemType shipmentLineItem

any

protected List<Object> any
Constructor Detail

ShipmentType

public ShipmentType()
Method Detail

getEstimatedDeliveryDate

public Calendar getEstimatedDeliveryDate()
Gets the value of the estimatedDeliveryDate property.

Returns:
possible object is String

setEstimatedDeliveryDate

public void setEstimatedDeliveryDate(Calendar value)
Sets the value of the estimatedDeliveryDate property.

Parameters:
value - allowed object is String

getInsuredValue

public AmountType getInsuredValue()
Gets the value of the insuredValue property.

Returns:
possible object is AmountType

setInsuredValue

public void setInsuredValue(AmountType value)
Sets the value of the insuredValue property.

Parameters:
value - allowed object is AmountType

getPackageDepth

public MeasureType getPackageDepth()
Gets the value of the packageDepth property.

Returns:
possible object is MeasureType

setPackageDepth

public void setPackageDepth(MeasureType value)
Sets the value of the packageDepth property.

Parameters:
value - allowed object is MeasureType

getPackageLength

public MeasureType getPackageLength()
Gets the value of the packageLength property.

Returns:
possible object is MeasureType

setPackageLength

public void setPackageLength(MeasureType value)
Sets the value of the packageLength property.

Parameters:
value - allowed object is MeasureType

getPackageWidth

public MeasureType getPackageWidth()
Gets the value of the packageWidth property.

Returns:
possible object is MeasureType

setPackageWidth

public void setPackageWidth(MeasureType value)
Sets the value of the packageWidth property.

Parameters:
value - allowed object is MeasureType

getPayPalShipmentID

public String getPayPalShipmentID()
Gets the value of the payPalShipmentID property.

Returns:
possible object is String

setPayPalShipmentID

public void setPayPalShipmentID(String value)
Sets the value of the payPalShipmentID property.

Parameters:
value - allowed object is String

getShipmentID

public Long getShipmentID()
Gets the value of the shipmentID property.

Returns:
possible object is Long

setShipmentID

public void setShipmentID(Long value)
Sets the value of the shipmentID property.

Parameters:
value - allowed object is Long

getPostageTotal

public AmountType getPostageTotal()
Gets the value of the postageTotal property.

Returns:
possible object is AmountType

setPostageTotal

public void setPostageTotal(AmountType value)
Sets the value of the postageTotal property.

Parameters:
value - allowed object is AmountType

getPrintedTime

public Calendar getPrintedTime()
Gets the value of the printedTime property.

Returns:
possible object is String

setPrintedTime

public void setPrintedTime(Calendar value)
Sets the value of the printedTime property.

Parameters:
value - allowed object is String

getShipFromAddress

public AddressType getShipFromAddress()
Gets the value of the shipFromAddress property.

Returns:
possible object is AddressType

setShipFromAddress

public void setShipFromAddress(AddressType value)
Sets the value of the shipFromAddress property.

Parameters:
value - allowed object is AddressType

getShippingAddress

public AddressType getShippingAddress()
Gets the value of the shippingAddress property.

Returns:
possible object is AddressType

setShippingAddress

public void setShippingAddress(AddressType value)
Sets the value of the shippingAddress property.

Parameters:
value - allowed object is AddressType

getShippingCarrierUsed

public String getShippingCarrierUsed()
Gets the value of the shippingCarrierUsed property.

Returns:
possible object is String

setShippingCarrierUsed

public void setShippingCarrierUsed(String value)
Sets the value of the shippingCarrierUsed property.

Parameters:
value - allowed object is String

getShippingFeature

public ShippingFeatureCodeType[] getShippingFeature()
Returns:
array of ShippingFeatureCodeType

getShippingFeature

public ShippingFeatureCodeType getShippingFeature(int idx)
Returns:
one of ShippingFeatureCodeType

getShippingFeatureLength

public int getShippingFeatureLength()

setShippingFeature

public void setShippingFeature(ShippingFeatureCodeType[] values)
Parameters:
values - allowed objects are ShippingFeatureCodeType

_getShippingFeature

protected List<ShippingFeatureCodeType> _getShippingFeature()

setShippingFeature

public ShippingFeatureCodeType setShippingFeature(int idx,
                                                  ShippingFeatureCodeType value)
Parameters:
value - allowed object is ShippingFeatureCodeType

getShippingPackage

public ShippingPackageCodeType getShippingPackage()
Gets the value of the shippingPackage property.

Returns:
possible object is ShippingPackageCodeType

setShippingPackage

public void setShippingPackage(ShippingPackageCodeType value)
Sets the value of the shippingPackage property.

Parameters:
value - allowed object is ShippingPackageCodeType

getShippingServiceUsed

public String getShippingServiceUsed()
Gets the value of the shippingServiceUsed property.

Returns:
possible object is String

setShippingServiceUsed

public void setShippingServiceUsed(String value)
Sets the value of the shippingServiceUsed property.

Parameters:
value - allowed object is String

getShipmentTrackingNumber

public String getShipmentTrackingNumber()
Gets the value of the shipmentTrackingNumber property.

Returns:
possible object is String

setShipmentTrackingNumber

public void setShipmentTrackingNumber(String value)
Sets the value of the shipmentTrackingNumber property.

Parameters:
value - allowed object is String

getWeightMajor

public MeasureType getWeightMajor()
Gets the value of the weightMajor property.

Returns:
possible object is MeasureType

setWeightMajor

public void setWeightMajor(MeasureType value)
Sets the value of the weightMajor property.

Parameters:
value - allowed object is MeasureType

getWeightMinor

public MeasureType getWeightMinor()
Gets the value of the weightMinor property.

Returns:
possible object is MeasureType

setWeightMinor

public void setWeightMinor(MeasureType value)
Sets the value of the weightMinor property.

Parameters:
value - allowed object is MeasureType

getItemTransactionID

public ItemTransactionIDType[] getItemTransactionID()
Returns:
array of ItemTransactionIDType

getItemTransactionID

public ItemTransactionIDType getItemTransactionID(int idx)
Returns:
one of ItemTransactionIDType

getItemTransactionIDLength

public int getItemTransactionIDLength()

setItemTransactionID

public void setItemTransactionID(ItemTransactionIDType[] values)
Parameters:
values - allowed objects are ItemTransactionIDType

_getItemTransactionID

protected List<ItemTransactionIDType> _getItemTransactionID()

setItemTransactionID

public ItemTransactionIDType setItemTransactionID(int idx,
                                                  ItemTransactionIDType value)
Parameters:
value - allowed object is ItemTransactionIDType

getDeliveryDate

public Calendar getDeliveryDate()
Gets the value of the deliveryDate property.

Returns:
possible object is String

setDeliveryDate

public void setDeliveryDate(Calendar value)
Sets the value of the deliveryDate property.

Parameters:
value - allowed object is String

getDeliveryStatus

public ShipmentDeliveryStatusCodeType getDeliveryStatus()
Gets the value of the deliveryStatus property.

Returns:
possible object is ShipmentDeliveryStatusCodeType

setDeliveryStatus

public void setDeliveryStatus(ShipmentDeliveryStatusCodeType value)
Sets the value of the deliveryStatus property.

Parameters:
value - allowed object is ShipmentDeliveryStatusCodeType

getRefundGrantedTime

public Calendar getRefundGrantedTime()
Gets the value of the refundGrantedTime property.

Returns:
possible object is String

setRefundGrantedTime

public void setRefundGrantedTime(Calendar value)
Sets the value of the refundGrantedTime property.

Parameters:
value - allowed object is String

getRefundRequestedTime

public Calendar getRefundRequestedTime()
Gets the value of the refundRequestedTime property.

Returns:
possible object is String

setRefundRequestedTime

public void setRefundRequestedTime(Calendar value)
Sets the value of the refundRequestedTime property.

Parameters:
value - allowed object is String

getStatus

public ShipmentStatusCodeType getStatus()
Gets the value of the status property.

Returns:
possible object is ShipmentStatusCodeType

setStatus

public void setStatus(ShipmentStatusCodeType value)
Sets the value of the status property.

Parameters:
value - allowed object is ShipmentStatusCodeType

getShippedTime

public Calendar getShippedTime()
Gets the value of the shippedTime property.

Returns:
possible object is String

setShippedTime

public void setShippedTime(Calendar value)
Sets the value of the shippedTime property.

Parameters:
value - allowed object is String

getNotes

public String getNotes()
Gets the value of the notes property.

Returns:
possible object is String

setNotes

public void setNotes(String value)
Sets the value of the notes property.

Parameters:
value - allowed object is String

getShipmentTrackingDetails

public ShipmentTrackingDetailsType[] getShipmentTrackingDetails()
Returns:
array of ShipmentTrackingDetailsType

getShipmentTrackingDetails

public ShipmentTrackingDetailsType getShipmentTrackingDetails(int idx)
Returns:
one of ShipmentTrackingDetailsType

getShipmentTrackingDetailsLength

public int getShipmentTrackingDetailsLength()

setShipmentTrackingDetails

public void setShipmentTrackingDetails(ShipmentTrackingDetailsType[] values)
Parameters:
values - allowed objects are ShipmentTrackingDetailsType

_getShipmentTrackingDetails

protected List<ShipmentTrackingDetailsType> _getShipmentTrackingDetails()

setShipmentTrackingDetails

public ShipmentTrackingDetailsType setShipmentTrackingDetails(int idx,
                                                              ShipmentTrackingDetailsType value)
Parameters:
value - allowed object is ShipmentTrackingDetailsType

getShipmentLineItem

public ShipmentLineItemType getShipmentLineItem()
Gets the value of the shipmentLineItem property.

Returns:
possible object is ShipmentLineItemType

setShipmentLineItem

public void setShipmentLineItem(ShipmentLineItemType value)
Sets the value of the shipmentLineItem property.

Parameters:
value - allowed object is ShipmentLineItemType

getAny

public Object[] getAny()
Returns:
array of Element Object

getAny

public Object getAny(int idx)
Returns:
one of Element Object

getAnyLength

public int getAnyLength()

setAny

public void setAny(Object[] values)
Parameters:
values - allowed objects are Element Object

_getAny

protected List<Object> _getAny()

setAny

public Object setAny(int idx,
                     Object value)
Parameters:
value - allowed object is Element Object

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.