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-bid item listings). A listing can spawn one or more transactions in these cases: multi-item fixed-price listings and Dutch listings. Single-item fixed-price listings and Chinese listings can spawn only a single transaction.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.

Types that use TransactionType:

Calls that use one or more fields of TransactionType:

Fields

AdjustmentAmount ( AmountType (double) )
AmountPaid ( AmountType (double) )
BestOfferSale ( boolean )
Buyer ( UserType )
BuyerCheckoutMessage ( string )
BuyerGuaranteePrice ( AmountType (double) )
BuyerMessage
BuyerPaidStatus ( PaidStatusCodeType )
CartID ( string )
ContainingOrder ( OrderType )
ConvertedAdjustmentAmount ( AmountType (double) )
ConvertedAmountPaid ( AmountType (double) )
ConvertedTransactionPrice ( AmountType (double) )
CreatedDate ( dateTime )
DepositType ( DepositTypeCodeType )
DutchAuctionBid
ExternalTransaction ( ExternalTransactionType )
FeedbackLeft ( FeedbackInfoType )
FeedbackReceived ( FeedbackInfoType )
FinalValueFee ( AmountType (double) )
Item ( ItemType )
ListingCheckoutRedirectPreference ( ListingCheckoutRedirectPreferenceType )
PaidTime ( dateTime )
PaisaPayID ( string )
PayPalEmailAddress ( string )
Platform ( TransactionPlatformCodeType )
QuantityPurchased ( int )
RefundArray ( RefundArrayType )
SellerContactBuyerByEmail ( boolean )
SellerPaidStatus ( PaidStatusCodeType )
SellingManagerProductDetails ( SellingManagerProductDetailsType )
ShippedTime ( dateTime )
ShippingDetails ( ShippingDetailsType )
ShippingServiceSelected ( ShippingServiceOptionsType )
Status ( TransactionStatusType )
TotalPrice ( AmountType (double) )
TransactionID ( string )
TransactionPrice ( AmountType (double) )
TransactionSiteID ( SiteCodeType )
Variation ( VariationType )
VATPercent

AdjustmentAmount ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use AdjustmentAmount.

AmountPaid ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use AmountPaid.

BestOfferSale ( boolean ) [0..1]
Whether the transaction was completed with the seller selecting a best offer.

Not applicable to Half.com.
See the Field Index to learn which calls use BestOfferSale.

Buyer ( UserType ) [0..1]
Contains the data for the transaction's buyer. See UserType for its child elements. Returned by GetItemsAwaitingFeedback if Seller is making the request.

Applicable to Half.com (for GetOrders only).
See the Field Index to learn which calls use Buyer.

BuyerCheckoutMessage ( string ) [0..1]
The Comment left by buyer during checkout.
See the Field Index to learn which calls use BuyerCheckoutMessage.

BuyerGuaranteePrice ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use BuyerGuaranteePrice.

BuyerMessage
Not used by any call.

BuyerPaidStatus ( see PaidStatusCodeType for possible values ) [0..1]
Specifies the transaction's paid status, as seen by the buyer. Returned in lists of won items.

Not applicable to Half.com.
See the Field Index to learn which calls use BuyerPaidStatus.

CartID ( string ) [0..1]
Shopping cart identifier. Only returned for transactions made on Shopping.com using the Shopping.com shopping cart.
See the Field Index to learn which calls use CartID.

ContainingOrder ( OrderType ) [0..1]
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.
See the Field Index to learn which calls use ContainingOrder.

ConvertedAdjustmentAmount ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use ConvertedAdjustmentAmount.

ConvertedAmountPaid ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use ConvertedAmountPaid.

ConvertedTransactionPrice ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use ConvertedTransactionPrice.

CreatedDate ( dateTime ) [0..1]
Indicates when the transaction was created. For fixed-price, Stores, and BIN items this indicates when the purchase (or BIN) occurred. For competitive-bid item listing types this indicates when listing ended, the winning bidder(s) determined, and the transaction created.

Applicable to Half.com (for GetOrders only).
See the Field Index to learn which calls use CreatedDate.

DepositType ( see DepositTypeCodeType for possible values ) [0..1]
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.
See the Field Index to learn which calls use DepositType.

DutchAuctionBid
Not used by any call.

ExternalTransaction ( ExternalTransactionType ) [0..*]
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.
See the Field Index to learn which calls use ExternalTransaction.

FeedbackLeft ( FeedbackInfoType ) [0..1]
A container for feedback information left FOR the user's transaction partner. Only returned if feedback was left for a transaction.

Not applicable to Half.com.
See the Field Index to learn which calls use FeedbackLeft.

FeedbackReceived ( FeedbackInfoType ) [0..1]
A container for feedback information left BY the user's transaction partner. Only returned if feedback was left for a transaction.

Not applicable to Half.com.
See the Field Index to learn which calls use FeedbackReceived.

FinalValueFee ( AmountType (double) ) [0..1]
You are charged a Final Value Fee (FVF) 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. The Final Value Fee is returned in Transaction.FinalValueFee. See the eBay.com Web site online help for more information about the Final Value Fee.

The Final Value Fee for fixed price format (FixedPriceItem) and Store Inventory (StoresFixedPrice) items is returned by GetSellerTransactions, GetItemTransactions, and GetOrderTransactions on a transaction-by-transaction basis, regardless of the listing status. For all other listing types, (excluding Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed.

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.)

Not applicable to Half.com.

If the item was a Dutch auction that ended with bids (not Buy It Now purchases), the Final Value Fee is returned on a transaction-by-transaction basis in Item.SellingStatus.FinalValueFee.

Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1.
See the Field Index to learn which calls use FinalValueFee.

Item ( ItemType ) [0..1]
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.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Item.

ListingCheckoutRedirectPreference ( ListingCheckoutRedirectPreferenceType ) [0..1]
ProStores listing level preferences regarding the store to which checkout should be redirected for the listing if ThirdPartyCheckout is true.
See the Field Index to learn which calls use ListingCheckoutRedirectPreference.

PaidTime ( dateTime ) [0..1]
Indicates the time when the transaction was marked paid. There are many ways to mark a transaction as paid. eBay sets it when payment is made via PayPal. A seller can mark an item as paid in My eBay or Selling Manager Pro. An application can use ReviseCheckoutStatus or CompleteSale on behalf of the seller. Note: This value is only visible to the user if the request user is the buyer or seller associated with the transaction.

Not applicable to Half.com.
See the Field Index to learn which calls use PaidTime.

PaisaPayID ( string ) [0..1]
Specifies the PaisaPayID using which the Item was paid for. Applicable for India site(203) only.
See the Field Index to learn which calls use PaisaPayID.

PayPalEmailAddress ( string ) [0..1]
The seller's Paypal email address.
See the Field Index to learn which calls use PayPalEmailAddress.

Platform ( see TransactionPlatformCodeType for possible values ) [0..1]
Name of the eBay co-branded site upon which the transaction was made.
See the Field Index to learn which calls use Platform.

QuantityPurchased ( int ) [0..1]
Indicates the number of items the buyer purchased from the listing identified in ItemID.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use QuantityPurchased.

RefundArray ( RefundArrayType ) [0..1]
Contains an array of refunds. Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use RefundArray.

SellerContactBuyerByEmail ( boolean ) [0..1]
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.
See the Field Index to learn which calls use SellerContactBuyerByEmail.

SellerPaidStatus ( see PaidStatusCodeType for possible values ) [0..1]
Specifies the transaction's payment status, as seen by the seller. Returned in lists of sold items.

Not applicable to Half.com.
See the Field Index to learn which calls use SellerPaidStatus.

SellingManagerProductDetails ( SellingManagerProductDetailsType ) [0..1]
Not applicable to Half.com.
See the Field Index to learn which calls use SellingManagerProductDetails.

ShippedTime ( dateTime ) [0..1]
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 only).
See the Field Index to learn which calls use ShippedTime.

ShippingDetails ( ShippingDetailsType ) [0..1]
The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. For GetOrders, minimal ShippingDetails information is returned under the Transaction container.

Applicable to Half.com (for GetOrders only).
See the Field Index to learn which calls use ShippingDetails.

ShippingServiceSelected ( ShippingServiceOptionsType ) [0..1]
The shipping service selected by the buyer from the services offered by the seller.

Not applicable to Half.com.
See the Field Index to learn which calls use ShippingServiceSelected.

Status ( TransactionStatusType ) [0..1]
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.
See the Field Index to learn which calls use Status.

TotalPrice ( AmountType (double) ) [0..1]
Not applicable to Half.com.
See the Field Index to learn which calls use TotalPrice.

TransactionID ( string ) [0..1]
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.

Applicable to Half.com (for GetOrders only).
See the Field Index to learn which calls use TransactionID.

TransactionPrice ( AmountType (double) ) [0..1]
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.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use TransactionPrice.

TransactionSiteID ( see SiteCodeType for possible values ) [0..1]
The site upon which the item transaction was made.
See the Field Index to learn which calls use TransactionSiteID.

Variation ( VariationType ) [0..1]
Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) listing. For example, a single listing could contain multiple items of the same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and price.

When a user purchases items from a multi-variation listing, this Variation node contains information about which variation was purchased. Therefore, applications that process transactions should always check to see if this node is present. A single transaction can contain items from only one variation.
See the Field Index to learn which calls use Variation.

VATPercent
Not used by any call.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.