Updated on Fri, 2012-03-23
There are a number of important things to know before using the search APIs which are explained below.
Best Practices
- Ensure all parameters are properly URL encoded.
- Limit your searches to 10 keywords and operators.
Product Search Operators
In addition to the parameters listed in the search API documentation, there are a number of operators you can use to modify the behavior of query.
| Example |
Finds products... |
| ceramic mug |
containing both "ceramic" and "mug". This is the default behavior. |
| "ceramic mug" |
containing the exact phrase "ceramic mug". |
| cup OR mug |
containing either "cup" or "mug" (or both). |
| mug -ceramic |
containing "mug" but not "ceramic". |
| asi:33020 |
which are products of a supplier whose asi # is "33020". |
| canadian:1 |
from Canadian suppliers. |
| canadian_friendly:1 |
from Canadian-friendly suppliers. |
| category:Mugs & Steins-Ceramic |
which belong to the category "Mugs & Steins-Ceramic". |
| color:Red |
which are available in the color "Red". |
| size:24oz |
which are available in the size "24oz". |
| shape:heart |
which are available in the shape "heart". |
| material:ceramic |
which are available in the material "ceramic". |
| theme:golf |
that relate to the theme "golf". |
| green mug theme:golf material:ceramic |
containing "green" and "mug" related to the theme "golf" made of the material "ceramic". |
Supplier Search Operators
In addition to the parameters listed in the search API documentation, there are a number of operators you can use to modify the behavior of query.
| Example |
Finds suppliers... |
| advertising specialty |
containing both "advertising" and "specialty". This is the default behavior. |
| "advertising specialty" |
containing the exact phrase "advertising specialty". |
| advertising OR specialty |
containing either "advertising" or "specialty" (or both). |
| advertising -institute |
containing "advertising" but not "institute". |
| asi:33020 |
whose asi # is "33020". |
| canadian:1 |
which are Canadian suppliers. |
| canadian_friendly:1 |
which are Canadian-friendly suppliers. |
| city:Los |
which reside in a city containing "Los". |
| state:CA |
which reside in the state "CA". |
| zip:90001 |
which resize in the zip code "90001". |
| email:support@asicentral.com |
whose e-mail address is "support@asicentral.com". |
| phone:9999999999 |
whose phone number is "9999999999". |
| geocode:40.1370,-74.9836,5mi |
whose location is within 5 miles of the coordinates 40.1370,-74.9836. |
| promo city:Los state:CA |
containing "promo" who resides in a city containing "Los" and the state "CA". |
Decorator Search Operators
In addition to the parameters listed in the search API documentation, there are a number of operators you can use to modify the behavior of query.
| Example |
Finds decorators... |
| advertising specialty |
containing both "advertising" and "specialty". This is the default behavior. |
| "advertising specialty" |
containing the exact phrase "advertising specialty". |
| advertising OR specialty |
containing either "advertising" or "specialty" (or both). |
| advertising -institute |
containing "advertising" but not "institute". |
| asi:10522 |
whose asi # is "10522". |
| city:Los |
which reside in a city containing "Los". |
| state:CA |
which reside in the state "CA". |
| zip:90001 |
which resize in the zip code "90001". |
| email:support@asicentral.com |
whose e-mail address is "support@asicentral.com". |
| phone:9999999999 |
whose phone number is "9999999999". |