/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::SellerPaymentType

NAME

eBay::API::XML::DataType::SellerPaymentType

DESCRIPTION

A payment between Half.com and a seller. The financial value of a payment is typically based on an amount that a buyer paid to Half.com for a transaction, plus the shipping cost the buyer paid for the item, minus Half.com's commission. Each payment is for one transaction for one item in one order.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::SellerPaymentType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setAmountPaid()

Payment amount made by buyer for the Half.com transaction.

# Argument: 'ns:AmountType'

getAmountPaid()

Calls: GetSellerPayments
Returned: Always

# Returns: 'ns:AmountType'

setCommission()

Amount of commission charged by Half.com.

# Argument: 'ns:AmountType'

getCommission()

Calls: GetSellerPayments
Returned: Always

# Returns: 'ns:AmountType'

setExternalProductID()

Contains an ISBN, UPC, or EAN value from the catalog product associated with the Half.com item. All Half.com items are listed with Pre-filled Item Information.

# Argument: 'ns:ExternalProductIDType'

getExternalProductID()

Calls: GetSellerPayments
Returned: Always

# Returns: 'ns:ExternalProductIDType'

setItemID()

ID of the Half.com item associated with the payment.

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

# Argument: 'ns:ItemIDType'

getItemID()

Calls: GetSellerPayments
Returned: Always

# Returns: 'ns:ItemIDType'

setOrderID()

ID of the Half.com order associated with the payment. Returns 0 for single-transaction orders.

# Argument: 'ns:OrderIDType'

getOrderID()

Calls: GetSellerPayments
Returned: Always

# Returns: 'ns:OrderIDType'

setPaidTime()

The time and date when Half.com created the payment. (A payment is created when the buyer pays for an order.) This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones.

# Argument: 'xs:dateTime'

getPaidTime()

Calls: GetSellerPayments
Returned: Always

# Returns: 'xs:dateTime'

setPaymentType()

Indicates whether the payment is for a Half.com sale or a refund.

# Argument: 'ns:PaymentTypeCodeType'

getPaymentType()

Calls: GetSellerPayments
Returned: Always
OnlyTheseValues: Sale, Refund

# Returns: 'ns:PaymentTypeCodeType'

setPrivateNotes()

A text note that the seller specified for the Half.com item, if any. Only visible to the seller. Not returned if the seller specified no notes.

# Argument: 'xs:string'

getPrivateNotes()

Calls: GetSellerPayments
Returned: Conditionally

# Returns: 'xs:string'

setSellerInventoryID()

An ID that the seller specified when they listed the Half.com item, if any. It can be used for the seller's SKU. Note that SellerInventoryID is not returned if no ID was specified. (Note: The SKU field used for eBay.com listings is not applicable to Half.com listings.)

# Argument: 'xs:string'

getSellerInventoryID()

Calls: GetSellerPayments
Returned: Conditionally

# Returns: 'xs:string'

setShippingReimbursement()

The adjusted shipping cost that Half.com pays the seller. If multiple items from the same seller are in the same order, this amount may be less than the rate for shipping the item individually. This amount may also be adjusted due to Half.com handling charges. (Due to the way shipping costs are calculated, this value may be different for identical items in different orders.)

# Argument: 'ns:AmountType'

getShippingReimbursement()

Calls: GetSellerPayments
Returned: Always

# Returns: 'ns:AmountType'

setTitle()

The title of the listing, as it appears on Half.com.

# Argument: 'xs:string'

getTitle()

Calls: GetSellerPayments
Returned: Always

# Returns: 'xs:string'

setTransactionID()

ID of the Half.com transaction associated with the payment.

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

# Argument: 'xs:string'

getTransactionID()

Calls: GetSellerPayments
Returned: Always

# Returns: 'xs:string'

setTransactionPrice()

Price of the transaction specified by TransactionID (before shipping and other costs).

# Argument: 'ns:AmountType'

getTransactionPrice()

Calls: GetSellerPayments
Returned: Always

# Returns: 'ns:AmountType'