mws-zodane-advanced

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../"> <title data-ice="title">lib/list-order-items.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/list-order-items.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">/** * @module mws-advanced */ const { callEndpoint } = require('./callEndpoint'); const { digResponseResult } = require('./dig-response-result'); const { forceArray } = require('./util/transformers'); // TODO: make a typedef for OrderItem and document it correctly /** * @typedef OrderItemList * Object hash containing: * orderId - Amazon Order ID in 3-7-7 format * orderItems - Array of OrderItems * nextToken - If the list of items is longer than one request can accommodate, a nextToken will * be returned to pass to listOrderItemsByNextToken * * @public * @param {string} orderId - Amazon Order ID * @param {string} nextToken - Token to provide to ListOrderItemsByNextToken if needed (no token = no need) * @param {Array} orderItems - Array of all the items in the order */ /** * Returns order items based on the AmazonOrderId that you specify. * * If you've pulled a list of orders using @see {@link ListOrders}, or have order identifiers * stored in some other fashion, then to find out what items are actually on the orders, you will * need to call ListOrderItems to obtain details about the items that were ordered. The ListOrders * call does not give you any information about the items, except how many of them have shipped or * not shipped. * * If an Order is in the Pending state, ListOrderItems will not return any pricing or promotion * information. Once an order has left the Pending state, the following items will be returned: * * ItemTax, GiftWrapPrice, ItemPrice, PromotionDiscount, GiftWrapTax, ShippingTax, ShippingPrice, * ShippingDiscount * * @public * @param {string} AmazonOrderId - 3-7-7 Amazon Order ID formatted string * @returns {OrderItemList} */ const listOrderItems = async (AmazonOrderId) => { const res = digResponseResult('ListOrderItems', await callEndpoint('ListOrderItems', { AmazonOrderId })); const arr = forceArray(res.OrderItems); const meh = arr.map(x => x.OrderItem); const ret = { nextToken: res.nextToken, orderId: res.AmazonOrderId, orderItems: meh, }; return ret; }; module.exports = { listOrderItems, }; </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>