Trading_GetSellerListRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetSellerListRequestType.h Trading_GetSellerListRequestType.m |
Overview
Returns a list of the items posted by the authenticated user, including
the related item data.
@ingroup EBayAPIInterface
Tasks
-
userID
Specifies the seller whose items will be returned. UserID is an optional
input. If not specified, retrieves listings 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. See <a href=
“http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo”
propertyWorking with Anonymous User Informationin the eBay Web
Services Guide for more information. -
motorsDealerUsers
Specifies the list of Motors Dealer sellers for which a special set of
property
metrics can be requested. Applies to eBay Motors Pro applications only. -
endTimeFrom
Specifies the earliest (oldest) date to use in a date range filter based on
property
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. -
endTimeTo
Specifies the latest (most recent) date to use in a date range filter based
property
on item end time. Must be specified if EndTimeFrom is specified. -
sort
Specifies the order in which returned items are sorted (based on the end
property
dates of the item listings). Valid values:
0 = No sorting
1 = Sort in descending order
2 = Sort in ascending order -
startTimeFrom
Specifies the earliest (oldest) date to use in a date range filter based on
property
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). -
startTimeTo
Specifies the latest (most recent) date to use in a date range filter based
property
on item start time. Must be specified if StartTimeFrom is specified. -
pagination
Contains the data controlling the pagination of the returned values.
property
If you set a DetailLevel in this call, you must set pagination values.
The Pagination field contains
the number of items to be returned per page of data (per call),
and the page number to return with the current call. -
granularityLevel
Specifies the subset of item and user fields to return. See GetSellerList
property
in the eBay Web Services guide for a list of the fields that are returned
for each granularity level. For GetSellerList, use DetailLevel or
GranularityLevel in a request, but not both. For GetSellerList, if
GranularityLevel is specified, DetailLevel is ignored. -
skuArray
Container for a set of SKUs.
property
Filters (reduces) the response to only include active listings
that the seller listed with any of the specified SKUs.
If multiple listings include the same SKU, they are
all returned (assuming they also match the other criteria
in the GetSellerList request).
SKUArray can be used to retrieve items listed by the user
identified in AuthToken or in UserID.
Note:
Listings with matching SKUs are returned regardless of their
Item.InventoryTrackingMethod settings.
-
includeWatchCount
Specifies whether to include WatchCount in Item nodes returned.
property
WatchCount is only returned with DetailLevel ReturnAll. -
adminEndedItemsOnly
Specifies whether to return only items that were administratively ended
property
based on a policy violation. -
categoryID
The category ID for the items retrieved.
property
If you specify CategoryID in a GetSellerList call,
the response contains only items in the category you specify. -
includeVariations
If true, the Variations node is returned for all multi-variation
property
listings in the response.
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 or StartTime filters, fewer entries per page in
Pagination, and/or SKUArray.
Properties
adminEndedItemsOnly
Specifies whether to return only items that were administratively ended
based on a policy violation.
@property (nonatomic, retain) NSNumber *adminEndedItemsOnly
Discussion
Specifies whether to return only items that were administratively ended
based on a policy violation.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerListRequestType.h
categoryID
The category ID for the items retrieved.
If you specify CategoryID in a GetSellerList call,
the response contains only items in the category you specify.
@property (nonatomic, retain) NSNumber *categoryID
Discussion
The category ID for the items retrieved.
If you specify CategoryID in a GetSellerList call,
the response contains only items in the category you specify.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetSellerListRequestType.h
endTimeFrom
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.
@property (nonatomic, retain) NSDate *endTimeFrom
Discussion
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerListRequestType.h
endTimeTo
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.
@property (nonatomic, retain) NSDate *endTimeTo
Discussion
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerListRequestType.h
granularityLevel
Specifies the subset of item and user fields to return. See GetSellerList
in the eBay Web Services guide for a list of the fields that are returned
for each granularity level. For GetSellerList, use DetailLevel or
GranularityLevel in a request, but not both. For GetSellerList, if
GranularityLevel is specified, DetailLevel is ignored.
@property (nonatomic, retain) NSString *granularityLevel
Discussion
Specifies the subset of item and user fields to return. See GetSellerList
in the eBay Web Services guide for a list of the fields that are returned
for each granularity level. For GetSellerList, use DetailLevel or
GranularityLevel in a request, but not both. For GetSellerList, if
GranularityLevel is specified, DetailLevel is ignored.
type: string constant in Trading_GranularityLevelCodeType.h
Declared In
Trading_GetSellerListRequestType.h
includeVariations
If true, the Variations node is returned for all multi-variation
listings in the response.
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 or StartTime filters, fewer entries per page in
Pagination, and/or SKUArray.
@property (nonatomic, retain) NSNumber *includeVariations
Discussion
If true, the Variations node is returned for all multi-variation
listings in the response.
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 or StartTime filters, fewer entries per page in
Pagination, and/or SKUArray.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerListRequestType.h
includeWatchCount
Specifies whether to include WatchCount in Item nodes returned.
WatchCount is only returned with DetailLevel ReturnAll.
@property (nonatomic, retain) NSNumber *includeWatchCount
Discussion
Specifies whether to include WatchCount in Item nodes returned.
WatchCount is only returned with DetailLevel ReturnAll.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetSellerListRequestType.h
motorsDealerUsers
Specifies the list of Motors Dealer sellers for which a special set of
metrics can be requested. Applies to eBay Motors Pro applications only.
@property (nonatomic, retain) Trading_UserIDArrayType *motorsDealerUsers
Discussion
Specifies the list of Motors Dealer sellers for which a special set of
metrics can be requested. Applies to eBay Motors Pro applications only.
type : class Trading_UserIDArrayType
Declared In
Trading_GetSellerListRequestType.h
pagination
Contains the data controlling the pagination of the returned values.
If you set a DetailLevel in this call, you must set pagination values.
The Pagination field contains
the number of items to be returned per page of data (per call),
and the page number to return with the current call.
@property (nonatomic, retain) Trading_PaginationType *pagination
Discussion
Contains the data controlling the pagination of the returned values.
If you set a DetailLevel in this call, you must set pagination values.
The Pagination field contains
the number of items to be returned per page of data (per call),
and the page number to return with the current call.
type : class Trading_PaginationType
Declared In
Trading_GetSellerListRequestType.h
skuArray
Container for a set of SKUs.
Filters (reduces) the response to only include active listings
that the seller listed with any of the specified SKUs.
If multiple listings include the same SKU, they are
all returned (assuming they also match the other criteria
in the GetSellerList request).
SKUArray can be used to retrieve items listed by the user
identified in AuthToken or in UserID.
Note:
Listings with matching SKUs are returned regardless of their
Item.InventoryTrackingMethod settings.
@property (nonatomic, retain) Trading_SKUArrayType *skuArray
Discussion
Container for a set of SKUs.
Filters (reduces) the response to only include active listings
that the seller listed with any of the specified SKUs.
If multiple listings include the same SKU, they are
all returned (assuming they also match the other criteria
in the GetSellerList request).
SKUArray can be used to retrieve items listed by the user
identified in AuthToken or in UserID.
Note:
Listings with matching SKUs are returned regardless of their
Item.InventoryTrackingMethod settings.
type : class Trading_SKUArrayType
Declared In
Trading_GetSellerListRequestType.h
sort
Specifies the order in which returned items are sorted (based on the end
dates of the item listings). Valid values:
0 = No sorting
1 = Sort in descending order
2 = Sort in ascending order
@property (nonatomic, retain) NSNumber *sort
Discussion
Specifies the order in which returned items are sorted (based on the end
dates of the item listings). Valid values:
0 = No sorting
1 = Sort in descending order
2 = Sort in ascending order
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetSellerListRequestType.h
startTimeFrom
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).
@property (nonatomic, retain) NSDate *startTimeFrom
Discussion
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).
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerListRequestType.h
startTimeTo
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.
@property (nonatomic, retain) NSDate *startTimeTo
Discussion
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.
type : NSDate, wrapper for primitive date
Declared In
Trading_GetSellerListRequestType.h
userID
Specifies the seller whose items will be returned. UserID is an optional
input. If not specified, retrieves listings 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. See <a href=
“http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo”
Working with Anonymous User Informationin the eBay Web
Services Guide for more information.
@property (nonatomic, retain) NSString *userID
Discussion
Specifies the seller whose items will be returned. UserID is an optional
input. If not specified, retrieves listings 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. See <a href=
“http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo”
Working with Anonymous User Informationin the eBay Web
Services Guide for more information.
type : NSString, wrapper for primitive string
Declared In
Trading_GetSellerListRequestType.h