AmazonSearchQuery interface

Data used to query the amazon search API

Signature:

export interface AmazonSearchQuery 

Remarks

All the fields are optional however at least one of AmazonSearchQuery.keyword, AmazonSearchQuery.title or AmazonSearchQuery.searchIndex must be set

Properties

PropertyModifiersTypeDescription
count?readonlynumber(Optional) The maximum number of items to be returned
itemContents?readonlyAmazonItemContent[](Optional) Control which values are to be populated with data in the AmazonItem response objects
keyword?readonlystring(Optional) Matched against the description and title of items
maxPrice?readonlynumber(Optional) Filter out any results with a price higher then this
minPrice?readonlynumber(Optional) Filter out any results with a price lower then this
page?readonlynumber(Optional) Skip the first count * (page - 1) results
searchIndex?readonlystring(Optional) Only search against production in this category
sortOrder?readonlyAmazonSortOrder(Optional) Control how search results are sorted
title?readonlystring(Optional) Matched against the title of items

AmazonSearchQuery.count property

The maximum number of items to be returned

Signature:

readonly count?: number;

AmazonSearchQuery.itemContents property

Control which values are to be populated with data in the AmazonItem response objects

Signature:

readonly itemContents?: AmazonItemContent[];

AmazonSearchQuery.keyword property

Matched against the description and title of items

Signature:

readonly keyword?: string;

AmazonSearchQuery.maxPrice property

Filter out any results with a price higher then this

Signature:

readonly maxPrice?: number;

Remarks

Price is given as an integer in the lowest currency denomination. ie: pass 3241 for $32.41

AmazonSearchQuery.minPrice property

Filter out any results with a price lower then this

Signature:

readonly minPrice?: number;

Remarks

Price is given as an integer in the lowest currency denomination. ie: pass 3241 for $32.41

AmazonSearchQuery.page property

Skip the first count * (page - 1) results

Signature:

readonly page?: number;

Remarks

This is 1 indexed so pass 1 (the default) to receive the first page of results, passing 0 will cause the request to fail

AmazonSearchQuery.searchIndex property

Only search against production in this category

Signature:

readonly searchIndex?: string;

Remarks

The list of valid categories can be found here: https://webservices.amazon.com/paapi5/documentation/locale-reference/united-states.html\###search-index

Use 'All' to search without filtering out any products

AmazonSearchQuery.sortOrder property

Control how search results are sorted

Signature:

readonly sortOrder?: AmazonSortOrder;

AmazonSearchQuery.title property

Matched against the title of items

Signature:

readonly title?: string;