@amazon-sp-api-release/amazon-sp-api-sdk-js 1.0.0-rc6 → 1.0.0-rc8

package/index.js

@@ -1,50 +1,52 @@
-export * as ApluscontentSpApi from './src/apluscontent_v2020_11_01/index.js'
-export * as AppintegrationsSpApi from './src/appintegrations_v2024_04_01/index.js'
-export * as ApplicationsSpApi from './src/applications_v2023_11_30/index.js'
-export * as AwdSpApi from './src/awd_v2024_05_09/index.js'
-export * as CatalogitemsSpApi from './src/catalogitems_v2022_04_01/index.js'
-export * as DatakioskSpApi from './src/datakiosk_v2023_11_15/index.js'
-export * as EasyshipSpApi from './src/easyship_v2022_03_23/index.js'
-export * as FbaeligibilitySpApi from './src/fbaeligibility_v1/index.js'
-export * as FbainventorySpApi from './src/fbainventory_v1/index.js'
-export * as FeedsSpApi from './src/feeds_v2021_06_30/index.js'
-export * as Finances20240619SpApi from './src/finances_2024_06_19/index.js'
-export * as FinancesSpApi from './src/finances_v0/index.js'
-export * as FulfillmentinboundSpApi from './src/fulfillmentinbound_v2024_03_20/index.js'
-export * as Fulfillmentinbound_v0SpApi from './src/fulfillmentinbound_v0/index.js'
-export * as FulfillmentoutboundSpApi from './src/fulfillmentoutbound_v2020_07_01/index.js'
-export * as InvoicesSpApi from './src/invoices_v2024_06_19/index.js'
-export * as InvoicingSpApi from './src/invoicing_v0/index.js'
-export * as ListingsitemsSpApi from './src/listingsitems_v2021_08_01/index.js'
-export * as ListingsrestrictionsSpApi from './src/listingsrestrictions_v2021_08_01/index.js'
-export * as MerchantfulfillmentSpApi from './src/merchantfulfillment_v0/index.js'
-export * as MessagingSpApi from './src/messaging_v1/index.js'
-export * as NotificationsSpApi from './src/notifications_v1/index.js'
-export * as OrdersSpApi from './src/orders_v0/index.js'
-export * as PricingSpApi from './src/pricing_v2022_05_01/index.js'
-export * as Pricing_v0SpApi from './src/pricing_v0/index.js'
-export * as ProductfeesSpApi from './src/productfees_v0/index.js'
-export * as ProducttypedefinitionsSpApi from './src/producttypedefinitions_v2020_09_01/index.js'
-export * as ReplenishmentSpApi from './src/replenishment_v2022_11_07/index.js'
-export * as ReportsSpApi from './src/reports_v2021_06_30/index.js'
-export * as SalesSpApi from './src/sales_v1/index.js'
-export * as SellersSpApi from './src/sellers_v1/index.js'
-export * as ServicesSpApi from './src/services_v1/index.js'
-export * as ShippingSpApi from './src/shipping_v2/index.js'
-export * as SolicitationsSpApi from './src/solicitations_v1/index.js'
-export * as SupplysourcesSpApi from './src/supplysources_v2020_07_01/index.js'
-export * as TokensSpApi from './src/tokens_v2021_03_01/index.js'
-export * as TransfersSpApi from './src/transfers_v2024_06_01/index.js'
-export * as UploadsSpApi from './src/uploads_v2020_11_01/index.js'
-export * as VehiclesSpApi from './src/vehicles_v2024_11_01/index.js'
-export * as VendordfinventorySpApi from './src/vendordfinventory_v1/index.js'
-export * as VendordfordersSpApi from './src/vendordforders_v2021_12_28/index.js'
-export * as VendordfpaymentsSpApi from './src/vendordfpayments_v1/index.js'
-export * as VendordfshippingSpApi from './src/vendordfshipping_v2021_12_28/index.js'
-export * as VendordftransactionsSpApi from './src/vendordftransactions_v2021_12_28/index.js'
-export * as VendorinvoicesSpApi from './src/vendorinvoices_v1/index.js'
-export * as VendorordersSpApi from './src/vendororders_v1/index.js'
-export * as VendorshipmentsSpApi from './src/vendorshipments_v1/index.js'
-export * as VendortransactionstatusSpApi from './src/vendortransactionstatus_v1/index.js'
+export * as ApluscontentSpApi from './src/apluscontent_v2020_11_01/index.js';
+export * as AppintegrationsSpApi from './src/appintegrations_v2024_04_01/index.js';
+export * as ApplicationsSpApi from './src/applications_v2023_11_30/index.js';
+export * as AwdSpApi from './src/awd_v2024_05_09/index.js';
+export * as CatalogitemsSpApi from './src/catalogitems_v2022_04_01/index.js';
+export * as DatakioskSpApi from './src/datakiosk_v2023_11_15/index.js';
+export * as EasyshipSpApi from './src/easyship_v2022_03_23/index.js';
+export * as FbaeligibilitySpApi from './src/fbaeligibility_v1/index.js';
+export * as FbainventorySpApi from './src/fbainventory_v1/index.js';
+export * as FeedsSpApi from './src/feeds_v2021_06_30/index.js';
+export * as Finances20240619SpApi from './src/finances_2024_06_19/index.js';
+export * as FinancesSpApi from './src/finances_v0/index.js';
+export * as FulfillmentinboundSpApi from './src/fulfillmentinbound_v2024_03_20/index.js';
+export * as Fulfillmentinbound_v0SpApi from './src/fulfillmentinbound_v0/index.js';
+export * as FulfillmentoutboundSpApi from './src/fulfillmentoutbound_v2020_07_01/index.js';
+export * as InvoicesSpApi from './src/invoices_v2024_06_19/index.js';
+export * as InvoicingSpApi from './src/invoicing_v0/index.js';
+export * as ListingsitemsSpApi from './src/listingsitems_v2021_08_01/index.js';
+export * as ListingsrestrictionsSpApi from './src/listingsrestrictions_v2021_08_01/index.js';
+export * as MerchantfulfillmentSpApi from './src/merchantfulfillment_v0/index.js';
+export * as MessagingSpApi from './src/messaging_v1/index.js';
+export * as NotificationsSpApi from './src/notifications_v1/index.js';
+export * as OrdersSpApi from './src/orders_v0/index.js';
+export * as PricingSpApi from './src/pricing_v2022_05_01/index.js';
+export * as Pricing_v0SpApi from './src/pricing_v0/index.js';
+export * as ProductfeesSpApi from './src/productfees_v0/index.js';
+export * as ProducttypedefinitionsSpApi from './src/producttypedefinitions_v2020_09_01/index.js';
+export * as ReplenishmentSpApi from './src/replenishment_v2022_11_07/index.js';
+export * as ReportsSpApi from './src/reports_v2021_06_30/index.js';
+export * as SalesSpApi from './src/sales_v1/index.js';
+export * as SellersSpApi from './src/sellers_v1/index.js';
+export * as ServicesSpApi from './src/services_v1/index.js';
+export * as ShippingSpApi from './src/shipping_v2/index.js';
+export * as SolicitationsSpApi from './src/solicitations_v1/index.js';
+export * as SupplysourcesSpApi from './src/supplysources_v2020_07_01/index.js';
+export * as TokensSpApi from './src/tokens_v2021_03_01/index.js';
+export * as TransfersSpApi from './src/transfers_v2024_06_01/index.js';
+export * as UploadsSpApi from './src/uploads_v2020_11_01/index.js';
+export * as VehiclesSpApi from './src/vehicles_v2024_11_01/index.js';
+export * as VendordfinventorySpApi from './src/vendordfinventory_v1/index.js';
+export * as VendordfordersSpApi from './src/vendordforders_v2021_12_28/index.js';
+export * as VendordfpaymentsSpApi from './src/vendordfpayments_v1/index.js';
+export * as VendordfshippingSpApi from './src/vendordfshipping_v2021_12_28/index.js';
+export * as VendordftransactionsSpApi from './src/vendordftransactions_v2021_12_28/index.js';
+export * as VendorinvoicesSpApi from './src/vendorinvoices_v1/index.js';
+export * as VendorordersSpApi from './src/vendororders_v1/index.js';
+export * as VendorshipmentsSpApi from './src/vendorshipments_v1/index.js';
+export * as VendortransactionstatusSpApi from './src/vendortransactionstatus_v1/index.js';
 
-export * from './helper/LwaAuthClient.mjs'
+export * from './helper/LwaAuthClient.mjs';
+export * from './helper/ScopeConstants.mjs';
+export * from './helper/RateLimitConfiguration.mjs';

package/package.json

@@ -4,6 +4,7 @@
   "license": "Apache License 2.0",
   "main": "./index.js",
   "type": "module",
+  "version": "1.0.0-rc8",
   "scripts": {
     "test": "echo \"No test specified\" && exit 1"
   },
@@ -12,7 +13,9 @@
   },
   "dependencies": {
     "@babel/cli": "^7.0.0",
-    "superagent": "^9.0.0"
+    "superagent": "^9.0.0",
+    "bottleneck": "^2.19.5",
+    "yaml": "^2.4.0"
   },
   "devDependencies": {
     "@babel/core": "^7.0.0",
@@ -36,9 +39,7 @@
     "@babel/register": "^7.0.0",
     "expect.js": "^0.3.1",
     "mocha": "^11.1.0",
-    "sinon": "^16.1.1",
-    "mocha-junit-reporter": "^2.2.0",
-    "mocha-multi-reporters": "1.5.1"
+    "sinon": "^16.1.1"
   },
   "files": [
     "src/",
@@ -55,6 +56,5 @@
   },
   "engines": {
     "node": ">=14.18.0"
-  },
-  "version": "1.0.0-rc6"
+  }
 }

package/sample-node-app/app.config.mjs

@@ -1,5 +1,6 @@
 export const AppConfig = {
-    lwaClientId: '<YOUR_CLIENT_ID>',
-    lwaClientSecret: '<YOUR_CLIENT_SECRET>',
-    lwaRefreshToken: '<YOUR_REFRESH_TOKEN>',
+    lwaClientId: '<REPLACE_WITH_YOUR_CLIENT_ID>',
+    lwaClientSecret: '<REPLACE_WITH_YOUR_CLIENT_SECRET>',
+    lwaRefreshToken: '<REPLACE_WITH_YOUR_REFRESH_TOKEN>',
+    spApiNAEndpoint: 'https://sellingpartnerapi-na.amazon.com'
 }

package/sample-node-app/index.js

@@ -1,27 +1,158 @@
-import { AppConfig } from './app.config.mjs';
-import { LwaAuthClient } from '@amazon-sp-api-release/amazon-sp-api-sdk-js';
-
 import {
-    SellersSpApi
+  OrdersSpApi,
+  SellersSpApi,
+  NotificationsSpApi,
+  LwaAuthClient,
+  ScopeConstants,
+  RateLimitConfiguration
 } from '@amazon-sp-api-release/amazon-sp-api-sdk-js';
+import { AppConfig } from './app.config.mjs';
+
+/**
+* Sample SDK usage of calling Sellers getMarketplaceParticipations API.
+* For Auth&Auth, It uses SDK built in LWA token retriever.
+* All you need to do is call enableAutoRetrivalAccessToken when setting up your ApiClient.
+* Please provide client_id, client_secret and refresh_token when calling this function.
+*/
+async function getMarketplaceParticipations() {
+  try {
+      //Configure Sellers ApiClient
+      const sellersApiClient = new SellersSpApi.ApiClient(AppConfig.spApiNAEndpoint);
+      sellersApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, AppConfig.lwaRefreshToken, null);
+      const sellersApi = new SellersSpApi.SellersApi(sellersApiClient);
+      
+      //Call GetMarkerplaceParticipations API
+      const participations = await sellersApi.getMarketplaceParticipations();
+      console.log(
+        JSON.stringify(participations, null, ' ') + 
+          '\n**********************************'
+      )
+
+  } catch (error) {
+      console.error('Exception when calling getMarketplaceParticipations API', error.message);
+  }
+}
+
+/**
+* Sample SDK usage of calling Notifications createDestination API (grantless operation).
+* For Auth&Auth, It uses SDK built in LWA retriever.
+* All you need to do is call enableAutoRetrivalAccessToken when setting up your ApiClient.
+* Please provide client_is, client_secret and scope when calling this function.
+*/
+async function createDestination() {
+  try {
+    //Configure Notifications ApiClient
+    const notificationsApiClient = new NotificationsSpApi.ApiClient(AppConfig.spApiNAEndpoint);
+    notificationsApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, null, ScopeConstants.SCOPE_NOTIFICATION_API);
+    const notificationsApi = new NotificationsSpApi.NotificationsApi(notificationsApiClient);
+    
+    //Build createDestination request
+    const sqsResource = new NotificationsSpApi.SqsResource('<REPLACE_WITH_YOUR_SQS_QUEUE_ARN>');
+    const destinationResourceSpecification = new NotificationsSpApi.DestinationResourceSpecification(); 
+    destinationResourceSpecification.sqs = sqsResource;
+    const createDestinationRequest = new NotificationsSpApi.CreateDestinationRequest(destinationResourceSpecification, 'test-destination-name');
+    
+    //Call CreateDestination API
+    const createDestinationResponse = await notificationsApi.createDestination(createDestinationRequest);
+    console.log(
+      JSON.stringify(createDestinationResponse, null, '  ') +
+        '\n**********************************'
+    );
+
+  } catch(error) {
+    console.error('Exception when calling createDestination API ---', error.message); 
+  }
+}
+
+/**
+* Alternatively, you can use our LwaAuthClient helper to maintain your own token cache.
+* This is a sample SDK usage of calling Orders getOrders API.
+* It uses LwaAuthClient in helpr/ to get acess token
+*/
+async function getOrders() {
+  try {
+      //Set up LwaAuthClient instance
+      const lwaAuthClient = new LwaAuthClient(AppConfig.lwaClientId, AppConfig.lwaClientSecret, AppConfig.lwaRefreshToken, null);
+
+      //Configure Orders ApiClient
+      const ordersApiClient = new OrdersSpApi.ApiClient(AppConfig.spApiNAEndpoint);
+      ordersApiClient.applyXAmzAccessTokenToRequest(
+        await lwaAuthClient.getAccessToken()
+      );
+      const ordersApi = new OrdersSpApi.OrdersV0Api(ordersApiClient);
+      
+      //Call GetOrders API
+      const marketPlaceIds = ['ATVPDKIKX0DER'];
+      const opts = {
+        createdAfter: '2024-01-01'
+      };
+      const orders = await ordersApi.getOrders(marketPlaceIds, opts);
+      console.log(
+        JSON.stringify(orders, null, ' ') + 
+          '\n**********************************'
+      )
+
+  } catch (error) {
+      console.error('Exception when calling getOrders API', error.message);
+  }
+}
+
+/**
+ * We support a built in rate limiter.
+ * Here is a sample SDK usage of calling Orders listTransactions API with a rate limiter and retry logic.
+ */
+async function getOrdersWithRateLimiterAndRetry(rateLimitPermit, waitTimeOutInMilliSeconds, burstRequests, retryCount) {
+  const ordersApiClient = new OrdersSpApi.ApiClient(AppConfig.spApiNAEndpoint);
+  ordersApiClient.enableAutoRetrievalAccessToken(AppConfig.lwaClientId, AppConfig.lwaClientSecret, AppConfig.lwaRefreshToken);
+
+  // Option1: Use our default rate limiter. Our rate limiter uses the rate limit and burst values in our official document.
+  ordersApiClient.enableDefaultRateLimiter();
+
+  // Option2: Use your customized rate limiter, you need to replace <RateLimit> and <BurstValue> with actual numbers.
+  // const rateLimitConfig = new RateLimitConfiguration(<RateLimit>, <BurstValue>);
+  // ordersApiClient.enableCustomizedRateLimiter(rateLimitConfig);
+
+  // Option3: Disable rate limit
+  // ordersApiClient.disableRatelimiter();
+
+  const ordersApi = new OrdersSpApi.OrdersV0Api(ordersApiClient);
+  const marketPlaceIds = ['ATVPDKIKX0DER'];
+  const opts = {
+    createdAfter: '2024-01-01'
+  };
+
+  for (let attempt = 1; attempt <= retryCount; attempt++) {
+    try {
+      const response = await ordersApi.getOrders(marketPlaceIds, opts);
+      console.log(
+        JSON.stringify(response, null, ' ') + 
+          '\n**********************************'
+      )        
+      return response.body;
+    } catch (error) {
+      const isRateLimit = error.message.includes('Rate limit');
+      const isLastAttempt = attempt === retryCount;
+
+      if (isRateLimit) {
+          console.log(`Rate limit reached (Attempt ${attempt}/${retryCount})`);
+          
+          if (!isLastAttempt) {
+              // Wait 60 seconds before retry (SP-API getOrders requirement)
+              console.log('Waiting 5 seconds before retry...');
+              await new Promise(resolve => 
+                  setTimeout(resolve, 5000)
+              );
+              continue;
+          }
+      }
+
+      throw error;
+   } 
+ }
+}
 
-(async () => {
-  const lwaClient = new LwaAuthClient(
-    AppConfig.lwaClientId,
-    AppConfig.lwaClientSecret,
-    AppConfig.lwaRefreshToken
-  );
-  const sellerApiClient = new SellersSpApi.ApiClient(
-    'https://sellingpartnerapi-na.amazon.com'
-  );
-
-  const sellerApi = new SellersSpApi.SellersApi(sellerApiClient);
-  sellerApiClient.applyXAmzAccessTokenToRequest(
-    await lwaClient.getAccessToken()
-  );
-  const participations = await sellerApi.getMarketplaceParticipations();
-  console.log(
-    JSON.stringify(participations, null, '  ') +
-      '\n**********************************'
-  );
-})();
+// Uncomment to execute the functions
+// getMarketplaceParticipations();
+// createDestination();
+// getOrders();
+// getOrdersWithRateLimiterAndRetry(3);