complexType "ns:GetSellerEventsRequestType"

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

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

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:GetSellerEventsRequest

Known Usage Locations

As direct type of elements (1):

ns:GetSellerEventsRequest

Annotation

This call is used by a seller to retrieve changes to their own listings that have occurred within the last 48 hours, including price changes, available quantity, and other revisions to listing.

One of the available date range filters must be used with this call.

Type Definition Detail

Type Derivation Tree

ns:AbstractRequestType (extension)

ns:GetSellerEventsRequestType

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

<xs:complexType name="GetSellerEventsRequestType">

<xs:complexContent>

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

<xs:sequence>

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

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

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

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

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

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

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

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

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

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

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

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 11/22)

ns:EndTimeFrom

Type:

xs:dateTime, predefined, simple content

Describes the earliest (oldest) date to use in a time range filter based on item end time. Must be specified if EndTimeTo is specified.

Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the corresponding To filter, it is set to the time you make the call.

For better results, the time range you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.

Include a 2-minute, overlapping buffer between requests. For example, if EndTimeTo was 6:58 in a prior request, the current request should use 6:56 in EndTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).

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

Describes the latest (most recent) date to use in a time range filter based on item end time.

If you specify the corresponding From filter, but you do not include EndTimeTo, then EndTimeTo is set to the time you make the call.

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

Type:

xs:boolean, predefined, simple content

Specifies whether to force the response to hide variation details for multiple-variation listings.

If false (or not specified), eBay returns variation details (if any). In this case, the amount of detail can be controlled by using IncludeVariationSpecifics.

If true, variation details are not returned (and IncludeVariationSpecifics has no effect). This may be useful for applications that use other calls, notifications, alerts, or reports to track price and quantity details.

XML Representation Summary

<ns:HideVariations>

Content:

{ xs:boolean }

</ns:HideVariations>

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

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

ns:IncludeVariationSpecifics

Type:

xs:boolean, predefined, simple content

Specifies whether to force the response to include variation specifics for multiple-variation listings.

If false (or not specified), eBay keeps the response as small as possible by not returning Variation.VariationSpecifics. It only returns Variation.SKU as an identifier (along with the variation price and other selling details). If the variation has no SKU, then Variation.VariationSpecifics is returned as the variation's unique identifier.

If true, Variation.VariationSpecifics is returned. (Variation.SKU is also returned, if the variation has a SKU.) This may be useful for applications that don't track variations by SKU.

Ignored when HideVariations is set to true.

Note: If the seller includes a large number of variations in many listings, using this flag may degrade the call's performance. Therefore, when you use this flag, you may need to reduce the total number of items you're requesting at once. For example, you may need to use shorter time ranges in the StartTimeFrom, EndTimeFrom, or ModTimeFrom filters.

XML Representation Summary

<ns:IncludeVariationSpecifics>

Content:

{ xs:boolean }

</ns:IncludeVariationSpecifics>

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

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

ns:IncludeWatchCount

Type:

xs:boolean, predefined, simple content

The seller can include this field and set its value to true if that seller wants to see how many prospective bidders/buyers currently have an item added to their Watch Lists. The Watch count is returned in the WatchCount field for each item in the response.

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

Type:

xs:dateTime, predefined, simple content

Describes the earliest (oldest) date to use in a time range filter based on item modification time. Must be specified if ModTimeTo is specified. Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the corresponding To filter, it is set to the time you make the call.

Include a 2-minute, overlapping buffer between requests. For example, if ModTimeTo was 6:58 in a prior request, the current request should use 6:56 in ModTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).

For better results, the time range you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.

If an unexpected item is returned (including an old item or an unchanged active item), please ignore the item. Although a maintenance process may have triggered a change in the modification time, item characteristics are unchanged.

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

Describes the latest (most recent) date and time to use in a time range filter based on the time an item's record was modified. If you specify the corresponding From filter, but you do not include ModTimeTo , then ModTimeTo is set to the time you make the call. Include a 2-minute buffer between the current time and the ModTimeTo filter.

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

Type:

xs:boolean, predefined, simple content

If true, response includes only items that have been modified within the ModTime range. If false, response includes all items.

XML Representation Summary

<ns:NewItemFilter>

Content:

{ xs:boolean }

</ns:NewItemFilter>

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

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

ns:StartTimeFrom

Type:

xs:dateTime, predefined, simple content

Describes the earliest (oldest) time to use in a time range filter based on item start time. Must be specified if StartTimeTo is specified.

Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified.

If you do not specify the corresponding To filter, it is set to the time you make the call.

For better results, the time period you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.

Include a 2-minute, overlapping buffer between requests. For example, if StartTimeTo was 6:58 in a prior request, the current request should use 6:56 in StartTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58).

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

Describes the latest (most recent) date to use in a time range filter based on item start time. If you specify the corresponding From filter, but you do not include StartTimeTo, the StartTimeTo is set to the time you make the call.

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