complexType "ns:GetSellerTransactionsRequestType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:GetSellerTransactionsRequestType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 20 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 10 elements
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:GetSellerTransactionsRequest

Known Usage Locations

As direct type of elements (1):

ns:GetSellerTransactionsRequest

Annotation

Retrieves a seller's order line item information. To retrieve order line items for another seller, the GetItemTransactions) call should be used. This call cannot retrieve sales older than 90 days old.

If one or more SKU values or the date range filters (ModTimeFrom/ModTimeTo or NumberOfDays) are not used, the GetItemTransactions) call will retrieve order line items created (or modified) within the last 30 days.

Type Definition Detail

Type Derivation Tree

ns:AbstractRequestType (extension)

ns:GetSellerTransactionsRequestType

XML Source (w/o annotations (11); see within schema source)

<xs:complexType name="GetSellerTransactionsRequestType">

<xs:complexContent>

<xs:extension base="ns:AbstractRequestType">

<xs:sequence>

<xs:element minOccurs="0" name="ModTimeFrom" type="xs:dateTime"/>

<xs:element minOccurs="0" name="ModTimeTo" type="xs:dateTime"/>

<xs:element minOccurs="0" name="Pagination" type="ns:PaginationType"/>

<xs:element minOccurs="0" name="IncludeFinalValueFee" type="xs:boolean"/>

<xs:element minOccurs="0" name="IncludeContainingOrder" type="xs:boolean"/>

<xs:element minOccurs="0" name="SKUArray" type="ns:SKUArrayType"/>

<xs:element minOccurs="0" name="Platform" type="ns:TransactionPlatformCodeType"/>

<xs:element minOccurs="0" name="NumberOfDays" type="xs:int"/>

<xs:element minOccurs="0" name="InventoryTrackingMethod" type="ns:InventoryTrackingMethodCodeType"/>

<xs:element minOccurs="0" name="IncludeCodiceFiscale" type="xs:boolean"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 10/21)

ns:IncludeCodiceFiscale

Type:

xs:boolean, predefined, simple content

If this field is included in the call request and set to true, taxpayer identification information for the buyer is returned under the BuyerTaxIdentifier container.

Codice Fiscale is only applicable to buyers on the Italy and Spain sites. It is required that buyers on the Italy site provide their Codice Fiscale ID before buying an item, and sellers on the Spain site have the option of requiring buyers on the Spain site to provide their taxpayer ID.

XML Representation Summary

<ns:IncludeCodiceFiscale>

Content:

{ xs:boolean }

</ns:IncludeCodiceFiscale>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="IncludeCodiceFiscale" type="xs:boolean"/>

ns:IncludeContainingOrder

Type:

xs:boolean, predefined, simple content

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.

XML Representation Summary

<ns:IncludeContainingOrder>

Content:

{ xs:boolean }

</ns:IncludeContainingOrder>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="IncludeContainingOrder" type="xs:boolean"/>

ns:IncludeFinalValueFee

Type:

xs:boolean, predefined, simple content

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.

Note: The calculation of the Final Value Fee is changing for managed payments sellers, so the value returned in the FinalValueFee fields for each order line item in the response should only be considered as estimated values. The getTransactions method of the Finances API can be used to get accurate Final Value Fee values.

See the Selling fees for managed payments sellers help page for more information about how Final Value Fees are changing for managed payments sellers.

XML Representation Summary

<ns:IncludeFinalValueFee>

Content:

{ xs:boolean }

</ns:IncludeFinalValueFee>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="IncludeFinalValueFee" type="xs:boolean"/>

ns:InventoryTrackingMethod

Type:

ns:InventoryTrackingMethodCodeType, simple content

This filter is used if the seller wishes to set/change the inventory tracking method. When creating a listing with the AddFixedPriceItem call (or relisting with RelistFixedPriceItem call), sellers can decide whether to track their inventory by Item ID (generated by eBay at listing time) or by seller-defined SKU value.

This field is needed (and its value must be set to SKU) if the seller wishes to retrieve order line items based on specified SKU values (specified through SKUArray container) and the current inventory tracking method is set to Item ID.

A seller can use a GetItem call for a listing (and look for the Item.InventoryTrackingMethod in the response) to see which inventory tracking method is used for the listing/product.

XML Representation Summary

<ns:InventoryTrackingMethod>

Content:

{ enumeration of xs:token }

</ns:InventoryTrackingMethod>

Simple Content

Enumeration:

"ItemID"	-	Indicates the seller prefers to track the listing by its eBay item ID. This is the default for all listings.
"SKU"	-	Indicates the seller prefers to track the listing by their own SKU. When you track by SKU, it means you can pass in your SKU instead of the eBay item ID in other calls that support SKU as an input field. If you choose SKU as your tracking preference for a listing, the value in Item.SKU must be unique across your active listings. You cannot create new listings with the same Item.SKU value while the listing is active (that is, until the existing listing with that SKU has ended). However, you can use ReviseInventoryStatus to update the quantity and/or price for the existing SKU as needed. When revising a listing where the InventoryTrackingMethod was set to SKU, you must pass in both the InventoryTrackingMethod tag (with the value set to SKU) and the SKU tag with the SKU value from your original listing.
"CustomCode"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="InventoryTrackingMethod" type="ns:InventoryTrackingMethodCodeType"/>

ns:ModTimeFrom

Type:

xs:dateTime, predefined, simple content

The ModTimeFrom and ModTimeTo fields are used to specify a date range for retrieving order line items associated with the seller. The ModTimeFrom field is the starting date range. All of the seller's order line items that were created (or last 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. This field is not applicable 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).

XML Representation Summary

<ns:ModTimeFrom>

Content:

{ xs:dateTime }

</ns:ModTimeFrom>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ModTimeFrom" type="xs:dateTime"/>

ns:ModTimeTo

Type:

xs:dateTime, predefined, simple content

The ModTimeFrom and ModTimeTo fields are used to specify a date range for retrieving order line items associated with the seller. The ModTimeTo field is the ending date range. All of the seller's order line items that were created (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 past the ModTimeFrom value (if ModTimeFrom value is more than 30 days in the past). This field is not applicable 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).

XML Representation Summary

<ns:ModTimeTo>

Content:

{ xs:dateTime }

</ns:ModTimeTo>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ModTimeTo" type="xs:dateTime"/>

ns:NumberOfDays

Type:

xs:int, predefined, simple content

This field is used to specify how many days (24-hour periods) back in the past you wish to retrieve order line items. All order line items created (or last modified) within this period are retrieved. This value can be set between 1 (day) and 30 (days), and defaults to 30 (days) if omitted from the call.

If the NumberOfDays filter is used, ModTimeFrom and ModTimeTo date range filters are ignored (if included in the same request).

XML Representation Summary

<ns:NumberOfDays>

Content:

{ xs:int }

</ns:NumberOfDays>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="NumberOfDays" type="xs:int"/>

ns:Pagination

Type:

ns:PaginationType, complex content

If many order line items are available to retrieve, you may need to call GetSellerTransactions multiple times to retrieve all the data. Each result set is returned as a page of order line items. Use the Pagination filters to control the maximum number of order line items to retrieve per page (i.e., per call), and the page number to retrieve.

Component Diagram

XML Representation Summary

<ns:Pagination>

Content:

ns:EntriesPerPage?, ns:PageNumber?, {any}*

</ns:Pagination>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Pagination" type="ns:PaginationType"/>

ns:Platform

Type:

ns:TransactionPlatformCodeType, simple content

Note: This field should no longer be used since its sole purpose was to allow the seller to filter between eBay orders and Half.com orders, and the Half.com site no longer exists.

XML Representation Summary

<ns:Platform>

Content:

{ enumeration of xs:token }

</ns:Platform>

Simple Content

Enumeration:

"eBay"	-	This value indicates the purchase occurred on an eBay marketplace site.
"Express"	-	Note: eBay Express no longer exists. The order line item was created on the eBay Express site.
"Half"	-	Note: Half.com listings will no longer be supported in APIs. The order line item was created on Half.com site.
"Shopping"	-	Note: Shopping.com listings are no longer supported in APIs. The order line item was created on the Shopping.com site.
"WorldOfGood"	-	Note: World Of Good is no longer associated with eBay. The order line item was created on the WorldOfGood site.
"CustomCode"	-	Reserved for future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Platform" type="ns:TransactionPlatformCodeType"/>

ns:SKUArray

Type:

ns:SKUArrayType, complex content

This container is used to search for order line items generated from one or more product SKU values. The response will only include order line items for the seller's product(s) that are represented by the specified SKU value(s).

If a user wants to retrieve order line items based on SKUs, the InventoryTrackingMethod must be set to SKU. The InventoryTrackingMethod value can be set when the seller lists the item through an AddFixedPriceItem call, or it can be set by including the InventoryTrackingMethod field in a GetSellerTransactions call and setting its value to SKU.

Note: SKU values must be defined for products in listings for this container to be applicable.

Component Diagram

XML Representation Summary

<ns:SKUArray>

Content:

ns:SKU*

</ns:SKUArray>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SKUArray" type="ns:SKUArrayType"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.