Find products

Product calls are used to get all information related to products, and the specific merchant offers for those products. One thing to note is that only offers will have affiliate links associated with them, the product itself will not have an affiliate URL. Therefore products with multiple offers will require an additional API call using the "product' parameter listed below. Our product numbers use a 64bit integer.

The brand ID the product offers should belong to. Limited to brand IDs as provided by the merchants.

category

item

The Rakuten PopShops category a product belongs to.

currency

item

filter

USD

GBP

AUD

BRL

CAD

EUR

MXN

CHF

CNY

JMD

NPR

NZD

AFN

ZWD

ARS

AWG

INR

BAM

BGN

BOB

en_US

The currency in which a given product is offered

include_discounts

control

This will force the response to return the top discounted offer for each product as part of the results.

keyword

query

Positive Keyword: A keyword or phrase you want to find in the product name or description. A specific phrase will need double quotes "keyword phrase" or it will return result for both individual words. Negative Keyword: A singular keyword you do not want to find in product name or description. These keywords are prefixed with a dash (-). Ex: keyword=ipod –case will bring up products containing the keyword ‘ipod’ but not the keyword ‘case’.

keyword_description

query

A keyword or phrase you want to find specifically in the product description

keyword_brand

query

A term you want to search against a product's brand, such as "lenovo" or "samsung".

keyword_ean

selection

filter,query

A term you want to search against a product's EAN.

keyword_identifier premium

selection

filter,query

A term you want to search against product EAN, ISBN, MPN, UPC

keyword_isbn

selection

filter,query

A term you want to search against product ISBNs

keyword_mpn

selection

filter,query

A term you want to search against product MPNs

keyword_name

query

A keyword or phrase you want to find specifically in the product name

keyword_person

query

A term you want to search against product author or artist

keyword_sku premium

query

A term you want to search against Merchant offer SKU

keyword_upc

selection

filter,query

A term you want to search against product UPCs

language

selection

filter

For English: en_US

For French: fr_FR

For German: de_DE

For Brazilian Portuguese: pt_BR

en_US

The language (or regional dialect of a language) with which matching offers will be associated and which keyword-based queries will be analyzed.Note:If two values are specified (i.e. language=L1,L2), then the first value represents the primary language and the second value represents the backfill language (to be used if fewer than 1000 hits match the primary language).

merchant

selection

filter

The merchant ID of the merchant product offers should belong to. Could be a comma delimited list of multiple merchant IDs.

merchant_type

selection

filter

The merchant type ID of the merchant product offers should belong to. Could be a comma delimited list of multiple merchant type IDs.

page

item

pagination

1-10

1

The page number of results to return. This parameter will return up to a total of 1000 products. Ten pages with 100 product is the max results.

percent_off

range

filter

The exact percent off you want the offer merchant prices vs. retail prices. You can also use this as shorthand for percent_off_min and percent_off_max by passing in both values delimited with a '-'. This is an example of requesting products with offers with at least a 5% off price to a maximum of 10% off: percent_off=5-10. You will also want to include '&include_discounts=true' in this call.

percent_off_max

specific percent max

filter

The maximum percent off you want the offer merchant prices vs. retail prices. You will also want to include '&include_discounts=true" in this call.

percent_off_min

specific percent min

filter

The minimum percent off you want the offer merchant prices vs. retail prices. You will also want to include '&include_discounts=true" in this call.

price

range

filter

The exact price you want the offer merchant prices. You can also use this as shorthand for price_min and price_max by passing in both values delimited with a '-'. This is an example of requesting products with offers with at least a $5 price to a maximum of $10 off: price=5-10

The product ID of the exact product you want returned. Necessary to get all offer URLs from multiple product offers. Could be a comma delimited list of multiple product IDs.

product_spec premium

view

true,false

false

Indicates whether or not to include the product specification in the response. This will include an attributes node under the product node listing available attributes for the product. Offers will not be included in the results

include_identifiers premium

view

true,false

false

Indicates whether or not to include the product identifiers in the response. This will include an attributes node under the product node listing available identifiers for the product. Offers will be included in the results

results_per_page

item

pagination

1-100

20

The number of products to return in every response.

session

session

This is zipped up information we use to determine any state of previous requests. This allows us to build up more relevant filter values in the current response in order to get back to previous filtered states. You do NOT to generate the session value. We will provide the session value in the parameters block being returned. You just need to pass it forward for any additional calls you make.