complexType "ns:GetSellerListRequestType"

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

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

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:GetSellerListRequest

Known Usage Locations

As direct type of elements (1):

ns:GetSellerListRequest

Annotation

This call is used to retrieve an array of listings for the seller. The seller must be associated with the user/application token being used to make the call.

This call requires that either the 'Start Time' or 'End Time' date range filters be used. The date range specified by either of these filters can not exceed 120 days or an error will occur.

This call also requires that pagination be used.

Type Definition Detail

Type Derivation Tree

ns:AbstractRequestType (extension)

ns:GetSellerListRequestType

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

<xs:complexType name="GetSellerListRequestType">

<xs:complexContent>

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

<xs:sequence>

<xs:element maxOccurs="1" minOccurs="0" name="UserID" type="ns:UserIDType"/>

<xs:element maxOccurs="1" minOccurs="0" name="MotorsDealerUsers" type="ns:UserIDArrayType"/>

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

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

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

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

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

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

<xs:element minOccurs="0" name="GranularityLevel" type="ns:GranularityLevelCodeType"/>

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

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

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

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

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

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 14/25)

ns:AdminEndedItemsOnly

Type:

xs:boolean, predefined, simple content

This boolean field can be included and set to true if the seller would like to retrieve any listings that were administratively ended by eBay due to a listing policy violation.

XML Representation Summary

<ns:AdminEndedItemsOnly>

Content:

{ xs:boolean }

</ns:AdminEndedItemsOnly>

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

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

ns:CategoryID

Type:

xs:int, predefined, simple content

If you specify a CategoryID value, the response will only contain listings in the category you specify.

XML Representation Summary

<ns:CategoryID>

Content:

{ xs:int }

</ns:CategoryID>

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

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

ns:EndTimeFrom

Type:

xs:dateTime, predefined, simple content

Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter in every call request. Each of the time ranges must be a value less than 120 days.

XML Representation Summary

<ns:EndTimeFrom>

Content:

{ xs:dateTime }

</ns:EndTimeFrom>

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

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

ns:EndTimeTo

Type:

xs:dateTime, predefined, simple content

Specifies the latest (most recent) date to use in a date range filter based on item end time. Must be specified if EndTimeFrom is specified.

XML Representation Summary

<ns:EndTimeTo>

Content:

{ xs:dateTime }

</ns:EndTimeTo>

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

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

ns:GranularityLevel

Type:

ns:GranularityLevelCodeType, simple content

This field allows the user to control the amount of data that is returned in the response. See the Granularity Level table on this page for a list of the fields that are returned for each granularity level. Either GranularityLevel or DetailLevel can be used in a GetSellerList call, but not both. If both are specified, DetailLevel is ignored. If neither are used, the response fields will be the ones shown for 'Coarse' granularity.

XML Representation Summary

<ns:GranularityLevel>

Content:

{ enumeration of xs:token }

</ns:GranularityLevel>

Simple Content

Enumeration:

"Coarse"	-	(in) For each record in the response, retrieves less data than Medium. See the eBay Features Guide for a list of the output fields that are returned when this level is specified.
"Fine"	-	For each record in the response, retrieves more data than Medium. See the eBay Features Guide for a list of the output fields that are returned when this level is specified.
"Medium"	-	For each record in the response, retrieves more data than Coarse and less data than Fine. See the eBay Features Guide for a list of the output fields that are returned when this level is specified.
"CustomCode"

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

<xs:element minOccurs="0" name="GranularityLevel" type="ns:GranularityLevelCodeType"/>

ns:IncludeVariations

Type:

xs:boolean, predefined, simple content

If this field is included and set to true, the Variations node is returned for all multi-variation listings in the response.

Note: If the seller has many multiple-variation listings, that seller may not want to include variations in the GetSellerList response. Or, a seller can include variations data, but possibly limit the response by specifying shorter date ranges with the date range filters, or by reducing the number of listings returned per results (decreasing the Pagination.EntriesPerPage value).

XML Representation Summary

<ns:IncludeVariations>

Content:

{ xs:boolean }

</ns:IncludeVariations>

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

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

ns:IncludeWatchCount

Type:

xs:boolean, predefined, simple content

This field may be included and set to true if the seller wishes to see the number of eBay users that are watching each listing.

XML Representation Summary

<ns:IncludeWatchCount>

Content:

{ xs:boolean }

</ns:IncludeWatchCount>

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

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

ns:MotorsDealerUsers

Type:

ns:UserIDArrayType, complex content

Specifies the list of Motors Dealer sellers for which a special set of metrics can be requested. Applies to eBay Motors Pro applications only.

Component Diagram

XML Representation Summary

<ns:MotorsDealerUsers>

Content:

ns:UserID*, {any}*

</ns:MotorsDealerUsers>

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

<xs:element maxOccurs="1" minOccurs="0" name="MotorsDealerUsers" type="ns:UserIDArrayType"/>

ns:Pagination

Type:

ns:PaginationType, complex content

This container controls the maximum number of listings that can appear on one page of the result set, as well as the page number of the result to return.

The GetSellerList call requires that the EntriesPerPage value be set. The PageNumber field is not required but will default to 1 if not included.

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:SKUArray

Type:

ns:SKUArrayType, complex content

This container can be used to specify one or multiple SKUs, and only listings associated with these SKUs are retrieved. Note that all other request criteria are also considered when one or more SKU values are specified.

Note: Listings with matching SKUs are returned regardless of their Item.InventoryTrackingMethod setting.

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"/>

ns:Sort

Type:

xs:int, predefined, simple content

This field can be used to control the order in which returned listings are sorted (based on the listings' actual/scheduled end dates). Valid values are as follows:

1 (descending order)
code>2 (ascending order)

XML Representation Summary

<ns:Sort>

Content:

{ xs:int }

</ns:Sort>

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

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

ns:StartTimeFrom

Type:

xs:dateTime, predefined, simple content

Specifies the earliest (oldest) date to use in a date range filter based on item start time. Each of the time ranges must be a value less than 120 days. In all calls, at least one date-range filter must be specified (i.e., you must specify either the end time range or start time range in every request).

XML Representation Summary

<ns:StartTimeFrom>

Content:

{ xs:dateTime }

</ns:StartTimeFrom>

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

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

ns:StartTimeTo

Type:

xs:dateTime, predefined, simple content

Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified.

XML Representation Summary

<ns:StartTimeTo>

Content:

{ xs:dateTime }

</ns:StartTimeTo>

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

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

ns:UserID

Type:

ns:UserIDType, simple content

Note: This field should no longer be used, and will be ignored if it is included in a GetSellerList request. There are plans to remove this field from the public WSDL. The only eBay user ID that can be used is the one associated with the authentication token.

XML Representation Summary

<ns:UserID>

Content:

{ xs:string }

</ns:UserID>

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

<xs:element maxOccurs="1" minOccurs="0" name="UserID" type="ns:UserIDType"/>

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.