eBay::API::XML::DataType::TransactionType
Contains information about a single transaction. A transaction contains information about the sale one or multiple items from a listing to a single buyer. The eBay system creates a transaction when a buyer has made a purchase (fixed-price listings) or is the winning bidder (BIN and competitive-bidding listings). A listing can spawn one or more transactions in these cases: multi-item fixed-price listings and Dutch listings. A listing can spawn only a single transaction in these cases: single-item fixed-price listings and Chinese listings.
eBay::API::XML::DataType::TransactionType inherits from the eBay::API::XML::BaseDataType class
Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller. Not applicable to Half.com.
# Argument: 'ns:AmountType'
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
# Returns: 'ns:AmountType'
The amount the buyer paid for the item(s) in the transaction. If the seller allowed the buyer to change the item total, the buyer is able to change the total until the time that the transaction's status moves to Complete. Determine whether the buyer changed the amount by retrieving the transaction data and comparing the AmountPaid value to what the seller expected. For combined payment (the transaction is part of an order), GetSellerTransactions and GetItemTransactions return the amount paid for the order to which the transaction belongs. For Motors items, AmountPaid is the amount paid by the buyer for the deposit. Not applicable to Half.com.
Whether the transaction was completed with the seller selecting a best offer. Not applicable to Half.com.
# Argument: 'xs:boolean'
# Returns: 'xs:boolean'
Contains the data for the transaction's buyer. See UserType for its child elements. <br><br> Returned by GetItemsAwaitingFeedback if Seller is making the request. <br><br> Not applicable to Half.com except for GetOrders.
# Argument: 'ns:UserType'
Calls: GetItemsAwaitingFeedback Returned: Conditionally Calls: GetOrders Returned: Conditionally Details: DetailLevel: none Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: none, ReturnAll Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ReturnAll
# Returns: 'ns:UserType'
For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.
Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Display message from buyer. This field holds transient data that is only being returned in the notification flow. This field is only returned in the Checkout related notifications. Not applicable to Half.com.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications Title: Working with Platform Notifications
# Argument: 'xs:string'
# Returns: 'xs:string'
Specifies the transaction's paid status, as seen by the buyer. Returned in lists of won items. Not applicable to Half.com.
# Argument: 'ns:PaidStatusCodeType'
Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList
# Returns: 'ns:PaidStatusCodeType'
Shopping cart identifier. Only returned for transactions made on Shopping.com using the Shopping.com shopping cart.
MaxLength: 10
Calls: GetItemTransactions GetOrderTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
The order to which the transaction belongs. This is only returned if IncludeContainingOrder is true and and if this transaction is part of an active or completed order. Not applicable to Half.com.
# Argument: 'ns:OrderType'
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ReturnAll
# Returns: 'ns:OrderType'
Converted value of AdjustmentAmount in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Half.com.
Converted value of AmountPaid in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Half.com.
Converted value of TransactionPrice in the currency of the site that returned the response. Refresh this value every 24 hours to pick up the current conversion rates. Not applicable to Half.com.
Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bidding listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created. For GetOrders, only applicable to Half.com.
# Argument: 'xs:dateTime'
Calls: GetOrders Returned: Always Details: DetailLevel: none Calls: GetOrderTransactions Returned: Always Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList
# Returns: 'xs:dateTime'
Whether the seller requires a deposit for the vehicle. Only applicable to US eBay Motors listings. If item is not a Motors item, then this returns an empty value. Not applicable to Half.com.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MotorsDeposit Title: Specifying a Vehicle Deposit and Deposit Amount
# Argument: 'ns:DepositTypeCodeType'
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll OnlyTheseValues: None, OtherMethod Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll OnlyTheseValues: None, OtherMethod
# Returns: 'ns:DepositTypeCodeType'
This field holds the Dutch Auction Offer Bid by the buyer in this transaction, if this is a Dutch Auction Item. This field will only be returned if caller has set IncludeDuctionAuctionBid to true. Not applicable to Half.com.
A PayPal transaction that relates to this eBay transaction. Returned only if there is at least one PayPal transaction related to this eBay transaction. Not applicable to Half.com.
# Argument: reference to an array of 'ns:ExternalTransactionType'
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: ReturnAll Calls: GetOrders Returned: Conditionally Details: DetailLevel: none, ReturnAll Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: ReturnAll
# Returns: reference to an array of 'ns:ExternalTransactionType'
A container for feedback information left FOR the user's transaction partner. Only returned if feedback was left for a transaction. <br /><br /> Not applicable to Half.com.
# Argument: 'ns:FeedbackInfoType'
Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList
# Returns: 'ns:FeedbackInfoType'
A container for feedback information left BY the user's transaction partner. Only returned if feedback was left for a transaction. <br /><br /> Not applicable to Half.com.
Calls: GetItemsAwaitingFeedback Returned: Conditionally Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList
You are charged a Final Value Fee if your item is sold, ends with a winning bid, or is purchased. This fee applies whether or not you actually complete the sale with the buyer. If you request a Final Value Fee Credit, the value of Transaction.FinalValueFee will not change for the item if a credit is issued. (The credit only appears in the seller's account data.) See the eBay.com Web site online help for more information about the Final Value Fee. The Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned by GetSellerTransactions, GetItemTransactions, and GetOrderTransactions on a transaction-by-transaction basis. For all other listing types, including Chinese and Dutch (no Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed. If the item was a Dutch auction that ended with bids (not Buy It Now purchases), the Final Value Fee is returned in Item.SellingStatus.FinalValueFee. For all other listing types, including Dutch auctions that end with Buy It Now purchases, the Final Value Fee is returned in Transaction.FinalValueFee. Not applicable to Half.com.
Calls: GetOrderTransactions GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Information about the item that spawned the transaction. It is a purchase from this item's listing that the transaction represents. To remove a property from an item, specify it in ModifyType as a changed property, but do not give it a value in Item. Also applicable to Half.com (for GetOrders).
Calls: AddOrder RequiredInput: Yes
# Argument: 'ns:ItemType'
Calls: GetOrders Returned: Always Details: DetailLevel: none Calls: GetOrderTransactions Returned: Always Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList Calls: GetItemsAwaitingFeedback GetMyeBaySelling Returned: Conditionally Calls: GetSellerTransactions Returned: Always Details: DetailLevel: none, ItemReturnDescription, ReturnAll
# Returns: 'ns:ItemType'
ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if ThirdPartyCheckout is true.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ThirdPartyCheckoutRedirectProStores Title: Third Party Checkout Redirect to ProStores
# Argument: 'ns:ListingCheckoutRedirectPreferenceType'
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetOrders Returned: Conditionally Details: DetailLevel: none
# Returns: 'ns:ListingCheckoutRedirectPreferenceType'
Indicates the time when the transaction was marked paid, if known. The value is set by eBay when payment is made via PayPal or a third-party checkout flow. This value is also set when the seller marks the item as paid by using ReviseCheckoutStatus or CompleteSale. The seller can also mark the item as paid by using My eBay or Selling Manager Pro. Note that this value is only visible if the request user is the buyer or seller associated with the transaction. If the item is marked as paid but the seller is not a Selling Manager Pro user, PaidTime returns the transaction creation time instead. Not applicable to Half.com.
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList
Specifies the PaisaPayID using which the Item was paid for. Applicable for India site(203) only.
Calls: GetMyeBayBuying RequiredInput: No Returned: Conditionally Calls: GetMyeBaySelling RequiredInput: No Returned: Conditionally
The seller's Paypal email address.
Name of the eBay co-branded site upon which the transaction was made.
# Argument: 'ns:TransactionPlatformCodeType'
Calls: GetItemTransactions GetOrderTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ReturnAll Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: none, ReturnAll Calls: GetItemTransactions Returned: Conditionally Details: DetailLevel: none, ReturnAll
# Returns: 'ns:TransactionPlatformCodeType'
Indicates the number of items the buyer purchased from the listing identified in ItemID. Also applicable to Half.com (for GetOrders).
# Argument: 'xs:int'
Calls: GetOrders Returned: Always Details: DetailLevel: none Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
# Returns: 'xs:int'
Contains an array of refunds. Applicable to Half.com (for GetOrders).
# Argument: 'ns:RefundArrayType'
Calls: GetOrders Returned: Conditionally Details: DetailLevel: none
# Returns: 'ns:RefundArrayType'
Indicates whether the buyer has opted to accept emails from all the seller(s) in the Shopping.com shopping cart. Only returned for transactions made on Shopping.com using the Shopping.com shopping cart.
Specifies the transaction's payment status, as seen by the seller. Returned in lists of sold items. Not applicable to Half.com.
Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList
Not applicable to Half.com.
# Argument: 'ns:SellingManagerProductDetailsType'
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
# Returns: 'ns:SellingManagerProductDetailsType'
Indicates the time when the item(s) associated with the transaction were marked as shipped, if known. The value is set when the seller uses shipment tracking features offered by eBay or an eBay partner. This value is also set when the seller marks the item as shipped by using CompleteSale. If the seller is a Selling Manager Pro user, they can also mark the item as shipped by using My eBay. Note that this value is only visible if the request user is the buyer or seller associated with the transaction. Applicable to Half.com (for GetOrders).
Calls: GetOrders Returned: Always Details: DetailLevel: none Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. For GetOrders, also applicable to Half.com. For GetOrders, minimal ShippingDetails information is returned under the Transaction container.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Shipping Title: Shipping
# Argument: 'ns:ShippingDetailsType'
# Returns: 'ns:ShippingDetailsType'
The shipping service selected by the buyer from the services offered by the seller. Not applicable to Half.com.
# Argument: 'ns:ShippingServiceOptionsType'
# Returns: 'ns:ShippingServiceOptionsType'
Contains the status of the transaction, such as the buyer's online payment and whether the checkout process for the transaction has been completed. See TransactionStatusType for its child elements. Not applicable to Half.com.
# Argument: 'ns:TransactionStatusType'
Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetOrderTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetOrders Returned: Conditionally Details: DetailLevel: none Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList
# Returns: 'ns:TransactionStatusType'
Identifier for the transaction. A value of zero is used for the Chinese auction format. Thus, a value of zero is a valid transaction ID. A transaction ID is only unique to the listing that spawned it, so a transaction is only uniquely identified on a global basis by a combination of ItemID and TransactionID. Also applicable to Half.com (for GetOrders).
MaxLength: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.)
Calls: GetOrders Returned: Always Details: DetailLevel: none Calls: GetOrderTransactions Returned: Always Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList Calls: GetItemsAwaitingFeedback Returned: Conditionally Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Indicates the platform the item was purchased on (such as eBay or eBay Express). Not applicable to Half.com, even if the item was purchased on Express.
Calls: GetMyeBayBuying Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: WonList DeletedFromWonList Calls: GetMyeBaySelling Returned: Conditionally Details: DetailLevel: none, ReturnSummary, ReturnAll Context: SoldList DeletedFromSoldList Calls: GetItemTransactions GetSellerTransactions Returned: Always Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetOrderTransactions Returned: Always Details: DetailLevel: ReturnAll
Price of the transaction (before shipping and sales tax) that the buyer needs to pay to complete the purchase. Note that for GetItemTransactions and GetSellerTransactions, TransactionPrice is the per-item price for the transaction; transactions with TransactionArray.Transaction.QuantityPurchased of more than 1 have the same value for TransactionPrice as transactions with TransactionArray.Transaction.QuantityPurchased of 1. For eBay Motors, TransactionPrice is the deposit amount. Also applicable to Half.com (for GetOrders).
Calls: GetOrders Returned: Always Details: DetailLevel: none Calls: GetOrderTransactions Returned: Always Details: DetailLevel: none, ItemReturnDescription, ReturnAll Calls: GetItemTransactions GetSellerTransactions Returned: Conditionally Details: DetailLevel: none, ItemReturnDescription, ReturnAll
The site upon which the item transaction was made.
# Argument: 'ns:SiteCodeType'
# Returns: 'ns:SiteCodeType'
VAT rate for the item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max precision 3 decimal places. Max length 5 characters. Note: The View Item page displays the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Not applicable to Half.com.
# Argument: 'xs:decimal'
# Returns: 'xs:decimal'
To install eBay::API, copy and paste the appropriate command in to your terminal.
cpanm
cpanm eBay::API
CPAN shell
perl -MCPAN -e shell install eBay::API
For more information on module installation, please visit the detailed CPAN module installation guide.