mws-zodane-advanced

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">lib/endpoints/orders.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/orders.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">const path = require('path'); const generateEndpoints = require('./endpoints-utils'); const scriptName = path.basename(__filename, '.js'); const categoryName = `${scriptName.charAt(0).toUpperCase()}${scriptName.slice(1)}`; const apiVersion = '2013-09-01'; const endpointList = [ 'ListOrders', 'ListOrdersByNextToken', 'GetOrder', 'ListOrderItems', 'ListOrderItemsByNextToken', 'GetServiceStatus', ]; const newEndpointList = { ListOrders: { throttle: { maxInFlight: 6, restoreRate: 1, }, params: { CreatedAfter: { type: 'xs:dateTime', required: false, // TODO: Yes, if LastUpdatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. }, CreatedBefore: { type: 'xs:dateTime', required: false, // TODO: Must be later than CreatedAfter }, LastUpdatedAfter: { type: 'xs:dateTime', required: false, // TODO: Yes, if CreatedAfter is not specified. Specifying both CreatedAfter and LastUpdatedAfter returns an error. If LastUpdatedAfter is specified, then BuyerEmail and SellerOrderId cannot be specified. }, LastUpdatedBefore: { type: 'xs:dateTime', required: false, // TODO: msut be later than LastUpdatedAfter }, OrderStatus: { type: 'xs:string', required: false, values: ['PendingAvailability', 'Pending', 'Unshipped', 'PartiallyShipped', 'Shipped', 'InvoiceUnconfirmed', 'Canceled', 'Unfulfillable'], list: 'OrderStatus.Status', }, MarketplaceId: { type: 'xs:string', required: true, list: 'MarketplaceId.Id', }, FulfillmentChannel: { type: 'xs:string', required: false, list: 'FulfillmentChannel.Channel', }, PaymentMethod: { type: 'xs:string', required: false, list: 'PaymentMethod.Method', }, BuyerEmail: { type: 'xs:string', required: false, // TODO: If BuyerEmail is specified, then FulfillmentChannel, OrderStatus, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and SellerOrderId cannot be specified. }, SellerOrderId: { type: 'xs:string', required: false, // TODO: If SellerOrderId is specified, then FulfillmentChannel, OrderStatus, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified. }, MaxResultsPerPage: { type: 'xs:positiveInteger', required: false, }, TFMShipmentStatus: { // only available in China market type: 'xs:string', required: false, values: ['PendingPickUp', 'LabelCanceled', 'PickedUp', 'AtDestinationFC', 'Delivered', 'RejectedByBuyer', 'Undeliverable', 'ReturnedToSeller', 'Lost'], }, }, returns: { NextToken: { type: 'xs:string', required: false, }, LastUpdatedBefore: { type: 'xs:dateTime', required: false, // ONE OF: LastUpdatedBefore, CreatedBefore }, CreatedBefore: { type: 'xs:dateTime', required: false, // ONE OF: LastUpdatedBefore, CreatedBefore }, Orders: { type: 'Order', required: false, list: 'Orders', }, }, }, ListOrdersByNextToken: { throttle: { maxInFlight: 6, restoreRate: 1, }, params: { NextToken: { type: 'xs:string', required: true, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, LastUpdatedBefore: { type: 'xs:dateTime', required: false, // ONE OF: LastUpdatedBefore, CreatedBefore }, CreatedBefore: { type: 'xs:dateTime', required: false, // ONE OF: LastUpdatedBefore, CreatedBefore }, Orders: { type: 'Order', required: false, list: 'Orders', }, }, }, GetOrder: { throttle: { maxInFlight: 6, restoreRate: 1, }, params: { AmazonOrderId: { type: 'xs:string', required: true, list: 'AmazonOrderId.Id', listMax: 50, }, }, returns: { Orders: { type: 'Order', required: true, }, }, }, ListOrderItems: { throttle: { maxInFlight: 30, restoreRate: 30, }, params: { AmazonOrderId: { type: 'xs:string', required: true, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, AmazonOrderId: { // TODO: we could implement format-specifiers as well, this must be 3-7-7 .. type: 'xs:string', required: true, }, OrderItems: { type: 'OrderItem', required: true, }, }, }, ListOrderItemsByNextToken: { throttle: { maxInFlight: 30, restoreRate: 30, }, params: { NextToken: { type: 'xs:string', required: true, }, }, returns: { NextToken: { type: 'xs:string', required: false, }, AmazonOrderId: { // TODO: we could implement format-specifiers as well, this must be 3-7-7 .. type: 'xs:string', required: true, }, OrderItems: { type: 'OrderItem', required: true, }, }, }, GetServiceStatus: { throttle: { maxInFlight: 2, restoreRate: 0.20, }, params: { }, returns: { Status: { type: 'xs:string', required: true, // TODO: mws docs don't specify which items are required here, assume status would be? }, Timestamp: { type: 'xs:dateTime', required: true, }, MessageId: { type: 'xs:string', required: false, }, Messages: { type: 'Message', required: false, }, }, }, }; /** * @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>