complexType "ns:GetSellerTransactionsResponseType"

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:GetSellerTransactionsResponseType"

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

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:GetSellerTransactionsResponse

Known Usage Locations

As direct type of elements (1):

ns:GetSellerTransactionsResponse

Annotation

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). This call 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.

Type Definition Detail

Type Derivation Tree

ns:AbstractResponseType (extension)

ns:GetSellerTransactionsResponseType

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

<xs:complexType name="GetSellerTransactionsResponseType">

<xs:complexContent>

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

<xs:sequence>

<xs:element minOccurs="0" name="PaginationResult" type="ns:PaginationResultType"/>

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

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

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

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

<xs:element minOccurs="0" name="Seller" type="ns:UserType"/>

<xs:element minOccurs="0" name="TransactionArray" type="ns:TransactionArrayType"/>

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

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 8/24)

ns:HasMoreTransactions

Type:

xs:boolean, predefined, simple content

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.

XML Representation Summary

<ns:HasMoreTransactions>

Content:

{ xs:boolean }

</ns:HasMoreTransactions>

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

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

ns:PageNumber

Type:

xs:int, predefined, simple content

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.

XML Representation Summary

<ns:PageNumber>

Content:

{ xs:int }

</ns:PageNumber>

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

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

ns:PaginationResult

Type:

ns:PaginationResultType, complex content

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.

Component Diagram

XML Representation Summary

<ns:PaginationResult>

Content:

ns:TotalNumberOfPages?, ns:TotalNumberOfEntries?, {any}*

</ns:PaginationResult>

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

<xs:element minOccurs="0" name="PaginationResult" type="ns:PaginationResultType"/>

ns:PayPalPreferred

Type:

xs:boolean, predefined, simple content

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.

XML Representation Summary

<ns:PayPalPreferred>

Content:

{ xs:boolean }

</ns:PayPalPreferred>

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

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

ns:ReturnedTransactionCountActual

Type:

xs:int, predefined, simple content

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 retrieved 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.

XML Representation Summary

<ns:ReturnedTransactionCountActual>

Content:

{ xs:int }

</ns:ReturnedTransactionCountActual>

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

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

ns:Seller

Type:

ns:UserType, complex content

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.

Component Diagram

XML Representation Summary

<ns:Seller>

Content:

ns:AboutMePage?, ns:EIASToken?, ns:Email?, ns:FeedbackScore?, ns:UniqueNegativeFeedbackCount?, ns:UniquePositiveFeedbackCount?, ns:PositiveFeedbackPercent?, ns:FeedbackPrivate?, ns:FeedbackRatingStar?, ns:IDVerified?, ns:eBayGoodStanding?, ns:NewUser?, ns:RegistrationAddress?, ns:RegistrationDate?, ns:Site?, ns:Status?, ns:UserID?, ns:UserIDChanged?, ns:UserIDLastChanged?, ns:VATStatus?, ns:BuyerInfo?, ns:SellerInfo?, ns:BusinessRole?, ns:CharityAffiliations?, ns:PayPalAccountLevel?, ns:PayPalAccountType?, ns:PayPalAccountStatus?, ns:UserSubscription*, ns:SiteVerified?, ns:SkypeID*, ns:eBayWikiReadOnly?, ns:TUVLevel?, ns:VATID?, ns:SellerPaymentMethod?, ns:BiddingSummary?, ns:UserAnonymized?, ns:UniqueNeutralFeedbackCount?, ns:EnterpriseSeller?, ns:BillingEmail?, ns:QualifiesForSelling?, ns:StaticAlias?, ns:ShippingAddress?, ns:Membership?, ns:UserFirstName?, ns:UserLastName?, {any}*

</ns:Seller>

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

<xs:element minOccurs="0" name="Seller" type="ns:UserType"/>

ns:TransactionArray

Type:

ns:TransactionArrayType, complex content

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.

Component Diagram

XML Representation Summary

<ns:TransactionArray>

Content:

ns:Transaction*

</ns:TransactionArray>

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

<xs:element minOccurs="0" name="TransactionArray" type="ns:TransactionArrayType"/>

ns:TransactionsPerPage

Type:

xs:int, predefined, simple content

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.

XML Representation Summary

<ns:TransactionsPerPage>

Content:

{ xs:int }

</ns:TransactionsPerPage>

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

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

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.