Trading_GetItemTransactionsResponseType Class Reference
Inherits from | Trading_AbstractResponseType : NSObject |
Declared in | Trading_GetItemTransactionsResponseType.h Trading_GetItemTransactionsResponseType.m |
Overview
Returns an array of order line item (transaction) data for the item specified in the request.
The results can be used to create a report of data that is commonly
necessary for order processing.
Zero, one, or many Transaction objects can be returned in the TransactionArray.
The set of order line items returned is limited to those that were modified between
the times specified in the request’s ModTimeFrom and ModTime filters.
Also returns the Item object that spawned the order line items.
If pagination filters were specified in the request, returns meta-data describing
the effects of those filters on the current response and the estimated effects if
the same filters are used in subsequent calls.
Data from the TransactionArray may be used to trigger the following Platform
Notifications: EndOfAuction, AuctionCheckoutComplete, FixedPriceEndOfTransaction,
CheckoutBuyerRequestTotal, FixedPriceTransaction, Checkout,
FixedPriceTransactionForSeller, FixedPriceTransactionForBuyer, ItemMarkedAsShipped,
and ItemMarkedAsPaid. Each notification will be based on the state of the item
(a ‘snapshot’ of the item) at the time the order line item was created.
@ingroup EBayAPIInterface
Tasks
-
paginationResult
Contains the total number of pages (TotalNumberOfPages) and the total number
property
of entries (TotalNumberOfEntries) that could be returned given repeated calls
that use the same selection criteria as the call that returned this response. -
hasMoreTransactions
Indicates whether there are additional order line items (transactions) to retrieve.
property
That is, indicates whether more pages of data are available to be
returned, given the filters that were specified in the request.
Returns false for the last page of data. -
transactionsPerPage
Number of order line items (transactions) returned per page (per call). May be a higher value
property
than ReturnedTransactionCountActual if the page returned is the last page
and more than one page of data exists. -
pageNumber
Page number for the page of order line items the response returned.
property -
returnedTransactionCountActual
Number of order line items retrieved in the current page of results just returned.
property
May be a lower value than TransactionsPerPage if the page returned is the last
page and more than one page of data exists. -
item
Item object that spawned the order line item. It is a purchase from this item’s listing
property
that the order line item represents. -
transactionArray
List of Transaction objects representing the order line items resulting
property
from the listing. Each Transaction object contains the data for one purchase
(of one or more items in the same listing). The Transaction.Item field is not
returned because the Item object is returned at the root level of the response.
See the reference guide for more information about the fields that are returned. -
payPalPreferred
Indicates whether the item’s seller has the preference enabled that shows
property
that the seller prefers PayPal as the method of payment for an item. This
preference is indicated on an item’s View Item page and is intended to
influence a buyer to use PayPal
to pay for the item.
Properties
hasMoreTransactions
Indicates whether there are additional order line items (transactions) to retrieve.
That is, indicates whether more pages of data are available to be
returned, given the filters that were specified in the request.
Returns false for the last page of data.
@property (nonatomic, retain) NSNumber *hasMoreTransactions
Discussion
Indicates whether there are additional order line items (transactions) to retrieve.
That is, indicates whether more pages of data are available to be
returned, given the filters that were specified in the request.
Returns false for the last page of data.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetItemTransactionsResponseType.h
item
Item object that spawned the order line item. It is a purchase from this item’s listing
that the order line item represents.
@property (nonatomic, retain) Trading_ItemType *item
Discussion
Item object that spawned the order line item. It is a purchase from this item’s listing
that the order line item represents.
type : class Trading_ItemType
Declared In
Trading_GetItemTransactionsResponseType.h
pageNumber
Page number for the page of order line items the response returned.
@property (nonatomic, retain) NSNumber *pageNumber
Discussion
Page number for the page of order line items the response returned.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetItemTransactionsResponseType.h
paginationResult
Contains the total number of pages (TotalNumberOfPages) and the total number
of entries (TotalNumberOfEntries) that could be returned given repeated calls
that use the same selection criteria as the call that returned this response.
@property (nonatomic, retain) Trading_PaginationResultType *paginationResult
Discussion
Contains the total number of pages (TotalNumberOfPages) and the total number
of entries (TotalNumberOfEntries) that could be returned given repeated calls
that use the same selection criteria as the call that returned this response.
type : class Trading_PaginationResultType
Declared In
Trading_GetItemTransactionsResponseType.h
payPalPreferred
Indicates whether the item’s seller has the preference enabled that shows
that the seller prefers PayPal as the method of payment for an item. This
preference is indicated on an item’s View Item page and is intended to
influence a buyer to use PayPal
to pay for the item.
@property (nonatomic, retain) NSNumber *payPalPreferred
Discussion
Indicates whether the item’s seller has the preference enabled that shows
that the seller prefers PayPal as the method of payment for an item. This
preference is indicated on an item’s View Item page and is intended to
influence a buyer to use PayPal
to pay for the item.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetItemTransactionsResponseType.h
returnedTransactionCountActual
Number of order line items retrieved in the current page of results just returned.
May be a lower value than TransactionsPerPage if the page returned is the last
page and more than one page of data exists.
@property (nonatomic, retain) NSNumber *returnedTransactionCountActual
Discussion
Number of order line items retrieved in the current page of results just returned.
May be a lower value than TransactionsPerPage if the page returned is the last
page and more than one page of data exists.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetItemTransactionsResponseType.h
transactionArray
List of Transaction objects representing the order line items resulting
from the listing. Each Transaction object contains the data for one purchase
(of one or more items in the same listing). The Transaction.Item field is not
returned because the Item object is returned at the root level of the response.
See the reference guide for more information about the fields that are returned.
@property (nonatomic, retain) Trading_TransactionArrayType *transactionArray
Discussion
List of Transaction objects representing the order line items resulting
from the listing. Each Transaction object contains the data for one purchase
(of one or more items in the same listing). The Transaction.Item field is not
returned because the Item object is returned at the root level of the response.
See the reference guide for more information about the fields that are returned.
type : class Trading_TransactionArrayType
Declared In
Trading_GetItemTransactionsResponseType.h
transactionsPerPage
Number of order line items (transactions) returned per page (per call). May be a higher value
than ReturnedTransactionCountActual if the page returned is the last page
and more than one page of data exists.
@property (nonatomic, retain) NSNumber *transactionsPerPage
Discussion
Number of order line items (transactions) returned per page (per call). May be a higher value
than ReturnedTransactionCountActual if the page returned is the last page
and more than one page of data exists.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetItemTransactionsResponseType.h