{"openapi":"3.1.0","info":{"title":"Canopy API - REST Endpoints","version":"1.0.0","description":"# Canopy API - Comprehensive Amazon Data Platform\n\n## Overview\nThe Canopy API provides comprehensive access to Amazon product data through a robust REST interface. Our API delivers real-time Amazon product information, search results, category data, and market insights.\n\n## Features\n- **Product Information**: Detailed product data including titles, prices, ratings, images, and specifications\n- **Search & Discovery**: Powerful search with filtering, autocomplete, and category browsing\n- **Market Intelligence**: Sales estimates, stock levels, and competitive insights\n- **Multi-Domain Support**: Access data from Amazon marketplaces worldwide (US, UK, CA, DE, FR, IT, ES, AU, IN, MX, BR, JP, PL, AE)\n- **Real-Time Data**: Live product information with high accuracy and freshness\n- **Developer-Friendly**: RESTful design with comprehensive documentation and SDKs\n\n## Authentication\nAll API requests require a valid API key passed in the `API-KEY` header. You can obtain an API key by signing up at [canopyapi.co](https://www.canopyapi.co).\n\n## Support\n- **Documentation**: [docs.canopyapi.co](https://docs.canopyapi.co)\n- **Support**: [support@canopyapi.co](mailto:support@canopyapi.co)","termsOfService":"https://www.canopyapi.co/terms-of-service","contact":{"name":"Canopy API Support","url":"https://www.canopyapi.co/contact","email":"support@canopyapi.co"},"license":{"name":"Commercial License","url":"https://www.canopyapi.co/license"}},"security":[{"ApiKeyAuth":[]}],"servers":[{"url":"https://rest.canopyapi.co","description":"Production API Server"}],"tags":[{"name":"Amazon","description":"Endpoints for Amazon product data, search, categories, and market intelligence"}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"API key from your Canopy dashboard at https://www.canopyapi.co/dashboard"}},"schemas":{"AmazonProductPrice":{"type":"object","properties":{"symbol":{"type":"string"},"value":{"type":"number"},"currency":{"type":"string"},"display":{"type":"string"}},"required":["symbol","value","currency","display"]},"AmazonPageInfo":{"type":"object","properties":{"currentPage":{"type":"number"},"totalPages":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"},"totalResults":{"type":"number"}}}},"parameters":{}},"paths":{"/api/amazon/product":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Information","operationId":"get_AmazonProduct","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"title":{"type":"string"},"itemHighlights":{"type":["string","null"]},"subtitle":{"type":"string"},"brand":{"type":"string"},"url":{"type":"string"},"asin":{"type":"string"},"isPrime":{"type":"boolean"},"isNew":{"type":"boolean"},"isInStock":{"type":"boolean"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"mainImageUrl":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string"}},"rating":{"type":"number"},"ratingsTotal":{"type":"number"},"featureBullets":{"type":"array","items":{"type":"string"}},"technicalSpecifications":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"breadcrumbPath":{"type":"string"}}}},"coupon":{"type":["object","null"],"properties":{"label":{"type":"string"}},"required":["label"]},"seller":{"type":"object","properties":{"sellerId":{"type":"string"},"name":{"type":"string"}}}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/gtin-from-asin":{"get":{"tags":["Amazon"],"summary":"Get GTIN from ASIN","description":"Look up the GTIN (ISBN, UPC or EAN code) for an Amazon product by its ASIN.","operationId":"get_AmazonGtinFromAsin","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":true,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns the GTIN for the provided ASIN","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"asin":{"type":"string"},"gtin":{"type":["string","null"]}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/asin-from-gtin":{"get":{"tags":["Amazon"],"summary":"Get ASIN from GTIN","description":"Look up the ASIN for an Amazon product by its GTIN (ISBN, UPC or EAN code).","operationId":"get_AmazonAsinFromGtin","parameters":[{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":true,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns the ASIN for the provided GTIN","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"asin":{"type":["string","null"]},"gtin":{"type":"string"}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/variants":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Variants","operationId":"get_AmazonProductVariants","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product variants","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"variants":{"type":"array","items":{"type":"object","properties":{"asin":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"},"attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]}}}}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/stock":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Stock Estimates","operationId":"get_AmazonStockEstimates","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product stock estimates","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"stockEstimate":{"type":"object","properties":{"offerId":{"type":"string"},"inStock":{"type":"boolean"},"stockLevel":{"type":"number"},"availabilityMessage":{"type":"string"}},"required":["inStock"]}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/sales":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Sales Estimates","operationId":"get_AmazonSalesEstimates","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product sales estimates","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"salesEstimate":{"type":"object","properties":{"weeklyUnitSales":{"type":"number"},"monthlyUnitSales":{"type":"number"},"annualUnitSales":{"type":"number"}}}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/reviews":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Reviews (paginated)","description":"Retrieve customer reviews for a product with pagination, filtering, and sorting. Pages beyond the first require an AMAZON_COOKIE header. For a quick, cookie-free snapshot of the most helpful reviews, use the Top Reviews endpoint instead.","operationId":"get_AmazonProductReviews","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"integer","minimum":1,"description":"Page number for paginated reviews (default 1)"},"required":false,"description":"Page number for paginated reviews (default 1)","name":"page","in":"query"},{"schema":{"type":["boolean","null"],"description":"Only include reviews from verified purchasers"},"required":false,"description":"Only include reviews from verified purchasers","name":"onlyVerifiedReviews","in":"query"},{"schema":{"type":"string","enum":["ALL","FIVE_STAR","FOUR_STAR","THREE_STAR","TWO_STAR","ONE_STAR"],"description":"Filter paginated reviews by star rating"},"required":false,"description":"Filter paginated reviews by star rating","name":"rating","in":"query"},{"schema":{"type":"string","description":"Filter paginated reviews by search term"},"required":false,"description":"Filter paginated reviews by search term","name":"search","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"},{"schema":{"type":"string","description":"Your signed-in Amazon session cookie string, required for paginated reviews. Sign in to Amazon in Chrome or Safari, open DevTools > Network, filter by \"Doc\", load a product page, and copy the full value of the request \"Cookie\" header. The account must match the Amazon domain being queried. The cookie is used only for this request and is never stored."},"required":false,"description":"Your signed-in Amazon session cookie string, required for paginated reviews. Sign in to Amazon in Chrome or Safari, open DevTools > Network, filter by \"Doc\", load a product page, and copy the full value of the request \"Cookie\" header. The account must match the Amazon domain being queried. The cookie is used only for this request and is never stored.","name":"AMAZON_COOKIE","in":"header"}],"responses":{"200":{"description":"Returns Amazon product top reviews","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"topReviews":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string"}},"videos":{"type":"array","items":{"type":"object","properties":{"posterImageUrl":{"type":"string"},"url":{"type":"string"}}}},"rating":{"type":"number"},"helpfulVotes":{"type":"number"},"verifiedPurchase":{"type":"boolean"},"reviewer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}}},"reviewsPaginated":{"type":"object","properties":{"reviews":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string"}},"videos":{"type":"array","items":{"type":"object","properties":{"posterImageUrl":{"type":"string"},"url":{"type":"string"}}}},"rating":{"type":"number"},"helpfulVotes":{"type":"number"},"verifiedPurchase":{"type":"boolean"},"reviewer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}}},"pageInfo":{"type":"object","properties":{"currentPage":{"type":"number"},"totalPages":{"type":"number"},"totalResults":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"}}}}}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/top-reviews":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Top Reviews","description":"Retrieve the product page's top (most helpful) reviews in a single request — no pagination, filters, or AMAZON_COOKIE header. For the full paginated review list, use the Reviews endpoint.","operationId":"get_AmazonProductTopReviews","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product top reviews","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"topReviews":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"body":{"type":"string"},"imageUrls":{"type":"array","items":{"type":"string"}},"videos":{"type":"array","items":{"type":"object","properties":{"posterImageUrl":{"type":"string"},"url":{"type":"string"}}}},"rating":{"type":"number"},"helpfulVotes":{"type":"number"},"verifiedPurchase":{"type":"boolean"},"reviewer":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}}}}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/offers":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Offers","operationId":"get_AmazonProductOffers","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"number","description":"The page number for offers results"},"required":false,"description":"The page number for offers results","name":"page","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product offers","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"offersPaginated":{"type":["object","null"],"properties":{"offers":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"minimumOrderQuantity":{"type":"number"},"maximumOrderQuantity":{"type":"number"},"conditionIsNew":{"type":"boolean"},"title":{"type":"string"},"delivery":{"type":["object","null"],"properties":{"fulfilledByAmazon":{"type":"boolean"},"shippedFromOutsideCountry":{"type":"boolean"},"countdown":{"type":"string"},"comments":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"upsell":{"type":["object","null"],"properties":{"name":{"type":"string"},"value":{"type":"string"}}}}},"seller":{"type":["object","null"],"properties":{"name":{"type":"string"},"link":{"type":"string"},"rating":{"type":"number"},"ratingsPercentagePositive":{"type":"number"},"ratingsTotal":{"type":"number"},"id":{"type":"string"},"imageUrl":{"type":"string"}}},"isPrime":{"type":"boolean"},"buyboxWinner":{"type":"boolean"}}}},"pageInfo":{"anyOf":[{"$ref":"#/components/schemas/AmazonPageInfo"},{"type":"null"}]}}}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/a-plus-content":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product A+ Content","operationId":"get_AmazonAPlusContent","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product A+ Content","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProduct":{"type":"object","properties":{"aPlusContent":{"type":["object","null"],"properties":{"thirdParty":{"type":"boolean"},"companyLogo":{"type":"string"},"companyDescriptionText":{"type":"string"},"html":{"type":"string"},"text":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"alt":{"type":"string"}}}},"brandStory":{"type":["object","null"],"properties":{"heroImage":{"type":"string"},"brandStoreId":{"type":"string"},"brandStoreUrl":{"type":"string"},"images":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"alt":{"type":"string"}}}}}}}}}}},"required":["amazonProduct"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/html":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Page HTML","operationId":"get_AmazonProductHtml","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns the raw HTML of the Amazon product page","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProductPage":{"type":"object","properties":{"html":{"type":"string","description":"The raw HTML of the Amazon product page"}},"required":["html"]}},"required":["amazonProductPage"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/product/markdown":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Page Markdown","operationId":"get_AmazonProductMarkdown","parameters":[{"schema":{"type":"string","description":"The ASIN for a product (e.g. B0F7K8DPPT)"},"required":false,"description":"The ASIN for a product (e.g. B0F7K8DPPT)","name":"asin","in":"query"},{"schema":{"type":"string","description":"The Amazon URL for a product"},"required":false,"description":"The Amazon URL for a product","name":"url","in":"query"},{"schema":{"type":"string","description":"The GTIN (ISBN, UPC or EAN code) for a product"},"required":false,"description":"The GTIN (ISBN, UPC or EAN code) for a product","name":"gtin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product data, defaults to US."},"required":false,"description":"The domain for fetching product data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns the Amazon product page converted to Markdown. Send `Accept: text/markdown` to get the Markdown document as the raw response body instead of a JSON string.","content":{"text/markdown":{"schema":{"type":"string"}},"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProductPage":{"type":"object","properties":{"markdown":{"type":"string","description":"The Amazon product page converted to Markdown, scoped to the product content (title, price, bullets, A+ Content, product details and description)"}},"required":["markdown"]}},"required":["amazonProductPage"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/search":{"get":{"tags":["Amazon"],"summary":"Search Amazon Products","operationId":"get_AmazonProductSearchResults","parameters":[{"schema":{"type":"string","description":"The search term for fetching search results"},"required":true,"description":"The search term for fetching search results","name":"searchTerm","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching search results data, defaults to US."},"required":false,"description":"The domain for fetching search results data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"An optional Amazon browse-node ID used to filter search results. Any valid browse-node ID for the marketplace is accepted (not limited to the Categories endpoint taxonomy, and not interchangeable with Bestsellers slugs)."},"required":false,"description":"An optional Amazon browse-node ID used to filter search results. Any valid browse-node ID for the marketplace is accepted (not limited to the Categories endpoint taxonomy, and not interchangeable with Bestsellers slugs).","name":"categoryId","in":"query"},{"schema":{"type":"number","default":1,"description":"The page number requested for product results"},"required":false,"description":"The page number requested for product results","name":"page","in":"query"},{"schema":{"type":"number","description":"Optionally limit the products results, typically between 20-40 results"},"required":false,"description":"Optionally limit the products results, typically between 20-40 results","name":"limit","in":"query"},{"schema":{"type":"number","description":"Minimum price filter"},"required":false,"description":"Minimum price filter","name":"minPrice","in":"query"},{"schema":{"type":"number","description":"Maximum price filter"},"required":false,"description":"Maximum price filter","name":"maxPrice","in":"query"},{"schema":{"type":"string","description":"Product conditions (NEW, USED, RENEWED) - comma separated"},"required":false,"description":"Product conditions (NEW, USED, RENEWED) - comma separated","name":"conditions","in":"query"},{"schema":{"type":"string","default":"FEATURED","description":"Sort order (FEATURED, MOST_RECENT, PRICE_ASCENDING, PRICE_DESCENDING, AVERAGE_CUSTOMER_REVIEW)"},"required":false,"description":"Sort order (FEATURED, MOST_RECENT, PRICE_ASCENDING, PRICE_DESCENDING, AVERAGE_CUSTOMER_REVIEW)","name":"sort","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product search results","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProductSearchResults":{"type":"object","properties":{"availableRefinements":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}}}}}}},"productResults":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"asin":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"mainImageUrl":{"type":"string"},"rating":{"type":"number"},"ratingsTotal":{"type":"number"},"isPrime":{"type":"boolean"},"sponsored":{"type":"boolean"},"coupon":{"type":["object","null"],"properties":{"label":{"type":"string"}},"required":["label"]}}}},"pageInfo":{"anyOf":[{"$ref":"#/components/schemas/AmazonPageInfo"},{"type":"null"}]}}}}}},"required":["amazonProductSearchResults"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/autocomplete":{"get":{"tags":["Amazon"],"summary":"Get Amazon Search Autocomplete Results","operationId":"get_AmazonSearchAutocompleteResults","parameters":[{"schema":{"type":"string","description":"The search term for fetching autocomplete results"},"required":true,"description":"The search term for fetching autocomplete results","name":"searchTerm","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching autocomplete data, defaults to US."},"required":false,"description":"The domain for fetching autocomplete data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"The search autocomplete_alias in the amazon url parameter"},"required":false,"description":"The search autocomplete_alias in the amazon url parameter","name":"category","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon search autocomplete results","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonSearchAutocompleteResults":{"type":"array","items":{"type":"object","properties":{"suggestion":{"type":"string"}},"required":["suggestion"]}}},"required":["amazonSearchAutocompleteResults"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/categories":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Category Taxonomy","operationId":"get_AmazonProductCategoryTaxonomy","parameters":[{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product category taxonomy, defaults to US."},"required":false,"description":"The domain for fetching product category taxonomy, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns root level Amazon product categories","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProductCategoryTaxonomy":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"breadcrumbPath":{"type":"string"}},"required":["id","name","url","breadcrumbPath"]}}},"required":["amazonProductCategoryTaxonomy"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/category":{"get":{"tags":["Amazon"],"summary":"Get Amazon Product Category Information","operationId":"get_AmazonProductCategory","parameters":[{"schema":{"type":"string","description":"A category ID returned by the Categories endpoint (typically numeric). This endpoint only supports IDs from that taxonomy — other Amazon browse-node IDs return a 400. To filter by an arbitrary browse-node ID, use the Search endpoint's categoryId parameter instead."},"required":true,"description":"A category ID returned by the Categories endpoint (typically numeric). This endpoint only supports IDs from that taxonomy — other Amazon browse-node IDs return a 400. To filter by an arbitrary browse-node ID, use the Search endpoint's categoryId parameter instead.","name":"categoryId","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching product category data, defaults to US."},"required":false,"description":"The domain for fetching product category data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"number","default":1,"description":"The page number requested for product results"},"required":false,"description":"The page number requested for product results","name":"page","in":"query"},{"schema":{"type":"string","default":"FEATURED","description":"Sort order (FEATURED, MOST_RECENT, PRICE_ASCENDING, PRICE_DESCENDING, AVERAGE_CUSTOMER_REVIEW)"},"required":false,"description":"Sort order (FEATURED, MOST_RECENT, PRICE_ASCENDING, PRICE_DESCENDING, AVERAGE_CUSTOMER_REVIEW)","name":"sort","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon product category information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonProductCategory":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"breadcrumbPath":{"type":"string"},"subcategories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"breadcrumbPath":{"type":"string"}}}},"productResults":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"asin":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"mainImageUrl":{"type":"string"},"rating":{"type":"number"},"ratingsTotal":{"type":"number"},"isPrime":{"type":"boolean"},"sponsored":{"type":"boolean"}}}},"pageInfo":{"anyOf":[{"$ref":"#/components/schemas/AmazonPageInfo"},{"type":"null"}]}}}}}},"required":["amazonProductCategory"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/seller":{"get":{"tags":["Amazon"],"summary":"Get Amazon Seller Information","operationId":"get_AmazonSeller","parameters":[{"schema":{"type":"string","description":"The Amazon seller ID (e.g. A2L77EE7U53NWQ, Amazon Resale on the US marketplace). Seller IDs are marketplace-specific; obtain a current one from a product response. A seller with no active listings returns seller details with an empty productResults list."},"required":true,"description":"The Amazon seller ID (e.g. A2L77EE7U53NWQ, Amazon Resale on the US marketplace). Seller IDs are marketplace-specific; obtain a current one from a product response. A seller with no active listings returns seller details with an empty productResults list.","name":"sellerId","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching seller data, defaults to US."},"required":false,"description":"The domain for fetching seller data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"number","default":1,"description":"The page number requested for product results"},"required":false,"description":"The page number requested for product results","name":"page","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon seller information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonSeller":{"type":"object","properties":{"sellerId":{"type":"string"},"name":{"type":"string"},"logoUrl":{"type":"string"},"phone":{"type":"string"},"rating":{"type":"number"},"about":{"type":"string"},"productResults":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"asin":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"mainImageUrl":{"type":"string"},"rating":{"type":"number"},"ratingsTotal":{"type":"number"},"isPrime":{"type":"boolean"},"sponsored":{"type":"boolean"}}}},"pageInfo":{"anyOf":[{"$ref":"#/components/schemas/AmazonPageInfo"},{"type":"null"}]}}}}}},"required":["amazonSeller"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/author":{"get":{"tags":["Amazon"],"summary":"Get Amazon Author Information","operationId":"get_AmazonAuthor","parameters":[{"schema":{"type":"string","description":"The asin ID for the author (e.g. B017M7UJX6)"},"required":true,"description":"The asin ID for the author (e.g. B017M7UJX6)","name":"asin","in":"query"},{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching author data, defaults to US."},"required":false,"description":"The domain for fetching author data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"number","default":1,"description":"The page number requested for book results"},"required":false,"description":"The page number requested for book results","name":"page","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon author information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonAuthor":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"imageUrl":{"type":"string"},"biography":{"type":"string"},"bookResults":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"asin":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"mainImageUrl":{"type":"string"},"rating":{"type":"number"},"ratingsTotal":{"type":"number"},"isPrime":{"type":"boolean"},"sponsored":{"type":"boolean"},"authors":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"}}}}}}},"pageInfo":{"anyOf":[{"$ref":"#/components/schemas/AmazonPageInfo"},{"type":"null"}]}}}}}},"required":["amazonAuthor"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/deals":{"get":{"tags":["Amazon"],"summary":"Get Amazon Deals","description":"Retrieve current deals from Amazon. Returns a paginated list of products currently on deal, including deal-specific information like discount percentages and deal badges.","operationId":"get_AmazonDeals","parameters":[{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching deals data, defaults to US."},"required":false,"description":"The domain for fetching deals data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"number","default":1,"description":"The page number requested for product results"},"required":false,"description":"The page number requested for product results","name":"page","in":"query"},{"schema":{"type":"number","description":"Optionally limit the products results. Typically between 20-40 results will be available per page if no limit is applied."},"required":false,"description":"Optionally limit the products results. Typically between 20-40 results will be available per page if no limit is applied.","name":"limit","in":"query"},{"schema":{"type":"string","description":"Optional comma-separated list of category IDs to filter deals (e.g. \"3760911,172282\"). Category IDs can be discovered via the Categories API or from the categories array in deals responses."},"required":false,"description":"Optional comma-separated list of category IDs to filter deals (e.g. \"3760911,172282\"). Category IDs can be discovered via the Categories API or from the categories array in deals responses.","name":"categoryIds","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon deals with product information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonDeals":{"type":"object","properties":{"productResults":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"asin":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"recommendedRetailPrice":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"mainImageUrl":{"type":"string"},"dealId":{"type":"string"},"dealUrl":{"type":"string"},"dealPrice":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"dealCurrentPrice":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"dealListPrice":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"dealPercentOff":{"type":"number"},"dealType":{"type":"string"},"dealIsLightningDeal":{"type":"boolean"},"dealBadge":{"type":"string"},"dealStartTime":{"type":"string"},"dealEndTime":{"type":"string"}}}},"pageInfo":{"anyOf":[{"$ref":"#/components/schemas/AmazonPageInfo"},{"type":"null"}]}}}}}},"required":["amazonDeals"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/bestsellers":{"get":{"tags":["Amazon"],"summary":"Get Amazon Best Sellers","description":"Retrieve Amazon Best Sellers rankings. Returns a paginated list of top-ranked products by category, including rank position, ratings, and category navigation information.","operationId":"get_AmazonBestSellers","parameters":[{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching best sellers data, defaults to US."},"required":false,"description":"The domain for fetching best sellers data, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"number","default":1,"description":"The page number requested for product results"},"required":false,"description":"The page number requested for product results","name":"page","in":"query"},{"schema":{"type":"number","description":"Optionally limit the products results. Typically between 20-50 results will be available per page if no limit is applied."},"required":false,"description":"Optionally limit the products results. Typically between 20-50 results will be available per page if no limit is applied.","name":"limit","in":"query"},{"schema":{"type":"string","description":"A bestseller category slug (e.g. bestsellers_electronics), required if url is not provided. Discover slugs via the Bestseller Categories endpoint. Slugs are marketplace-specific — fetch them separately for each domain; they are not interchangeable with the numeric IDs used by the Category or Search endpoints."},"required":false,"description":"A bestseller category slug (e.g. bestsellers_electronics), required if url is not provided. Discover slugs via the Bestseller Categories endpoint. Slugs are marketplace-specific — fetch them separately for each domain; they are not interchangeable with the numeric IDs used by the Category or Search endpoints.","name":"categoryId","in":"query"},{"schema":{"type":"string","description":"The Amazon URL of a best sellers page (required if categoryId is not provided), e.g. a url returned by the Bestseller Categories endpoint. The URL determines the marketplace, so the domain parameter is ignored when url is used."},"required":false,"description":"The Amazon URL of a best sellers page (required if categoryId is not provided), e.g. a url returned by the Bestseller Categories endpoint. The URL determines the marketplace, so the domain parameter is ignored when url is used.","name":"url","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns Amazon best sellers with product information","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonBestSellers":{"type":"object","properties":{"productResults":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"},"asin":{"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/AmazonProductPrice"},{"type":"null"}]},"mainImageUrl":{"type":"string"},"rating":{"type":"number"},"ratingsTotal":{"type":"number"},"bestSellersRank":{"type":"number"}}}},"pageInfo":{"anyOf":[{"$ref":"#/components/schemas/AmazonPageInfo"},{"type":"null"}]}}},"categoryInfo":{"type":"object","properties":{"currentCategory":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"id":{"type":"string"}}},"parentCategory":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"id":{"type":"string"}}},"childCategories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"id":{"type":"string"}}}}}}}}},"required":["amazonBestSellers"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}},"/api/amazon/bestseller-categories":{"get":{"tags":["Amazon"],"summary":"Get Amazon Best Seller Categories","description":"Returns the list of top-level Best Seller category IDs (e.g. bestsellers_amazon_devices) for an Amazon domain. Use the returned `id` with the `/api/amazon/bestsellers` endpoint.","operationId":"get_AmazonBestSellerCategories","parameters":[{"schema":{"type":"string","enum":["US","UK","CA","DE","FR","IT","ES","AU","IN","MX","BR","JP","PL","AE","SG","NL","SE"],"default":"US","description":"The domain for fetching best seller categories, defaults to US."},"required":false,"description":"The domain for fetching best seller categories, defaults to US.","name":"domain","in":"query"},{"schema":{"type":"string","description":"API key for authentication"},"required":true,"description":"API key for authentication","name":"API-KEY","in":"header"}],"responses":{"200":{"description":"Returns the list of best seller categories","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"amazonBestSellerCategories":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":["string","null"]},"name":{"type":["string","null"]},"url":{"type":["string","null"]}},"required":["id","name","url"]}}},"required":["categories"]}},"required":["amazonBestSellerCategories"]}},"required":["data"]}}}},"400":{"description":"Input Validation Error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"},"path":{"type":"array","items":{"type":"string"}}},"required":["code","message","path"]}}},"required":["success","errors"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false]},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"number"},"message":{"type":"string"}},"required":["code","message"]}}},"required":["success","errors"]}}}},"500":{"description":"Internal Server Error - request failed"}}}}},"webhooks":{}}