Skip to content
This repository has been archived by the owner on Nov 29, 2024. It is now read-only.
/ mws-sdk Public archive

JavaScript SDK for Amazon Marketplace Web Services (MWS)

License

Notifications You must be signed in to change notification settings

bizon/mws-sdk

Repository files navigation

mws-sdk CircleCI

SDK for Amazon Marketplace Web Services

npm version codecov dependencies Status XO code style

Getting started

npm install --save @bizon/mws-sdk

Usage

const MWSClient = require('@bizon/mws-sdk')

const client = new MWSClient({
  accessKeyId: '', // defaults to process.env.MWS_ACCESS_KEY_ID
  secretAccessKey: '', // defaults to process.env.MWS_SECRET_ACCESS_KEY
  sellerId: '',
  mwsToken: '',
  sellerRegion: ''
})

API

Finances

Version: 2015-05-01

listFinancialEvents(options)

Options:

Name Type Default
maxResultsPerPage Number 100
amazonOrderId String
financialEventGroupId String
postedAfter Date
postedBefore Date
nextToken String

listFinancialEventGroups(options)

Options:

Name Type Default
maxResultsPerPage Number 100
financialEventGroupStartedAfter Date
financialEventGroupStartedBefore Date
nextToken String

Orders

Version: 2013-09-01

getOrders(options)

Options:

Name Type Default
amazonOrderIds Array<String>

listOrders(options)

Options:

Name Type Default
createdAfter Date
createdBefore Date
lastUpdatedAfter Date
lastUpdatedBefore Date
orderStatus String
fulfillmentChannel String
paymentMethod String
buyerEmail String
sellerOrderId String
maxResultsPerPage Number 100
tfmShipmentStatus String
nextToken String

listOrderItems(options)

Options:

Name Type Default
amazonOrderId String
nextToken String

Products

Version: 2011-10-01

getMatchingProductForId(options)

Options:

Name Type Default
marketplaceId String
idType String
idList Array<String>

getMyPriceForAsin(options)

Options:

Name Type Default
marketplaceId String
asinList Array<String>
itemCondition String

getLowestPricedOffersForAsin(options)

Options:

Name Type Default
marketplaceId String
asin String
itemCondition String

Reports

Version: 2009-01-01

requestReport(options)

Options:

Name Type Default
reportType String
startDate Date
endDate Date
marketplaces Array<String>
reportOptions String

getReportRequestList(options)

Options:

Name Type Default
reportRequestIdList Array<String>
reportTypeList Array<String>
reportProcessingStatusList Array<String>
maxCount Number 100
requestedFromDate Date
requestedToDate Date
nextToken String

getReportList(options)

Options:

Name Type Default
maxCount Number 100
reportTypeList Array<String>
acknowledged Boolean
reportRequestIdList Array<String>
availableFromDate Date
availableToDate Date
nextToken String

getReport(options)

Options:

Name Type Default
reportId String
format Enum[raw, base64]

Subscriptions

Version: 2013-07-01

registerDestination(options)

Options:

Name Type Default
marketplaceId String
sqsQueueUrl String

deregisterDestination(options)

Options:

Name Type Default
marketplaceId String
sqsQueueUrl String

createSubscription(options)

Options:

Name Type Default
marketplaceId String
sqsQueueUrl String
isEnabled Boolean true
notificationType String

sendTestNotificationToDestination(options)

Options:

Name Type Default
marketplaceId String
sqsQueueUrl String

parseNotification(xml)

Parse an XML notification. Only Test and AnyOfferChanged notifications are supported.

Common

All entities except Reports support a getServiceStatus method to retrieve the API status.

License

MIT

Miscellaneous

    ╚⊙ ⊙╝
  ╚═(███)═╝
 ╚═(███)═╝
╚═(███)═╝
 ╚═(███)═╝
  ╚═(███)═╝
   ╚═(███)═╝