Search Parameters Table

Search Parameters

The following table is from the Amazon documentation. Names in bold are parameters modified or specific to the KRL environment.

Name Description Multiples
locale Locales serviced by an Amazon web site that uses the local language, local customs, and local formattingType: Country Code

Supported: us, ca

Default: us

No
index Product indicesAllowed: All, Apparel, Automotive, Baby, Beauty, Blended, Books, Classical, DigitalMusic, MP3Downloads, DVD, Electronics, GourmetFood, HealthPersonalCare, HomeGarden, Industrial, Jewelry, KindleStore, Kitchen, Magazines, Merchants, Miscellaneous, Music, MusicalInstruments, MusicTracks, OfficeProducts, OutdoorLiving, PCHardware, PetSupplies, Photo, Shoes, SilverMerchants, Software, SportingGoods, Tools, Toys, UnboxVideo, VHS, Video, VideoGames, Watches, Wireless, WirelessAccessories

Default: All

No
response_group Specifies the result set returned for the item_searchAllowed: Accessories, BrowseNodes, ItemAttributes, ItemIds, MerchantItemAttributes, Offers, OfferSummary, Small, SearchBins, Similarities, Subjects, TagsSummary, Tracks, VariationSummary

Default: Small

Yes
Actor Name of an actor associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
Artist Name of an artist associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
AudienceRating Movie ratings based on MPAA ratings or age, depending upon the locale. You may specify one or more values in a comma-separated list in a REST request or by using multiple elements in a SOAP request.

Type: String.

Type: String

Default: None

Valid Values: See Movie Ratings by Locale, which follows this table.

No
Author Name of an author associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
Availability Enables ItemSearch to return only those items that are available. This parameter must be used in combination with a merchant ID and Condition. For more information, see Availability Parameter, which follows this table.When Availability is set to "Available," the Condition parameter cannot be set to "New."

Type: String

Default: None

Valid Values: Available

Yes
Brand Name of a brand associated with the item. You can enter all or part of the name.

Type: String, for example, Timex, Seiko, Rolex.

Type: String

Default: None

No
BrowseNode Browse nodes are positive integers that identify product categories, for example, Literature & Fiction: (17), Medicine: (13996), Mystery & Thrillers: (18), Nonfiction: (53), Outdoors & Nature: (290060).

Type: String

Default: None

Valid Values: Positive integer.

No
City Name of a city associated with the item. You can enter all or part of the name. This parameter only works in the US locale.

Type: String

Default: None

Valid Values: Chicago | New York | San Francisco | Seattle | Washington, D.C.

No
Composer Name of an composer associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
Condition Use the Condition parameter to filter the offers returned in the product list by condition type. By default, Condition equals "New". If you do not get results, consider changing the value to "All. When the Availability parameter is set to "Available," the Condition parameter cannot be set to "New."

ItemSearch returns up to ten search results at a time. When condition equals "All," ItemSearch returns up to three offers per condition (if they exist), for example, three new, three used, three refurbished, and three collectible items. Or, for example, if there are no collectible or refurbished offers, ItemSearch returns three new and three used offers.

Type: String

Default: New

Valid Values: Used | Collectible | Refurbished | All

No
Conductor Name of a conductor associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
Director Name of a director associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
ItemPage Retrieves a specific page of items from all of the items in a response. Up to ten items are returned on a page unless Condition equals "All." In that case,ItemSearch returns up to three results per Condition, for example, three new, three used, three refurbished, and three collectible items. Or, for example, if there are no collectible or refurbished items being offered, ItemSearch returns three new and three used items. The maximum ItemPage number that can be returned is 400. An error is returned if you try to access higher numbered pages. If you do not include ItemPage in your request, the first page will be returned by default. The total number of pages of items found is returned in the TotalPagesresponse tag.

Valid Values: Integer between 1 and 400, inclusive.

Type: String

Default: None

No
Keywords A word or phrase associated with an item. The word or phrase can be in various product fields, including product title, author, artist, description, manufacturer, and so forth. When, for example, the search index equals "MusicTracks," theKeywords parameter enables you to search by song title.

Type: String

Default: None

Yes, Space separated string
Manufacturer Name of a manufacturer associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
MaximumPrice Specifies the maximum price of the items in the response. Prices are in terms of the lowest currency denomination, for example, pennies. For example, 3241 represents $32.41.

Type: String

Default: None

Valid Values: Positive integer

No
MerchantId Specifies the merchant who is selling the item. MerchantId is an alphanumeric identifier assigned by Amazon to merchants. Make sure to specify a merchant ID and not a seller ID, which is not supported. Note that the default value is "Amazon." If your request does not generate results, consider setting the value to "All."

Type: String

Default: Amazon

Valid Values:

Valid merchant ID of a merchant

All--Includes Amazon and all other merchants

No
MinimumPrice Specifies the minimum price of the items to return. Prices are in terms of the lowest currency denomination, for example, pennies, for example, 3241 represents $32.41.

Type: String

Default: None

Valid Values: Positive integer

No
Neighborhood Name of a neighborhood You can enter all or part of the name. The neighborhoods are located in one of the valid values for City.

Type: String, for example, Capitol Hill, Arlington, and North Beach.

Type: String

Default: None

No
Orchestra Name of an orchestra associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
PostalCode Postal code of the merchant. In the US, the postal code is the postal code. This parameter enables you to search for items sold in a specified region of a country.

Type: String

Default: None

No
Power Performs a book search using a complex query string. Only works when the search index is set equal to "Books."

Valid Values: See, Power Searches following this table.

Type: String

Default: None

No
Publisher Name of a publisher associated with the item. You can enter all or part of the name.

Type: String

Default: None

No
RelatedItemsPage This optional parameter is only valid when the RelatedItems response group is used. Each ItemLookup request can return, at most, ten related items. The RelatedItemsPage value specifies the set of ten related items to return. A value of 2, for example, returns the second set of ten related items. No
RelationshipType This parameter is required when the RelatedItems response group is used. The type of related item returned is specified by the RelationshipType parameter. Sample values include Episode, Season, and Tracks. A complete list of values follows this table.

Constraint: Required when RelatedItems response group is used

Conditional
TagPage Specifies the page of results to return. There are ten results on a page. The maximum page number is 400.

Type: Integer

Type: String

Default: None

No
TagsPerPage The number of tags to return that are associated with a specified item.

Type: Integer

Type: String

Default: None

No
TagSort Specifies the sorting order for the results.

Type: String

Default: - Usages

Valid Values:

  • FirstUsed-Sort by the date the item was first used.- FirstUsed
  • LastUsed-Sort by the date the item was last used.- LastUsed
  • Name-Alphabetical, A-Z.- Name
  • Usages-Items least used to most used

To sort items in descending order, prefix the values with a negative sign (-).

No
TextStream A search based on two or more words. ItemSearch picks out of the block of text up to ten keywords and returns up to ten items that match those keywords. For example, if five keywords are found, two items for each keyword are returned. Only one page of results is returned so ItemPage does not work with TextStream.

Type: String

Default: None

No
Title The title associated with the item. You can enter all or part of the title. Titlesearches are a subset of Keyword searches. If a Title search yields insufficient results, consider using a Keywords search.

Type: String

Default: None

No
VariationPage Retrieves a specific page of variations returned by ItemSearch. By default,ItemSearch returns all variations. Use VariationPage to return a subsection of the response. There are 10 variations per page. To examine offers 11 trough 20, for example, set VariationPage to 2. The total number of pages is returned in the TotalPages element.

Type: String

Default: None

Valid Values: Positive integer

No