Returns saved searches as a List Response for the authenticated user of the request.
Header | Data Type | Valid Values | Required | Description |
---|---|---|---|---|
Content-Type | string | application/json | YES | The format your data will be sent to our site. |
X-DevKey | string | string | YES | The devkey assigned to the developer. |
X-AccessToken | string | string | YES | The token acquired from a POST to Users/AccessToken. |
NOTE: Variables to place in the body of the request.
Required fields has 2 types: YES = You must include. YES* = You must include at least one of these.
Parameter | Data Type | Valid Values | Required | Description | |
---|---|---|---|---|---|
Name | string | string | YES | Short phrase to identify the Saved Search | |
IncludeRelistsInEmail | boolean | true/false | Do you want to see relisted items in your email notifications ( if email notifications are requested )? | ||
SaveSearchDailyEmailNotification | boolean | true/false | Do you want to receive a daily email that will give you a list of any item that matches your search criteria? | ||
BuyNowOnly | boolean | true | YES* | If set to true, only returns Fixed Price listings and auctions with a BuyNow price. No effect if set to false. | |
CanAcceptFreedomCoin | boolean | true | YES* | If set to true, only return items that can accept FreedomCoin as a payment method. No effect if set to false. | |
CanOffer | boolean | true | YES* | If set to true, only returns items that accept offers. No effect if set to false. | |
Categories | string | Comma-separated list of valid category ids | YES* | Ex: Categories=3024,3026 | |
Condition | integer |
0 - All Conditions 1 - New Items Only 2 - New and New Old Stock Items 3 - Used and New Old Stock Items 4 - Used Items Only 5 - New Old Stock Items Only 6 - New and Used Items |
The condition an item is in. | ||
Country | string | 2 character | YES* | The ISO 2 character country code to search on. EX: Country=US for United States | |
EligibleForImmediateCheckout | boolean | true | YES* | If set to true, returns items that can be purchased with a credit card. No effect if set to false. | |
Exclude | string | string | Words or phrases that will be excluded from the search. Note you must also include Keywords to search on excluded words. | ||
FeaturedListing | boolean | true | YES* | If set to true, only return Featured Listings. No effect if set to false | |
FreeShippingAvailable | boolean | true | YES* | If set to true, only return items where an available shipping option is free. No effect if set to false. | |
HasPictures | boolean | true | If set to true, only return listings with pictures. No effect if set to false | ||
Keywords | string | Keywords for search | YES* | The keywords to use for search | |
KeywordOperator | integer |
0 - All Terms 1 - Any Term 2 - Exact Match |
Whether to search by All Terms, Any Terms or Exact Match | ||
MaxBidCount | integer | positive # | The maximum number of bids an item can have. | ||
MinBidCount | integer | positive # | The minimum number of bids an item can have. | ||
MaxPrice | decimal | positive # | YES* | The maximum price an item can have. | |
MinPrice | decimal | positive # | YES* | The minimum price an item can have. | |
MaxStartingBid | decimal | positive # | YES* | The maximum starting bid an item can have. | |
MinStartingBid | decimal | positive # | YES* | The minimum starting bid an item can have. | |
NoCCFees | boolean | true | YES* | If set to true, returns items that can be purchased with a credit card with no credit card fee. No effect if set to false. | |
NoReserveItems | boolean | true | YES* | If set to true, only return auctions with no reserve price. No effect if set to false | |
PageSize | integer | positive # | The maximum number of results you want to have returned. | ||
SellerName | string | string | Username of the seller you want to look for. | ||
State | string | 2 character | YES* | The USPS 2 character state abbreivation. | |
Sort | integer |
0 - Shortest time left (Ending Date Asc) 1 - Longest time left (Ending Date Desc) 4 - Item price Asc 5 - Item price Desc 6 - Starting date Asc 7 - Starting date Desc 8 - Bid count Asc 9 - Bid count Desc 12 - Most Relevant 13 - Featured Then Most Relevant |
The order in which the results are returned. Default = 13 - Featured Then Most Relevant | ||
Timeframe | integer |
0 - View Current 3 - View Going Going Gone 4 - View New Calendar Today 5 - View Ending Calendar Today 6 - View New Last 24 7 - View New Last 48 16 - View Ending Next 24 |
This sets the time frame to search for. Default = 0 - View Current. | ||
UPC | string | string | YES* | UPC you would like to search for. | |
WillShipInternational | boolean | true | YES* | If set to true, only return items that are available to ship outside of the seller's country. No effect if set to false. |
If the saved search cannot be added successfully, you will receive a 400 Bad Request
and a Message Response indicating the reason.
If there are no errors with the input parameters, this call will respond with a 200 OK
and a Message Response indicating success.