NAME
eBay::API::XML::DataType::ShipmentType
DESCRIPTION
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::ShipmentType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setDeliveryDate()
Revise only
# Argument: 'xs:dateTime'
getDeliveryDate()
# Returns: 'xs:dateTime'
setDeliveryStatus()
Revise only
# Argument: 'ns:ShipmentDeliveryStatusCodeType'
getDeliveryStatus()
# Returns: 'ns:ShipmentDeliveryStatusCodeType'
setEstimatedDeliveryDate()
# Argument: 'xs:dateTime'
getEstimatedDeliveryDate()
# Returns: 'xs:dateTime'
setInsuredValue()
# Argument: 'ns:AmountType'
getInsuredValue()
# Returns: 'ns:AmountType'
setItemTransactionID()
# Argument: reference to an array of 'ns:ItemTransactionIDType'
getItemTransactionID()
# Returns: reference to an array of 'ns:ItemTransactionIDType'
setPackageDepth()
Depth dimension of the package needed to ship the item after it is sold. For calculated shipping only.
# Argument: 'ns:MeasureType'
getPackageDepth()
# Returns: 'ns:MeasureType'
setPackageLength()
Length dimension of the package needed to ship the item after it is sold. For calculated shipping only.
# Argument: 'ns:MeasureType'
getPackageLength()
# Returns: 'ns:MeasureType'
setPackageWidth()
Width dimension of the package needed to ship the item after it is sold. For calculated shipping only.
# Argument: 'ns:MeasureType'
getPackageWidth()
# Returns: 'ns:MeasureType'
setPayPalShipmentID()
# Argument: 'xs:string'
getPayPalShipmentID()
# Returns: 'xs:string'
setPostageTotal()
# Argument: 'ns:AmountType'
getPostageTotal()
# Returns: 'ns:AmountType'
setPrintedTime()
# Argument: 'xs:dateTime'
getPrintedTime()
# Returns: 'xs:dateTime'
setRefundGrantedTime()
Revise only
# Argument: 'xs:dateTime'
getRefundGrantedTime()
# Returns: 'xs:dateTime'
setRefundRequestedTime()
Revise only
# Argument: 'xs:dateTime'
getRefundRequestedTime()
# Returns: 'xs:dateTime'
setShipFromAddress()
The address from which the item is being shipped.
# Argument: 'ns:AddressType'
getShipFromAddress()
# Returns: 'ns:AddressType'
setShipmentID()
# Argument: 'xs:long'
getShipmentID()
# Returns: 'xs:long'
setShipmentTrackingNumber()
The tracking number associated with the shipment. The format of the shipment tracking number must be consistent with the specified ShippingCarrierUsed.
Calls: CompleteSale
RequiredInput: No# Argument: 'xs:string'
getShipmentTrackingNumber()
# Returns: 'xs:string'
setShippingAddress()
The address to which the item is to be shipped.
# Argument: 'ns:AddressType'
getShippingAddress()
# Returns: 'ns:AddressType'
setShippingCarrierUsed()
The shipping carrier used.
Calls: CompleteSale
RequiredInput: No
OnlyTheseValues: USPS, UPS# Argument: 'ns:ShippingCarrierCodeType'
getShippingCarrierUsed()
# Returns: 'ns:ShippingCarrierCodeType'
setShippingFeature()
# Argument: reference to an array of 'ns:ShippingFeatureCodeType'
getShippingFeature()
# Returns: reference to an array of 'ns:ShippingFeatureCodeType'
setShippingPackage()
The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.
# Argument: 'ns:ShippingPackageCodeType'
getShippingPackage()
# Returns: 'ns:ShippingPackageCodeType'
setShippingServiceUsed()
The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.
# Argument: 'xs:token'
getShippingServiceUsed()
# Returns: 'xs:token'
setStatus()
Status, for revise only
# Argument: 'ns:ShipmentStatusCodeType'
getStatus()
# Returns: 'ns:ShipmentStatusCodeType'
setWeightMajor()
See the documentation regarding "Working with Item Weights". The 'unit' attribute can have a value of lbs.
# Argument: 'ns:MeasureType'
getWeightMajor()
# Returns: 'ns:MeasureType'
setWeightMinor()
See the documentation regarding "Working with Item Weights". The 'unit' attribute is optional and assumed to be the minor compared to the value of 'unit' in WeightMajor.
# Argument: 'ns:MeasureType'
getWeightMinor()
# Returns: 'ns:MeasureType'