Home Reference Source

References

summary
public

Thrown when completely Invalid Parameters are given and we have no way of making sense of them

public

Thrown when a request is cancelled by MWS -- we have no way of knowing automatically if we should retry or not

public

Thrown when an Error response comes from the Service (not a mws-simple.ServerError though)

public

Thrown when parameters fail validation locally, before being sent to MWS

public

F async callEndpoint(name: string, callOptions: object, opt: object): any

Call a known endpoint at MWS, returning the raw data from the function.

public

F init(config: object): mws-simple

Initialize mws-advanced with your MWS access keys, merchantId, optionally authtoken, host, port If accessKeyId, secretAccessKey, and/or merchantId are not provided, they will be read from the environment variables MWS_ACESS_KEY, MWS_SECRET_ACCESS_KEY, and MWS_MERCHANT_ID respectively

public

getLowestPricedOffersForASIN

public

Call MWS ListMarketplaceParticipations, return parsed results

public

F async getMatchingProductForId(options: Object): Product[]

Returns a list of products and their attributes, based on a list of ASIN, GCID, SellerSKU, UPC, EAN, ISBN, or JAN values

public

F async listFinancialEvents(options: object): object

public

F async listInventorySupply(options: object): {nextToken: string, supplyList: object[]}

Return information about the availability of a seller's FBA inventory

public

F async listOrderItems(AmazonOrderId: string): OrderItemList

Returns order items based on the AmazonOrderId that you specify.

public

F async listOrders(options: object): object

Return orders created or updated during a specific time frame see https://docs.developer.amazonservices.com/en_UK/orders-2013-09-01/Orders_ListOrders.html At least ONE of the search options (and maybe more depending on which ones you select) must be specified.

public

F async getReport(options: object): Array | object

Returns the contents of a report

public

F async getReportList(options: {}): *

TODO: write documentation for getReportList

public

F async getReportListAll(options: {}): *

TODO: write documentation for getReportListAll (or see comment on getReportListByNextToken)

public

F async getReportListByNextToken(options: *): *

TODO: write documentation for getReportListByNextToken (or just roll getReportList and getReportListByNextToken into the same wrapper) (that wrapper might be getReportListAll, and just rename it)

public

F async getReportRequestList(options: object, ReportRequestIdList: string[], ReportTypeList: string[], ReportProcessingStatusList: string[], MaxCount: number, RequestedFromDate: Date, RequestedToDate: Date): GetReportRequestListResult[]

Returns a list of report requests that you can use to get the ReportRequestId for a report After calling requestReport, you should call this function occasionally to see if/when the report has been processed.

public

F async requestAndDownloadReport(ReportType: *, file: *, reportParams: {}): *

TODO: Document requestAndDownloadReport

public

F async requestReport(options: object, MarketplaceId: string[]): ReportRequestInfo

Request a report from MWS Many optional parameters may be required by MWS! Read ReportType for specifics!

public

V MWS_ENDPOINTS: {"NA": string, "BR": string, "EU": string, "IN": string, "CN": string, "AU": string, "JP": string}

A list of hosts you can use with the mws-advanced "host" option, hashed by MWS Region Name.

public

V MWS_MARKETPLACES: {"CA": string, "MX": string, "US": string, "BR": string, "DE": string, "ES": string, "FR": string, "IT": string, "UK": string, "IN": string, "CN": string, "AU": string}

A list of Marketplace IDs hashed by their country code.

public

T BuyBoxPrice(condition: string, landedPrice: Money, listingPrice: Money, shipping: Money): *

public

T DetailedShippingTime(unknown: string): *

public

T LowestPrice(condition: string, fulfillmentChannel: string, landedPrice: Money, listingPrice: Money, shipping: string): *

public

T LowestPricedOffers(asin: string, marketplace: string, itemCondition: string, summary: OfferSummary, offers: Offers[]): *

public

T Money(unknown: string): *

public

T Offer(subCondition: string, sellerFeedbackRating: SellerFeedbackRating, shippingTime: DetailedShippingTime, listingPrice: Money, points: Points, shipping: Money, shipsFrom: ShipsFrom, isFulfilledByAmazon: boolean, isBuyBoxWinner: boolean, isFeaturedMerchant: boolean): *

public

T OfferCount(count: number, condition: string, fulfillmentChannel: string): *

public

T OfferSummary(totalOfferCount: number, numberOfOffers: number, listPrice: Money, lowestPrices: LowestPrice[], buyBoxPrices: Array): *

public

T SellerFeedbackRating(unknown: string): *

public

T ShipsFrom(unknown: string): *

public

T MarketDetail(marketplaceId: string, defaultCountryCode: string, domainName: string, defaultCurrencyCode: string, defaultLanguageCode: string, sellerId: string, hasSellerSuspendedListings: boolean): *

public

T OrderItemList(orderId: string, nextToken: string, orderItems: Array): *

public

T GetReportRequestListResult(ReportType: string, ReportProcessingStatus: string, EndDate: string, Scheduled: boolean, ReportRequestId: string, StartedProcessingDate: string, StartDate: string, CompletedDate: string, GeneratedReportId: string): *

public

T GetReportRequestListResult(ReportType: string, ReportProcessingStatus: string, EndDate: string, Scheduled: boolean, ReportRequestId: string, StartedProcessingDate: string, StartDate: string, CompletedDate: string, GeneratedReportId: string): *

public

T ReportRequestInfo(ReportType: string, ReportProcessingStatus: string, EndDate: string, Scheduled: boolean, ReportRequestId: string, SubmittedDate: string, StartDate: string): *

endpoints

summary
public

status indicators for report processing status updates

public

List of all valid request report types.

Directories