Trading_GetItemTransactionsRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetItemTransactionsRequestType.h Trading_GetItemTransactionsRequestType.m |
Overview
Retrieves order line item (transaction) information for a specified ItemID. &
nbsp;Also for Half.com. The call returns zero, one, or
multiple order line items, depending on the number of items sold from the listing.
You can retrieve order line item data for a specific time range or
number of days. If you don’t specify a range or number of days, order line item
data will be returned for the past 30 days.
@ingroup EBayAPIInterface
Tasks
-
itemID
Unique identifier for an eBay item listing. A listing can have multiple
property
order line items (transactions), but only one ItemID. When you use
ItemID alone, eBay returns all order line items that are associated with
the ItemID (listing). If you pair ItemID with a specific TransactionID,
data on a specific order line item is returned. If OrderLineItemID is
specified in the request, any ItemID/TransactionID pair specified in the
same request will be ignored.
Note:
GetItemTransactions doesn’t support SKU as an input because this
call requires an identifier that is unique across your active
and ended listings. Even when InventoryTrackingMethod is set to
SKU in a listing, the SKU is only unique across your active
listings (not your ended listings). To retrieve order line items
by SKU, use GetSellerTransactions or GetOrderTransactions instead.
-
modTimeFrom
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
property
order line items associated with the specified ItemID. The ModTimeFrom
field is the starting date range. All eBay order line items that were
last modified within this date range are returned in the output. The
maximum date range that may be specified is 30 days. This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request or if the NumberOfDays date filter is used.
If you don’t specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
time filter is used and it defaults to 30 (days). -
modTimeTo
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
property
order line items associated with the specified ItemID. The ModTimeTo
field is the ending date range. All eBay order line items that were last
modified within this date range are returned in the output. The maximum
date range that may be specified is 30 days. If the ModTimeFrom field is
used and the ModTimeTo field is omitted, the ModTimeTo value defaults to
the present time or to 30 days past the ModTimeFrom value (if
ModTimeFrom value is more than 30 days in the past). This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request or if the NumberOfDays date filter is used.
If you don’t specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
time filter is used and it defaults to 30 (days). -
transactionID
Include a TransactionID field in the request if you want to retrieve the
property
data for a specific order line item (transaction). If a TransactionID is
provided, any specified time filter is ignored. -
pagination
Child elements control pagination of the output. Use the EntriesPerPage
property
property to control the number of order line items to
return per call and the PageNumber property to specify the specific page
of data to return. If multiple pages of order line items are returned
based on input criteria and Pagination properties, GetItemTransactions
will need to be called multiple times (with the PageNumber value being
increased by 1 each time) to scroll through all results. -
includeFinalValueFee
Indicates whether to include the Final Value Fee (FVF) for all order
property
line items in the response. The Final Value Fee is
returned in the Transaction.FinalValueFee field. The Final Value Fee is
assessed right after the creation of an order line item. -
includeContainingOrder
Include this field and set it to True if you want the ContainingOrder
property
container to be returned in the response under each Transaction node.
For single line item orders, the ContainingOrder.OrderID value takes the
value of the OrderLineItemID value for the order line item. For Combined
Payment orders, the ContainingOrder.OrderID value will be shared by at
least two order line items (transactions) that are part of the same order. -
platform
Name of the eBay co-branded site upon which the order line item
property
was created. This filter can be used to limit the number
of results that are returned. -
numberOfDays
This time filter specifies the number of days (24-hour periods) in the
property
past to search for order line items. All eBay order line items that were
either created or modified within this period are returned in the
response. If specified, NumberOfDays will override any date range
specified with the ModTimeFrom/ModTimeTo time filters. This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request. -
includeVariations
If included in the request and set to True, all variations defined for
property
the item are returned at the root level, including variations
that have no sales. If not included in the request or set to false, the
variations with sales are still returned in separate Transaction nodes. This information is intended to help sellers to reconcile their
local inventory with eBay’s records, while processing order line items
(without requiring a separate call to GetItem). -
orderLineItemID
A unique identifier for an eBay order line item. This field is created
property
as soon as there is a commitment to buy from the seller, and its value
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. If you want to retrieve data on a
specific order line item, you can use an OrderLineItemID value in the
request instead of the ItemID/TransactionID pair. If an OrderLineItemID is
provided, any specified time filter is ignored.
Properties
includeContainingOrder
Include this field and set it to True if you want the ContainingOrder
container to be returned in the response under each Transaction node.
For single line item orders, the ContainingOrder.OrderID value takes the
value of the OrderLineItemID value for the order line item. For Combined
Payment orders, the ContainingOrder.OrderID value will be shared by at
least two order line items (transactions) that are part of the same order.
@property (nonatomic, retain) NSNumber *includeContainingOrder
Discussion
Include this field and set it to True if you want the ContainingOrder
container to be returned in the response under each Transaction node.
For single line item orders, the ContainingOrder.OrderID value takes the
value of the OrderLineItemID value for the order line item. For Combined
Payment orders, the ContainingOrder.OrderID value will be shared by at
least two order line items (transactions) that are part of the same order.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetItemTransactionsRequestType.h
includeFinalValueFee
Indicates whether to include the Final Value Fee (FVF) for all order
line items in the response. The Final Value Fee is
returned in the Transaction.FinalValueFee field. The Final Value Fee is
assessed right after the creation of an order line item.
@property (nonatomic, retain) NSNumber *includeFinalValueFee
Discussion
Indicates whether to include the Final Value Fee (FVF) for all order
line items in the response. The Final Value Fee is
returned in the Transaction.FinalValueFee field. The Final Value Fee is
assessed right after the creation of an order line item.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetItemTransactionsRequestType.h
includeVariations
If included in the request and set to True, all variations defined for
the item are returned at the root level, including variations
that have no sales. If not included in the request or set to false, the
variations with sales are still returned in separate Transaction nodes. This information is intended to help sellers to reconcile their
local inventory with eBay’s records, while processing order line items
(without requiring a separate call to GetItem).
@property (nonatomic, retain) NSNumber *includeVariations
Discussion
If included in the request and set to True, all variations defined for
the item are returned at the root level, including variations
that have no sales. If not included in the request or set to false, the
variations with sales are still returned in separate Transaction nodes. This information is intended to help sellers to reconcile their
local inventory with eBay’s records, while processing order line items
(without requiring a separate call to GetItem).
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetItemTransactionsRequestType.h
itemID
Unique identifier for an eBay item listing. A listing can have multiple
order line items (transactions), but only one ItemID. When you use
ItemID alone, eBay returns all order line items that are associated with
the ItemID (listing). If you pair ItemID with a specific TransactionID,
data on a specific order line item is returned. If OrderLineItemID is
specified in the request, any ItemID/TransactionID pair specified in the
same request will be ignored.
Note:
GetItemTransactions doesn’t support SKU as an input because this
call requires an identifier that is unique across your active
and ended listings. Even when InventoryTrackingMethod is set to
SKU in a listing, the SKU is only unique across your active
listings (not your ended listings). To retrieve order line items
by SKU, use GetSellerTransactions or GetOrderTransactions instead.
@property (nonatomic, retain) NSString *itemID
Discussion
Unique identifier for an eBay item listing. A listing can have multiple
order line items (transactions), but only one ItemID. When you use
ItemID alone, eBay returns all order line items that are associated with
the ItemID (listing). If you pair ItemID with a specific TransactionID,
data on a specific order line item is returned. If OrderLineItemID is
specified in the request, any ItemID/TransactionID pair specified in the
same request will be ignored.
Note:
GetItemTransactions doesn’t support SKU as an input because this
call requires an identifier that is unique across your active
and ended listings. Even when InventoryTrackingMethod is set to
SKU in a listing, the SKU is only unique across your active
listings (not your ended listings). To retrieve order line items
by SKU, use GetSellerTransactions or GetOrderTransactions instead.
type : NSString, wrapper for primitive string
Declared In
Trading_GetItemTransactionsRequestType.h
modTimeFrom
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
order line items associated with the specified ItemID. The ModTimeFrom
field is the starting date range. All eBay order line items that were
last modified within this date range are returned in the output. The
maximum date range that may be specified is 30 days. This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request or if the NumberOfDays date filter is used.
If you don’t specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
time filter is used and it defaults to 30 (days).
@property (nonatomic, retain) NSDate *modTimeFrom
Discussion
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
order line items associated with the specified ItemID. The ModTimeFrom
field is the starting date range. All eBay order line items that were
last modified within this date range are returned in the output. The
maximum date range that may be specified is 30 days. This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request or if the NumberOfDays date filter is used.
If you don’t specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
time filter is used and it defaults to 30 (days).
type : NSDate, wrapper for primitive date
Declared In
Trading_GetItemTransactionsRequestType.h
modTimeTo
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
order line items associated with the specified ItemID. The ModTimeTo
field is the ending date range. All eBay order line items that were last
modified within this date range are returned in the output. The maximum
date range that may be specified is 30 days. If the ModTimeFrom field is
used and the ModTimeTo field is omitted, the ModTimeTo value defaults to
the present time or to 30 days past the ModTimeFrom value (if
ModTimeFrom value is more than 30 days in the past). This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request or if the NumberOfDays date filter is used.
If you don’t specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
time filter is used and it defaults to 30 (days).
@property (nonatomic, retain) NSDate *modTimeTo
Discussion
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
order line items associated with the specified ItemID. The ModTimeTo
field is the ending date range. All eBay order line items that were last
modified within this date range are returned in the output. The maximum
date range that may be specified is 30 days. If the ModTimeFrom field is
used and the ModTimeTo field is omitted, the ModTimeTo value defaults to
the present time or to 30 days past the ModTimeFrom value (if
ModTimeFrom value is more than 30 days in the past). This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request or if the NumberOfDays date filter is used.
If you don’t specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
time filter is used and it defaults to 30 (days).
type : NSDate, wrapper for primitive date
Declared In
Trading_GetItemTransactionsRequestType.h
numberOfDays
This time filter specifies the number of days (24-hour periods) in the
past to search for order line items. All eBay order line items that were
either created or modified within this period are returned in the
response. If specified, NumberOfDays will override any date range
specified with the ModTimeFrom/ModTimeTo time filters. This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request.
@property (nonatomic, retain) NSNumber *numberOfDays
Discussion
This time filter specifies the number of days (24-hour periods) in the
past to search for order line items. All eBay order line items that were
either created or modified within this period are returned in the
response. If specified, NumberOfDays will override any date range
specified with the ModTimeFrom/ModTimeTo time filters. This field is not
applicable if a specific TransactionID or OrderLineItemID is included in
the request.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetItemTransactionsRequestType.h
orderLineItemID
A unique identifier for an eBay order line item. This field is created
as soon as there is a commitment to buy from the seller, and its value
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. If you want to retrieve data on a
specific order line item, you can use an OrderLineItemID value in the
request instead of the ItemID/TransactionID pair. If an OrderLineItemID is
provided, any specified time filter is ignored.
@property (nonatomic, retain) NSString *orderLineItemID
Discussion
A unique identifier for an eBay order line item. This field is created
as soon as there is a commitment to buy from the seller, and its value
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs. If you want to retrieve data on a
specific order line item, you can use an OrderLineItemID value in the
request instead of the ItemID/TransactionID pair. If an OrderLineItemID is
provided, any specified time filter is ignored.
type : NSString, wrapper for primitive string
Declared In
Trading_GetItemTransactionsRequestType.h
pagination
Child elements control pagination of the output. Use the EntriesPerPage
property to control the number of order line items to
return per call and the PageNumber property to specify the specific page
of data to return. If multiple pages of order line items are returned
based on input criteria and Pagination properties, GetItemTransactions
will need to be called multiple times (with the PageNumber value being
increased by 1 each time) to scroll through all results.
@property (nonatomic, retain) Trading_PaginationType *pagination
Discussion
Child elements control pagination of the output. Use the EntriesPerPage
property to control the number of order line items to
return per call and the PageNumber property to specify the specific page
of data to return. If multiple pages of order line items are returned
based on input criteria and Pagination properties, GetItemTransactions
will need to be called multiple times (with the PageNumber value being
increased by 1 each time) to scroll through all results.
type : class Trading_PaginationType
Declared In
Trading_GetItemTransactionsRequestType.h
platform
Name of the eBay co-branded site upon which the order line item
was created. This filter can be used to limit the number
of results that are returned.
@property (nonatomic, retain) NSString *platform
Discussion
Name of the eBay co-branded site upon which the order line item
was created. This filter can be used to limit the number
of results that are returned.
type: string constant in Trading_TransactionPlatformCodeType.h
Declared In
Trading_GetItemTransactionsRequestType.h
transactionID
Include a TransactionID field in the request if you want to retrieve the
data for a specific order line item (transaction). If a TransactionID is
provided, any specified time filter is ignored.
@property (nonatomic, retain) NSString *transactionID
Discussion
Include a TransactionID field in the request if you want to retrieve the
data for a specific order line item (transaction). If a TransactionID is
provided, any specified time filter is ignored.
type : NSString, wrapper for primitive string
Declared In
Trading_GetItemTransactionsRequestType.h