Forum Search
This table provides a handy summary of the short codes that you can use with our AmazonWS content plugin.
| Name | Default Value | Possible Values | Description |
|---|---|---|---|
| itemId | 10 character product ASIN or ISBN, or can be a comma-separated list of up to 10 ASINs, use for item lookup which fetches specific products | ||
| keywords | one or more keywords for item search, this will search all the product information for the keywords | ||
| searchIndex | All | listed above | used to limit the keyword search to specific product type |
| showPrices | yes | yes, no | show the Amazon list price |
| showSalePrices | yes | yes, no | show the Amazon sale price |
| showAmountSaved | yes | yes, no | show the amount save (off list price) |
| showNewOfferPrices | yes | yes, no | show the lowest new offer price |
| showUsedOfferPrices | yes | yes, no | show the lowest used offer price |
| showCollectiblePrices | yes | yes, no | show the collectible price |
| showRevs | yes | yes, no | show the Amazon customer reviews |
| showEditorial | yes | yes, no | show the editorial review (this is basically the product description, usually the same as on the Amazon product page) |
| country | com | com, de, co.uk, fr, co.jp, ca, cn, it, in | the Amazon country database from which you want to display results - normally you will set this once in the plugin options rather than using short code, but you can override this using short code eg country=de |
| associateId | the tracking (affiliate id) to include in the product links - normally you will set this once in the plugin options, but you can override it in the short code eg associateId=myname-21 | ||
| author | use instead of keywords parameter to make a search only of authors eg author=Rowling | ||
| brand | use instead of keywords parameter to make a search only of brand information eg brand=Apple | ||
| manufacturer | use instead of keywords parameter to make a search only of manufacturer information eg manufacturer=Samsung | ||
| publisher |
use instead of keywords parameter to make a search only of publisher information eg publisher=Blackwell |
||
| title | use instead of keywords parameter to make a search only of title, notice you don't need the complete title, just a few key words eg title=Pride, Prejudice | ||
| browseNode | Positive integer | browse nodes are positive integers that identify product categories, for example, Literature & Fiction: (17), Medicine: (13996), Mystery & Thrillers: (18), Nonfiction: (53), Outdoors & Nature: (290060). You can find more about browse nodes here. | |
| maxresults | 10 | number from 1 to 10 | this parameter controls the number of results displayed for an item search, note that Amazon will always return a maximum of 10, for results beyond the first 10 use the itemPage parameter |
| itemPage | 1 | number from 1 to 10 (1 to 5 if searchIndex = All) | use to display results beyond the first 10, eg itemPage=2 displays the second 10 results. There is no way to display beyond the first 100 results, Amazon suggest in that case to refine your search |
| sort | relevance | 'price' (low to high), '-price' (high to low), 'salesrank', 'titlerank' (Alphabetical: A to Z), '-titlerank' (Alphabetical: Z to A) and many others | control the sort order of results using the sort option, which can take many values, depending on the search index and your locale. You can see the complete list here. Eg: sort=-price |
| useAccordion | no | yes, no | Use a collapsible accordion to display results, to save space on the page |
| modalReviews | no | yes, no | have the customer reviews display in a modal window when you click a link, rather than in an iframe on your page |
| articleLayout | article | article, blog, search, book, brand, or custom layout name | control the layout when an an item lookup is viewed in a Joomla article view. Note that you can create your own custom layout, it you put it in the plugin tmpl folder you can then specify the layout using this parameter, eg if your custom layout is called dvd, use articleLayout=dvd |
| blogLayout | article | article, blog, search, book, brand, or custom layout name | control the layout when an an item lookup is viewed in a Joomla blog view, as for the article view, you can set your own custom layout, eg if your custom layout is called dvd, use blogLayout=dvd |
| searchLayout | search | article, blog, search, book, brand, or custom layout name | control the layout of item search results, eg searchLayout=dvd |
| mode | simple | use this to override the plugin behaviour, if the plugin is using the shopping cart mode on your site, but you want to override this and have just a simple link to the Amazon site for your product, then put mode=simple in your short code | |
| linkType | internal, external | use this setting to force product links to point to a product page on your site (internal) or directly to the Amazon site (external) | |
| minimumPrice | integer value using smallest unit of currency, eg to set a value of $4.99 use 499 | you can filter by price by using the minimumPrice and maximumPrice options. Note that these options are not available for searchIndex=All. Example usage: minimumPrice=99;maximumPrice=899 | |
| maximumPrice | integer value using smallest unit of currency, eg to set a value of $4.99 use 499 |