complexType "GetItemTransactionsRequestType"

Component	Type / Value	Occurs	Required?	Nillable?	Description
SEQUENCE		1..1	yes
DetailLevel	DetailLevelCodeType : enumeration of token	0..∞	no	no	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. »
ErrorLanguage	string	0..1	no	no	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. »
MessageID	string	0..1	no	no	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »
Version	string	0..1	no	no	The version number of the API code that you are programming against (e.g., 1149). »
EndUserIP	string	0..1	no	no	The public IP address of the machine from which the request is sent. »
ErrorHandling	ErrorHandlingCodeType : enumeration of token	0..1	no	no	Error tolerance level for the call. »
InvocationID	UUIDType : restriction of string	0..1	no	no	A unique identifier for a particular call. »
OutputSelector	string	0..∞	no	no	You can use the OutputSelector field to restrict the data returned by a call. »
WarningLevel	WarningLevelCodeType : enumeration of token	0..1	no	no	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. »
BotBlock	BotBlockRequestType	0..1	no	no	This container is only used by the PlaceOffer call request if the previous PlaceOffer call resulted in a BotBlock container in the response. »
{any}	from any namespace	0..∞	no
ItemID	ItemIDType : restriction of string	0..1	no	no	Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID. When you use ItemID alone, eBay returns all order line items that are associated with the ItemID. If you pair ItemID with a specific TransactionID, data on a specific order line item is returned. An OrderLineItemID value can be used instead of an ItemID/TransactionID pair to identify an order line item, and if an OrderLineItemID is specified in the request, any ItemID/TransactionID pair specified in the same request is 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 instead.
ModTimeFrom	dateTime	0..1	no	no	The ModTimeFrom and ModTimeTo fields are used to retrieve order line items that were created or modified within a specified date range. The ModTimeFrom field is the starting date range. All of the listing's order line items that were generated or modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. The maximum date range that may be specified is 30 days. This field is not applicable (and is ignored) if the user is looking for a specific order line item by either using an ItemID/TransactionID pair, or an OrderLineItemID value. Note: Please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned.
ModTimeTo	dateTime	0..1	no	no	The ModTimeFrom and ModTimeTo fields are used to retrieve order line items that were created or modified within a specified date range. The ModTimeTo field is the ending date range. All eBay order line items that were generated (or 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 after the date specified with the ModTimeFrom value (if ModTimeFrom value is more than 30 days in the past). This field is not applicable (and is ignored) if the user is looking for a specific order line item by either using an ItemID/TransactionID pair, or an OrderLineItemID value. Note: Please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned.
TransactionID	string	0..1	no	no	Include a TransactionID field in the request if you want to retrieve the data for a specific order line item for the listing specified in the ItemID field. This field is really only applicable for a multiple-quantity or multiple-variation, fixed-price listing that may have multiple sales. An auction listing or a single-quantity, fixed-price listing will only result in one order line item, so this field is not needed in these two cases. If an OrderLineItemID value is used instead to identify an order line item, this field is ignored. If this field is used, any specified date filter is ignored. The TransactionID value for auction listings is always `0` since there can be only one winning bidder/one sale for an auction listing.
Pagination	PaginationType	0..1	no	no	This container controls how many order line items should be returned per page of data, as well as which page of data to return (if there are multiple pages of order line items). 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.
IncludeFinalValueFee	boolean	0..1	no	no	This field is included and set to `true` if the user wants to view 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. See the Selling fees help page for more information about how Final Value Fees are calculated.
IncludeContainingOrder	boolean	0..1	no	no	This field is included and set to `true` if the user wants to view order-level details, including the unique identifier of the order and the status of the order. The order-level details will be shown in the ContainingOrder container in the response.
Platform	TransactionPlatformCodeType : enumeration of token	0..1	no	no	Note: This field is should no longer be used, as its purpose in the past was to give the user the ability to retrieve only eBay marketplace order line items or only Half.com listings, and since the Half.com site no longer exists, this field is no longer relevant.
NumberOfDays	int	0..1	no	no	This date range 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 date range filters. This field is not applicable if a specific order line item is specified either through an ItemIDTransactionID pair or an OrderLineItemID value.
IncludeVariations	boolean	0..1	no	no	If this field is included in the request and set to `true`, details on all variations defined in the specified multiple-variation listing are returned, including variations that have no sales. If this field is 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	string	0..1	no	no	A unique identifier for an eBay order line item. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). If you want to retrieve data on a specific order line item, you can use an OrderLineItemID value in the request instead of an ItemID/TransactionID pair. If an OrderLineItemID is provided, any specified date range filter is ignored.

Component

Type / Value

Occurs

Required?

Nillable?

Description

SEQUENCE

1..1

yes

DetailLevel

DetailLevelCodeType : enumeration of token

0..∞

Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. »

ErrorLanguage

string

0..1

Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. »

MessageID

string

0..1

Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. »

Version

string

0..1

The version number of the API code that you are programming against (e.g., 1149). »

EndUserIP

string

0..1

The public IP address of the machine from which the request is sent. »

ErrorHandling

ErrorHandlingCodeType : enumeration of token

0..1

Error tolerance level for the call. »

InvocationID

UUIDType : restriction of string

0..1

A unique identifier for a particular call. »

OutputSelector

string

0..∞

You can use the OutputSelector field to restrict the data returned by a call. »

WarningLevel

WarningLevelCodeType : enumeration of token

0..1

Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. »

BotBlock

BotBlockRequestType

0..1

This container is only used by the PlaceOffer call request if the previous PlaceOffer call resulted in a BotBlock container in the response. »

{any}

from any namespace

0..∞

ItemID

ItemIDType : restriction of string

0..1

Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID. When you use ItemID alone, eBay returns all order line items that are associated with the ItemID. If you pair ItemID with a specific TransactionID, data on a specific order line item is returned. An OrderLineItemID value can be used instead of an ItemID/TransactionID pair to identify an order line item, and if an OrderLineItemID is specified in the request, any ItemID/TransactionID pair specified in the same request is 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 instead.

ModTimeFrom

dateTime

0..1

The ModTimeFrom and ModTimeTo fields are used to retrieve order line items that were created or modified within a specified date range. The ModTimeFrom field is the starting date range. All of the listing's order line items that were generated or modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. The maximum date range that may be specified is 30 days. This field is not applicable (and is ignored) if the user is looking for a specific order line item by either using an ItemID/TransactionID pair, or an OrderLineItemID value.
Note: Please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned.

ModTimeTo

dateTime

0..1

The ModTimeFrom and ModTimeTo fields are used to retrieve order line items that were created or modified within a specified date range. The ModTimeTo field is the ending date range. All eBay order line items that were generated (or 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 after the date specified with the ModTimeFrom value (if ModTimeFrom value is more than 30 days in the past). This field is not applicable (and is ignored) if the user is looking for a specific order line item by either using an ItemID/TransactionID pair, or an OrderLineItemID value.
Note: Please note that for a multiple line item order, all line items of that order that meet the filter criteria may be returned in the responses, even the line item(s) that were not actually modified. In other words, if any part of the order was modified, all line items of that order may be returned.

TransactionID

string

0..1

Include a TransactionID field in the request if you want to retrieve the data for a specific order line item for the listing specified in the ItemID field. This field is really only applicable for a multiple-quantity or multiple-variation, fixed-price listing that may have multiple sales. An auction listing or a single-quantity, fixed-price listing will only result in one order line item, so this field is not needed in these two cases. If an OrderLineItemID value is used instead to identify an order line item, this field is ignored.

If this field is used, any specified date filter is ignored.

The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.

Pagination

PaginationType

0..1

This container controls how many order line items should be returned per page of data, as well as which page of data to return (if there are multiple pages of order line items). 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.

IncludeFinalValueFee

boolean

0..1

This field is included and set to true if the user wants to view 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.

See the Selling fees help page for more information about how Final Value Fees are calculated.

IncludeContainingOrder

boolean

0..1

This field is included and set to true if the user wants to view order-level details, including the unique identifier of the order and the status of the order. The order-level details will be shown in the ContainingOrder container in the response.

Platform

TransactionPlatformCodeType : enumeration of token

0..1

Note: This field is should no longer be used, as its purpose in the past was to give the user the ability to retrieve only eBay marketplace order line items or only Half.com listings, and since the Half.com site no longer exists, this field is no longer relevant.

NumberOfDays

int

0..1

This date range 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 date range filters. This field is not applicable if a specific order line item is specified either through an ItemIDTransactionID pair or an OrderLineItemID value.

IncludeVariations

boolean

0..1

If this field is included in the request and set to true, details on all variations defined in the specified multiple-variation listing are returned, including variations that have no sales. If this field is 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

string

0..1

A unique identifier for an eBay order line item. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). If you want to retrieve data on a specific order line item, you can use an OrderLineItemID value in the request instead of an ItemID/TransactionID pair. If an OrderLineItemID is provided, any specified date range filter is ignored.

This call retrieves details on one or more order line items for a specified eBay listing. Auctions and single-quantity, fixed-price listings can only have one order line item, but a multiple-quantity and/or multiple-variation, fixed-priced listing can have numerous order line items.

To find one or more order line items for an eBay listing, an ItemID value can be passed in. If a user wanted to retrieve a specific order line item, an ItemID value and a an TransactionID value can be passed in, or an OrderLineItemID value can be passed in instead of an ItemID/TransactionID pair.

The NumberOfDays or the ModTimeFrom and ModTimeTo date range filters can be used to retrieve order line items generated (or last modified) within a specific range of time. The maximum date range that can be set is 30 days, and the ModTimeFrom date value cannot be set any further back than 90 days in the past. If no date range filters are used, all order line items (associated with the specified listing) generated (or last modified) in the last 30 days are retrieved. Date ranges are generally only used for multiple-quantity or multiple-variation, fixed-price listings that can have multiple order line items.

There are also pagination filters available that allow the user to control how many and which order line items are returned on each page of a results set.

Web-Service	Methods
eBayAPIInterfaceService	GetItemTransactions

Web-Service

Methods

eBayAPIInterfaceService

GetItemTransactions

Namespace:	urn:ebay:apis:eBLBaseComponents
Derived By:	extension of AbstractRequestType
Content:	complex, 21 elements, elem. wildcard
Defined:	in ebaySvc.wsdl/Schema
Includes:	declarations of 11 elements
Referenced:	by 2 locations