Trading_GetSellerEventsRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetSellerEventsRequestType.h Trading_GetSellerEventsRequestType.m |
Overview
Retrieves price changes, item revisions, description revisions,
and other changes that have occurred within the last 48 hours
related to a seller’s eBay listings.
@ingroup EBayAPIInterface
Tasks
-
userID
eBay user ID for the seller whose events are to be returned.
property
If not specified, retrieves events for the user identified by
the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about
their own listings and bidders who know the user IDs of their sellers
will be able to make this API call successfully. -
startTimeFrom
Describes the earliest (oldest) time to use in a time range filter based
property
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 correspoding 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). -
startTimeTo
Describes the latest (most recent) date to use in a time range filter
property
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. -
endTimeFrom
Describes the earliest (oldest) date to use in a time range filter based
property
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 correspoding 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). -
endTimeTo
Describes the latest (most recent) date to use in a time range filter
property
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. -
modTimeFrom
Describes the earliest (oldest) date to use in a time range filter based
property
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 correspoding 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. -
modTimeTo
Describes the latest (most recent) date and time to use in a time range filter
property
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. -
newItemFilter
Default is true. If true, response includes only items that have been modified
property
within the ModTime range. If false, response includes all items. -
includeWatchCount
Specifies whether to include WatchCount in Item nodes returned. WatchCount
property
is the number of watches buyers have placed on the item from their My eBay
accounts. -
includeVariationSpecifics
Specifies whether to force the response to include
property
variation specifics for multi-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=true.
Please note that 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 EndTime, StartTime, or ModTime filters. -
hideVariations
Specifies whether to force the response to hide
property
variation details for multi-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.
Properties
endTimeFrom
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 correspoding 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).
@property (nonatomic, retain) NSDate *endTimeFrom
Discussion
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 correspoding 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).
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerEventsRequestType.h
endTimeTo
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.
@property (nonatomic, retain) NSDate *endTimeTo
Discussion
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerEventsRequestType.h
hideVariations
Specifies whether to force the response to hide
variation details for multi-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.
@property (nonatomic, retain) NSNumber *hideVariations
Discussion
Specifies whether to force the response to hide
variation details for multi-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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerEventsRequestType.h
includeVariationSpecifics
Specifies whether to force the response to include
variation specifics for multi-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=true.
Please note that 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 EndTime, StartTime, or ModTime filters.
@property (nonatomic, retain) NSNumber *includeVariationSpecifics
Discussion
Specifies whether to force the response to include
variation specifics for multi-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=true.
Please note that 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 EndTime, StartTime, or ModTime filters.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerEventsRequestType.h
includeWatchCount
Specifies whether to include WatchCount in Item nodes returned. WatchCount
is the number of watches buyers have placed on the item from their My eBay
accounts.
@property (nonatomic, retain) NSNumber *includeWatchCount
Discussion
Specifies whether to include WatchCount in Item nodes returned. WatchCount
is the number of watches buyers have placed on the item from their My eBay
accounts.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerEventsRequestType.h
modTimeFrom
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 correspoding 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.
@property (nonatomic, retain) NSDate *modTimeFrom
Discussion
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 correspoding 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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerEventsRequestType.h
modTimeTo
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.
@property (nonatomic, retain) NSDate *modTimeTo
Discussion
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerEventsRequestType.h
newItemFilter
Default is true. If true, response includes only items that have been modified
within the ModTime range. If false, response includes all items.
@property (nonatomic, retain) NSNumber *newItemFilter
Discussion
Default is true. If true, response includes only items that have been modified
within the ModTime range. If false, response includes all items.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerEventsRequestType.h
startTimeFrom
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 correspoding 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).
@property (nonatomic, retain) NSDate *startTimeFrom
Discussion
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 correspoding 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).
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerEventsRequestType.h
startTimeTo
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.
@property (nonatomic, retain) NSDate *startTimeTo
Discussion
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerEventsRequestType.h
userID
eBay user ID for the seller whose events are to be returned.
If not specified, retrieves events for the user identified by
the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about
their own listings and bidders who know the user IDs of their sellers
will be able to make this API call successfully.
@property (nonatomic, retain) NSString *userID
Discussion
eBay user ID for the seller whose events are to be returned.
If not specified, retrieves events for the user identified by
the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about
their own listings and bidders who know the user IDs of their sellers
will be able to make this API call successfully.
type : NSString, wrapper for primitive string
Declared In
Trading_GetSellerEventsRequestType.h