Trading_GetSellerTransactionsResponseType Class Reference
Inherits from | Trading_AbstractResponseType : NSObject |
Declared in | Trading_GetSellerTransactionsResponseType.h Trading_GetSellerTransactionsResponseType.m |
Overview
Returns an array of order line item (transaction) data for the seller 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 ModTimeTo filters.
The order line items returned are sorted by Transaction.Status.LastTimeModified,
ascending order (that is, order line items that more recently were modified are returned last).
Also returns information about the seller whose order line items were requested.
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.
@ingroup EBayAPIInterface
Tasks
-
paginationResult
Container consisting of the total number of order line items that match the input
property
criteria and the total number of pages that must be scrolled through to view all order
line items. To scroll through each page of order line item data, make subsequent
GetSellerTransactions calls, incrementing the Pagination.PageNumber
field by a value of ‘1’ each time. -
hasMoreTransactions
This flag indicates whether there are additional pages of order line items to view.
property
This field will be returned as ‘true’ if there are additional pages or order line items
to view, or ‘false’ if the current page of order line item data is the last page of
data. -
transactionsPerPage
This value indicates the number of order line items returned per page (per call) and is
property
controlled by the Pagination.EntriesPerPage value passed in the call
request. Unless it is the last (or possibly only) page of data (HasMoreTransactions=false),
the TransactionsPerPage value should equal the
Pagination.EntriesPerPage value passed in the call request.
Note:
Due to the fact that item data on the eBay platform has a shorter retention period than
order data, it is possible that some retrieved pages will contain no data. For pages
that contain no data, the ReturnedTransactionCountActual value will
be ‘0’. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do
have data. Therefore, we recommend that you scroll through each page of data (making
subsequent GetSellerTransactions calls and incrementing the
Pagination.PageNumber value by ‘1’ each time) until you reach the
last page, indicated by HasMoreTransactions=false.
-
pageNumber
This value indicates the page number of retrieved order line items that match the input
property
criteria. This value is controlled by the Pagination.PageNumber
value passed in the call request. To scroll through all pages of order line items that match the
input criteria, you increment the Pagination.PageNumber value by ‘1'
with each subsequent GetSellerTransactions call. -
returnedTransactionCountActual
This value indicates the total number of (non-empty) order line items retrieved in the
property
current page of results. The ReturnedTransactionCountActual value
will be lower than the TransactionsPerPage value if one or more
empty order line items are retreived on the page.
Note:
Due to the fact that item data on the eBay platform has a shorter retention period than
order data, it is possible that some retrieved pages will contain no data. For pages
that contain no order line item data, the ReturnedTransactionCountActual value will
be ‘0’. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do
have data. Therefore, we recommend that you scroll through each page of data (making
subsequent GetSellerTransactions calls and incrementing the
Pagination.PageNumber value by ‘1’ each time) until you reach the
last page, indicated by HasMoreTransactions=false.
-
seller
Contains information about the seller whose order line items are being returned.
property
See the reference guide for information about the Seller object fields
that are returned. -
transactionArray
List of Transaction objects representing the seller’s recent sales.
property
Each Transaction object contains the data for one purchase
(of one or more items in the same listing).
See the reference guide for more information about the fields that are returned
for each order line item. -
payPalPreferred
Indicates whether the seller has the preference enabled that shows that the seller
property
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
This flag indicates whether there are additional pages of order line items to view.
This field will be returned as ‘true’ if there are additional pages or order line items
to view, or ‘false’ if the current page of order line item data is the last page of
data.
@property (nonatomic, retain) NSNumber *hasMoreTransactions
Discussion
This flag indicates whether there are additional pages of order line items to view.
This field will be returned as ‘true’ if there are additional pages or order line items
to view, or ‘false’ if the current page of order line item data is the last page of
data.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerTransactionsResponseType.h
pageNumber
This value indicates the page number of retrieved order line items that match the input
criteria. This value is controlled by the Pagination.PageNumber
value passed in the call request. To scroll through all pages of order line items that match the
input criteria, you increment the Pagination.PageNumber value by ‘1'
with each subsequent GetSellerTransactions call.
@property (nonatomic, retain) NSNumber *pageNumber
Discussion
This value indicates the page number of retrieved order line items that match the input
criteria. This value is controlled by the Pagination.PageNumber
value passed in the call request. To scroll through all pages of order line items that match the
input criteria, you increment the Pagination.PageNumber value by ‘1'
with each subsequent GetSellerTransactions call.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetSellerTransactionsResponseType.h
paginationResult
Container consisting of the total number of order line items that match the input
criteria and the total number of pages that must be scrolled through to view all order
line items. To scroll through each page of order line item data, make subsequent
GetSellerTransactions calls, incrementing the Pagination.PageNumber
field by a value of ‘1’ each time.
@property (nonatomic, retain) Trading_PaginationResultType *paginationResult
Discussion
Container consisting of the total number of order line items that match the input
criteria and the total number of pages that must be scrolled through to view all order
line items. To scroll through each page of order line item data, make subsequent
GetSellerTransactions calls, incrementing the Pagination.PageNumber
field by a value of ‘1’ each time.
type : class Trading_PaginationResultType
Declared In
Trading_GetSellerTransactionsResponseType.h
payPalPreferred
Indicates whether the 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 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_GetSellerTransactionsResponseType.h
returnedTransactionCountActual
This value indicates the total number of (non-empty) order line items retrieved in the
current page of results. The ReturnedTransactionCountActual value
will be lower than the TransactionsPerPage value if one or more
empty order line items are retreived on the page.
Note:
Due to the fact that item data on the eBay platform has a shorter retention period than
order data, it is possible that some retrieved pages will contain no data. For pages
that contain no order line item data, the ReturnedTransactionCountActual value will
be ‘0’. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do
have data. Therefore, we recommend that you scroll through each page of data (making
subsequent GetSellerTransactions calls and incrementing the
Pagination.PageNumber value by ‘1’ each time) until you reach the
last page, indicated by HasMoreTransactions=false.
@property (nonatomic, retain) NSNumber *returnedTransactionCountActual
Discussion
This value indicates the total number of (non-empty) order line items retrieved in the
current page of results. The ReturnedTransactionCountActual value
will be lower than the TransactionsPerPage value if one or more
empty order line items are retreived on the page.
Note:
Due to the fact that item data on the eBay platform has a shorter retention period than
order data, it is possible that some retrieved pages will contain no data. For pages
that contain no order line item data, the ReturnedTransactionCountActual value will
be ‘0’. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do
have data. Therefore, we recommend that you scroll through each page of data (making
subsequent GetSellerTransactions calls and incrementing the
Pagination.PageNumber value by ‘1’ each time) until you reach the
last page, indicated by HasMoreTransactions=false.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetSellerTransactionsResponseType.h
seller
Contains information about the seller whose order line items are being returned.
See the reference guide for information about the Seller object fields
that are returned.
@property (nonatomic, retain) Trading_UserType *seller
Discussion
Contains information about the seller whose order line items are being returned.
See the reference guide for information about the Seller object fields
that are returned.
type : class Trading_UserType
Declared In
Trading_GetSellerTransactionsResponseType.h
transactionArray
List of Transaction objects representing the seller’s recent sales.
Each Transaction object contains the data for one purchase
(of one or more items in the same listing).
See the reference guide for more information about the fields that are returned
for each order line item.
@property (nonatomic, retain) Trading_TransactionArrayType *transactionArray
Discussion
List of Transaction objects representing the seller’s recent sales.
Each Transaction object contains the data for one purchase
(of one or more items in the same listing).
See the reference guide for more information about the fields that are returned
for each order line item.
type : class Trading_TransactionArrayType
Declared In
Trading_GetSellerTransactionsResponseType.h
transactionsPerPage
This value indicates the number of order line items returned per page (per call) and is
controlled by the Pagination.EntriesPerPage value passed in the call
request. Unless it is the last (or possibly only) page of data (HasMoreTransactions=false),
the TransactionsPerPage value should equal the
Pagination.EntriesPerPage value passed in the call request.
Note:
Due to the fact that item data on the eBay platform has a shorter retention period than
order data, it is possible that some retrieved pages will contain no data. For pages
that contain no data, the ReturnedTransactionCountActual value will
be ‘0’. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do
have data. Therefore, we recommend that you scroll through each page of data (making
subsequent GetSellerTransactions calls and incrementing the
Pagination.PageNumber value by ‘1’ each time) until you reach the
last page, indicated by HasMoreTransactions=false.
@property (nonatomic, retain) NSNumber *transactionsPerPage
Discussion
This value indicates the number of order line items returned per page (per call) and is
controlled by the Pagination.EntriesPerPage value passed in the call
request. Unless it is the last (or possibly only) page of data (HasMoreTransactions=false),
the TransactionsPerPage value should equal the
Pagination.EntriesPerPage value passed in the call request.
Note:
Due to the fact that item data on the eBay platform has a shorter retention period than
order data, it is possible that some retrieved pages will contain no data. For pages
that contain no data, the ReturnedTransactionCountActual value will
be ‘0’. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do
have data. Therefore, we recommend that you scroll through each page of data (making
subsequent GetSellerTransactions calls and incrementing the
Pagination.PageNumber value by ‘1’ each time) until you reach the
last page, indicated by HasMoreTransactions=false.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetSellerTransactionsResponseType.h