Trading_GetWantItNowSearchResultsRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetWantItNowSearchResultsRequestType.h Trading_GetWantItNowSearchResultsRequestType.m |
Overview
Retrieves a list of active Want It Now posts that match specified keywords
and/or a specific category ID. The response contains the following data:
CategoryID, PostID, StartTime, ResponseCount, Site, and Title. To get the post
description (Description), you must use GetWantItNowPost to retrieve individual
posts.
@ingroup EBayAPIInterface
Tasks
-
categoryID
Limits the result set to just those Want It Now posts listed in the
property
specified category. Defaults to all categories if no category ID is
specified. If the specified category ID does not match an existing
category for the site, an invalid-category error message is returned.
Controls the set of listings to return (not the details to return for each
listing).
You must specify a Query and/or a CategoryID in the request. -
query
Specifies a search string. The search string consists of one or more
property
keywords to search for in the listing title. Note that the post
description will also be searched if SearchInDescription is enabled.
By default, requests return a list of Want It Now posts that include all
of the keywords specified in the Query. All words used in the query,
including “and,” “or,” and “the,” will be treated as keywords. You can,
however, use modifiers and wildcards (e.g., +, -, and ) in the Query
field to create more complex searches. Be careful when using spaces before
or after modifiers and wildcards (+, -, or ), as the spaces can affect
the query logic.
See the eBay Web Services Guide for a list of valid search keyword query
operators and examples. -
searchInDescription
If true, include the description field of Want It Now posts in the keyword search. Want
property
It Now posts returned are those where specified search keywords appear in
either the description or the title. This is the default behavior if SearchInDescription
is not specified. If false, only the title will be searched. SearchInDescription is an
optional input. -
searchWorldwide
If true, the search applies to all eBay sites. If false, the search is
property
limited to the site specified in the URL query string when the call is
made. -
pagination
Controls the pagination of the result set. Child elements specify the
property
maximum number of item listings to return per call and which page of data
to return.
Properties
categoryID
Limits the result set to just those Want It Now posts listed in the
specified category. Defaults to all categories if no category ID is
specified. If the specified category ID does not match an existing
category for the site, an invalid-category error message is returned.
Controls the set of listings to return (not the details to return for each
listing).
You must specify a Query and/or a CategoryID in the request.
@property (nonatomic, retain) NSString *categoryID
Discussion
Limits the result set to just those Want It Now posts listed in the
specified category. Defaults to all categories if no category ID is
specified. If the specified category ID does not match an existing
category for the site, an invalid-category error message is returned.
Controls the set of listings to return (not the details to return for each
listing).
You must specify a Query and/or a CategoryID in the request.
type : NSString, wrapper for primitive string
Declared In
Trading_GetWantItNowSearchResultsRequestType.h
pagination
Controls the pagination of the result set. Child elements specify the
maximum number of item listings to return per call and which page of data
to return.
@property (nonatomic, retain) Trading_PaginationType *pagination
Discussion
Controls the pagination of the result set. Child elements specify the
maximum number of item listings to return per call and which page of data
to return.
type : class Trading_PaginationType
Declared In
Trading_GetWantItNowSearchResultsRequestType.h
query
Specifies a search string. The search string consists of one or more
keywords to search for in the listing title. Note that the post
description will also be searched if SearchInDescription is enabled.
By default, requests return a list of Want It Now posts that include all
of the keywords specified in the Query. All words used in the query,
including “and,” “or,” and “the,” will be treated as keywords. You can,
however, use modifiers and wildcards (e.g., +, -, and ) in the Query
field to create more complex searches. Be careful when using spaces before
or after modifiers and wildcards (+, -, or ), as the spaces can affect
the query logic.
See the eBay Web Services Guide for a list of valid search keyword query
operators and examples.
@property (nonatomic, retain) NSString *query
Discussion
Specifies a search string. The search string consists of one or more
keywords to search for in the listing title. Note that the post
description will also be searched if SearchInDescription is enabled.
By default, requests return a list of Want It Now posts that include all
of the keywords specified in the Query. All words used in the query,
including “and,” “or,” and “the,” will be treated as keywords. You can,
however, use modifiers and wildcards (e.g., +, -, and ) in the Query
field to create more complex searches. Be careful when using spaces before
or after modifiers and wildcards (+, -, or ), as the spaces can affect
the query logic.
See the eBay Web Services Guide for a list of valid search keyword query
operators and examples.
type : NSString, wrapper for primitive string
Declared In
Trading_GetWantItNowSearchResultsRequestType.h
searchInDescription
If true, include the description field of Want It Now posts in the keyword search. Want
It Now posts returned are those where specified search keywords appear in
either the description or the title. This is the default behavior if SearchInDescription
is not specified. If false, only the title will be searched. SearchInDescription is an
optional input.
@property (nonatomic, retain) NSNumber *searchInDescription
Discussion
If true, include the description field of Want It Now posts in the keyword search. Want
It Now posts returned are those where specified search keywords appear in
either the description or the title. This is the default behavior if SearchInDescription
is not specified. If false, only the title will be searched. SearchInDescription is an
optional input.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetWantItNowSearchResultsRequestType.h
searchWorldwide
If true, the search applies to all eBay sites. If false, the search is
limited to the site specified in the URL query string when the call is
made.
@property (nonatomic, retain) NSNumber *searchWorldwide
Discussion
If true, the search applies to all eBay sites. If false, the search is
limited to the site specified in the URL query string when the call is
made.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetWantItNowSearchResultsRequestType.h