Raw schema
{
"type": "object",
"properties": {
"geo": {
"default": "US",
"description": "Marketplace country code.",
"enum": [
"US",
"CA",
"DE",
"MX",
"UK",
"FR",
"IT",
"ES",
"AU",
"BR",
"IN",
"JP",
"NL",
"AE",
"PL",
"SA",
"SG",
"SE",
"TR",
"BE",
"IE",
"ZA",
"EG"
],
"title": "Geo",
"type": "string"
},
"offset": {
"default": 0,
"description": "Row to start at. A page is 30 rows; pass the previous answer's next_offset for the next page.",
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"categories": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Department to restrict to: its id from available_filters.categories, or its name as Amazon shows it for that marketplace (case-insensitive; a unique fragment such as \"electronics\" works). US departments: Amazon Devices & Accessories, Appliances, Arts Crafts & Sewing, Audible Books & Originals, Automotive, Baby Products, Beauty & Personal Care, Books, CDs & Vinyl, Cell Phones & Accessories, Clothing Shoes & Jewelry, Collectibles & Fine Art, Electronics, Everything Else, Grocery & Gourmet Food, Handmade Products, Health & Household, Home & Kitchen, Industrial & Scientific, Kindle Store, Movies & TV, Musical Instruments, Office Products, Patio Lawn & Garden, Pet Supplies, Software, Sports & Outdoors, Tools & Home Improvement, Toys & Games, Video Games. Other marketplaces use their own localised names -- read them from available_filters.categories of any deals answer for that geo. An unknown name is a free 400 listing the valid names.",
"title": "Categories"
},
"brands": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Comma-separated brand ids, e.g. 46655 for Samsung on US. Take them from brand_id on any deals row or from available_filters.brands (the brands present in the current result). Names resolve only when this marketplace has already shown that brand; for a brand by name use /search with brand=<name> and today_deals=true instead.",
"title": "Brands"
},
"min_product_star_rating": {
"anyOf": [
{
"enum": [
"4",
"ALL"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Amazon's deals feed offers one rating cut-off: 4 = four stars and up. ALL or omitted = no cut-off. Other values are rejected with a free 400.",
"title": "Min Product Star Rating"
},
"min_price": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Lowest deal price to return, in the marketplace currency. Applied to the fetched rows; see notes.",
"title": "Min Price"
},
"max_price": {
"anyOf": [
{
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Highest deal price to return, in the marketplace currency.",
"title": "Max Price"
},
"min_discount": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Smallest discount percentage to return, e.g. 50 for half price or better.",
"title": "Min Discount"
},
"max_discount": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Largest discount percentage to return.",
"title": "Max Discount"
},
"prime_exclusive": {
"default": false,
"description": "Only deals in Amazon's Prime Exclusive program.",
"title": "Prime Exclusive",
"type": "boolean"
},
"prime_early_access": {
"default": false,
"description": "Only Prime Early Access deals. A marketplace lists the programs it is running under available_filters.prime_programs; when Early Access is not running the answer is empty with a hint saying so.",
"title": "Prime Early Access",
"type": "boolean"
},
"limit": {
"default": 10,
"description": "How many deals to return from this page (0 = all of them). A full page is 30 rows and roughly 35 KB with every field, which most clients spill to a file instead of showing inline. The answer carries _truncated with the true count when it trims.",
"minimum": 0,
"title": "Limit",
"type": "integer"
},
"compact": {
"default": true,
"description": "Return light rows: identity, prices, discount, badge, end time, links, brand_id and department_ids, dropping the image arrays. false returns every field the REST API sends.",
"title": "Compact",
"type": "boolean"
},
"fields": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Comma-separated row fields to return instead of the light set, e.g. \"asin,product_title,product_price\". Rows list what they left out under _omitted_fields.",
"title": "Fields"
}
},
"title": "dealsArguments"
}
