mws-zodane-advanced

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">lib/endpoints/products.js | mws-advanced</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc">C<a href="class/lib/errors.js~InvalidUsage.html">InvalidUsage</a></li> <li data-ice="doc">C<a href="class/lib/errors.js~RequestCancelled.html">RequestCancelled</a></li> <li data-ice="doc">C<a href="class/lib/errors.js~ServiceError.html">ServiceError</a></li> <li data-ice="doc">C<a href="class/lib/errors.js~ValidationError.html">ValidationError</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-callEndpoint">callEndpoint</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-init">init</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getLowestPricedOffersForASIN">getLowestPricedOffersForASIN</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMarketplaces">getMarketplaces</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMatchingProductForId">getMatchingProductForId</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listFinancialEvents">listFinancialEvents</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listInventorySupply">listInventorySupply</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listOrderItems">listOrderItems</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listOrders">listOrders</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReport">getReport</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportList">getReportList</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportListAll">getReportListAll</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportListByNextToken">getReportListByNextToken</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportRequestList">getReportRequestList</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-requestAndDownloadReport">requestAndDownloadReport</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-requestReport">requestReport</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MWS_ENDPOINTS">MWS_ENDPOINTS</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MWS_MARKETPLACES">MWS_MARKETPLACES</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-BuyBoxPrice">BuyBoxPrice</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-DetailedShippingTime">DetailedShippingTime</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-LowestPrice">LowestPrice</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-LowestPricedOffers">LowestPricedOffers</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-Money">Money</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-Offer">Offer</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OfferCount">OfferCount</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OfferSummary">OfferSummary</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-SellerFeedbackRating">SellerFeedbackRating</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-ShipsFrom">ShipsFrom</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-MarketDetail">MarketDetail</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OrderItemList">OrderItemList</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-GetReportRequestListResult">GetReportRequestListResult</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-GetReportRequestListResult">GetReportRequestListResult</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-ReportRequestInfo">ReportRequestInfo</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#endpoints">endpoints</a>V<a href="variable/index.html#static-variable-REPORT_PROCESSING_STATUS_TYPES">REPORT_PROCESSING_STATUS_TYPES</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-REQUEST_REPORT_TYPES">REQUEST_REPORT_TYPES</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">lib/endpoints/products.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">const generateEndpoints = require('./endpoints-utils'); const categoryName = 'Products'; const apiVersion = '2011-10-01'; const endpointList = [ 'ListMatchingProducts', 'GetMatchingProduct', 'GetMatchingProductForId', 'GetCompetitivePricingForSKU', 'GetCompetitivePricingForASIN', 'GetLowestOfferListingsForSKU', 'GetLowestOfferListingsForASIN', 'GetLowestPricedOffersForSKU', 'GetLowestPricedOffersForASIN', 'GetMyFeesEstimate', 'GetMyPriceForSKU', 'GetMyPriceForASIN', 'GetProductCategoriesForSKU', 'GetProductCategoriesForASIN', 'GetServiceStatus', ]; const newEndpointList = { GetMatchingProduct: { throttle: { maxInFlight: 1, restoreRate: 1, }, params: { // this will cause an error to throw if you attempt to use this function. // The official documentation says to use GetMatchingProductForId instead, so we'll // just enforce that. DEPRECATED_USE_GetMatchingProductForId_INSTEAD: { type: 'xs:string', required: true, }, }, }, GetMatchingProductForId: { throttle: { maxInFlight: 20, restoreRate: 300, }, params: { MarketplaceId: { type: 'xs:string', // TODO: doc says "MarketplaceType" -- should we validate as that? https://docs.developer.amazonservices.com/en_UK/products/Products_Datatypes.html#MarketplaceType required: true, }, IdType: { type: 'xs:string', required: true, values: ['ASIN', 'GCID', 'SellerSKU', 'UPC', 'EAN', 'ISBN', 'JAN'], }, IdList: { type: 'xs:string', required: true, list: 'IdList.Id', }, }, returns: { Product: { type: '', // TODO: ? required: false, }, Identifiers: { type: '', // TODO: ? required: false, }, Relationships: { type: '', // TODO: ? required: false, }, SalesRankings: { type: '', // TODO: ? required: false, }, }, }, GetLowestOfferListingsForASIN: { throttle: { maxInFlight: 20, restoreRate: 600, }, params: { MarketplaceId: { type: 'xs:string', // TODO: marketplaceId verification required: true, }, ASINList: { type: 'xs:string', required: true, list: 'ASINList.ASIN', }, }, returns: { AllOfferListingsConsidered: { type: '', // TODO: ??? Documentation is really not clear required: false, }, Product: { type: 'Product', // TODO: contains product subelements Product.Identifiers and Product.LowestOfferListings required: true, }, Identifiers: { type: '', // TODO: ??? Documnetation also not clear required: false, }, LowestOfferListings: { type: '', // TODO: ?????? required: true, }, }, }, GetLowestOfferListingsForSKU: { throttle: { maxInFlight: 20, restoreRate: 600, }, params: { MarketplaceId: { type: 'xs:string', // TODO: marketplaceId verification required: true, }, SellerSKUList: { type: 'xs:string', required: true, list: 'SellerSKUList.SellerSKU', }, }, returns: { AllOfferListingsConsidered: { type: '', // TODO: ??? Documentation is really not clear required: false, }, Product: { type: 'Product', // TODO: contains product subelements Product.Identifiers and Product.LowestOfferListings required: true, }, Identifiers: { type: '', // TODO: ??? Documnetation also not clear required: false, }, LowestOfferListings: { type: '', // TODO: ?????? required: true, }, }, }, GetLowestPricedOffersForASIN: { throttle: { maxInFlight: 10, restoreRate: 300, }, params: { MarketplaceId: { type: 'xs:string', // TODO: doc says 'MarketplaceType' required: true, }, ASIN: { type: 'xs:string', required: true, }, ItemCondition: { type: 'xs:string', required: true, values: ['New', 'Used', 'Collectible', 'Refurbished', 'Club'], }, }, returns: { Identifier: { type: 'Identifier', required: true, }, Summary: { type: 'Summary', required: true, }, Offers: { type: 'Offers', required: false, }, }, }, GetLowestPricedOffersForSKU: { throttle: { maxInFlight: 10, restoreRate: 300, }, params: { MarketplaceId: { type: 'xs:string', // TODO: doc says 'MarketplaceType' required: true, }, SellerSKU: { type: 'xs:string', required: true, }, ItemCondition: { type: 'xs:string', required: true, values: ['New', 'Used', 'Collectible', 'Refurbished', 'Club'], }, }, returns: { Identifier: { type: 'Identifier', required: true, }, Summary: { type: 'Summary', required: true, }, Offers: { type: 'Offers', required: false, }, }, }, GetCompetitivePricingForASIN: { throttle: { maxInFlight: 20, restoreRate: 600, }, params: { MarketplaceId: { type: 'xs:string', required: true, }, ASINList: { type: 'xs:string', required: true, // TODO: maximum 20 values list: 'ASINList.ASIN', }, }, returns: { Product: { type: 'Product', required: true, }, Identifiers: { type: 'Identifier', required: true, }, CompetitivePricing: { type: 'CompetitivePrice', required: true, }, SalesRankings: { type: 'SalesRanking', required: true, }, }, }, GetCompetitivePricingForSKU: { throttle: { maxInFlight: 20, restoreRate: 600, }, params: { MarketplaceId: { type: 'xs:string', required: true, }, SellerSKUList: { type: 'xs:string', required: true, // TODO: maximum 20 values list: 'SellerSKUList.SellerSKU', }, }, returns: { Product: { type: 'Product', required: true, }, Identifiers: { type: 'Identifier', required: true, }, CompetitivePricing: { type: 'CompetitivePrice', required: true, }, SalesRankings: { type: 'SalesRanking', required: true, }, }, }, GetMyPriceForASIN: { throttle: { maxInFlight: 20, restoreRate: 600, }, params: { MarketplaceId: { type: 'xs:string', required: true, }, ASINList: { type: 'xs:string', required: true, list: 'ASINList.ASIN', }, ItemCondition: { type: 'xs:string', values: ['New', 'Used', 'Collectible', 'Refurbished', 'Club'], }, }, returns: { Identifiers: { type: 'Identifier', required: true, }, BuyingPrice: { type: 'BuyingPrice', required: true, }, RegularPrice: { type: 'RegularPrice', required: true, }, FulfillmentChannel: { type: 'FulfillmentChannel', required: true, }, ItemCondition: { type: 'ItemCondition', required: true, }, ItemSubCondition: { type: 'ItemSubCondition', required: true, }, SellerId: { type: 'SellerId', required: true, }, SellerSKU: { type: 'SellerSKU', required: true, }, }, }, GetMyPriceForSKU: { throttle: { maxInFlight: 20, restoreRate: 600, }, params: { MarketplaceId: { type: 'xs:string', required: true, }, SellerSKUList: { type: 'xs:string', required: true, list: 'SellerSKUList.SellerSKU', }, ItemCondition: { type: 'xs:string', values: ['New', 'Used', 'Collectible', 'Refurbished', 'Club'], }, }, returns: { Identifiers: { type: 'Identifier', required: true, }, BuyingPrice: { type: 'BuyingPrice', required: true, }, RegularPrice: { type: 'RegularPrice', required: true, }, FulfillmentChannel: { type: 'FulfillmentChannel', required: true, }, ItemCondition: { type: 'ItemCondition', required: true, }, ItemSubCondition: { type: 'ItemSubCondition', required: true, }, SellerId: { type: 'SellerId', required: true, }, SellerSKU: { type: 'SellerSKU', required: true, }, }, }, GetProductCategoriesForASIN: { throttle: { maxInFlight: 20, restoreRate: 12, }, params: { MarketplaceId: { type: 'xs:string', // TODO: validate marketplaceId required: true, }, ASIN: { type: 'xs:string', required: true, }, }, returns: { // TODO: fill this in }, }, GetProductCategoriesForSKU: { throttle: { maxInFlight: 20, restoreRate: 12, }, params: { MarketplaceId: { type: 'xs:string', // TODO: validate marketplaceId required: true, }, SellerSKU: { type: 'xs:string', required: true, }, }, returns: { // TODO: fill this in }, }, GetServiceStatus: { throttle: { maxInFlight: 2, restoreRate: 0.20, }, }, // GetMyFeesEstimate: { // throttle: { // maxInFlight: 20, // restoreRate: 600, // }, // params: { // FeesEstimateRequestList: { // // https://docs.developer.amazonservices.com/en_UK/products/Products_Datatypes.html#FeesEstimateRequest // // TODO: we don't support custom objects. // // This looks like // // FeesEstimateRequestList.FeesEstimateRequest.1= // // { // // IdType: 'ASIN', // type: 'MarketplaceType', values: ['ASIN', 'SellerSKU'], // // IdValue: 'B002KT3XQM', // type: 'xs:string' // // IsAmazonFulled: true, // type: 'xs:boolean', // // Identifier: 'request1', // type: 'xs:string' // // PriceToEstimateFees: { // // ListingPrice: { // // CurrencyCode: 'USD', // // Amount: '30.00', // // }, // // Shipping: { // // CurrencyCode: 'USD', // // Amount: '3.99', // // }, // // Points: { // // PointsNumber: 0, // // }, // // }, // // } // type: 'FeesEstimateRequest', // required: true, // }, // }, // returns: { // }, // } }; /** * @private */ const endpoints = generateEndpoints( categoryName, apiVersion, endpointList, newEndpointList, ); module.exports = endpoints; </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.0.4)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>