/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::Call::CompleteSale::CompleteSaleRequestType

NAME

eBay::API::XML::Call::CompleteSale::CompleteSaleRequestType

DESCRIPTION

Enables a seller to do various tasks after an item transaction or multiple-item order has been created. A seller can leave feedback for the buyer, change the paid status, or set shipment tracking information (or any combination of these). Only the seller who listed the item or order can perform these tasks. <br><br> Applies to Half.com, except when using OrderID.

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::CompleteSale::CompleteSaleRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

setFeedbackInfo()

Specifies feedback the seller is leaving for the buyer. For a given transaction, the seller can leave feedback once, and no further modifications can be made to that feedback entry. If feedback has already been left, FeedbackInfo is not allowed. Call GetFeedback to determine whether feedback has already been left.

RequiredInput: No
#    Argument: 'ns:FeedbackInfoType'

getFeedbackInfo()

# Returns: 'ns:FeedbackInfoType'

setItemID()

ID of the listing associated with the transaction that the seller is completing.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

RequiredInput: Yes
#    Argument: 'ns:ItemIDType'

getItemID()

# Returns: 'ns:ItemIDType'

setListingType()

If included in the request, and with a value of ListingType = Half, indicates that the given ItemID and TransactionID values are for Half.com. ListingType is required input for Half.com items.

RequiredInput: Conditionally
OnlyTheseValues: Half
#    Argument: 'ns:ListingTypeCodeType'

getListingType()

# Returns: 'ns:ListingTypeCodeType'

setOrderID()

Unique ID for a multi-item order. ItemID and TransactionID are ignored if a call includes OrderID. CompleteSale applies to the specified order as a whole (and thus the child transactions associated with the order). <br> This tag does not apply to half.com items.

RequiredInput: No
#    Argument: 'xs:string'

getOrderID()

# Returns: 'xs:string'

setPaid()

If true, the transaction is marked as paid in My eBay. If false, the transaction is marked as not paid in My eBay. If not specified, the paid status in My eBay is not modified.

RequiredInput: No
#    Argument: 'xs:boolean'

isPaid()

# Returns: 'xs:boolean'

setShipment()

Details about the shipment. Setting the tracking number and carrier automatically marks the item as shipped (sets Shipped to true).

RequiredInput: No
#    Argument: 'ns:ShipmentType'

getShipment()

# Returns: 'ns:ShipmentType'

setShipped()

If true, the transaction is marked as shipped in My eBay (applicable for Selling Manager Pro users). If false, the transaction is marked as not shipped in My eBay. If not specified, the shipped status in My eBay is not modified.

RequiredInput: No
#    Argument: 'xs:boolean'

isShipped()

# Returns: 'xs:boolean'

setTransactionID()

Unique identifier for a transaction from the listing indicated by ItemID. Call GetItemTransactions or GetSellerTransactions to determine the appropriate transaction ID. Required for all listing types (pass 0 for Chinese auctions).

MaxLength: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.)

RequiredInput: Yes
#    Argument: 'xs:string'

getTransactionID()

# Returns: 'xs:string'