node package manager
Love JavaScript? Your insights can make it even better. Take the 2017 JavaScript Ecosystem Survey »

wm-marketplace

wm-marketplace

This is a simple sdk to use when interacting with the Walmart Marketplace API Under a lot of work right now and is not safe to use in production. PR's welcome.

Promise based and uses many es6 features so you will need to either use a babel step or a version of node > 6

js-standard-style forthebadge

Examples

Installation:

npm i mws-marketplace -S

Initialization:

You will need your api credentials from walmart which can be gotten here The walmart docs don't really say much on this, but your correlation id is any arbitrary string. Channel type will appear beneath your consumer and private keys.

const WMClient = require('wm-marketplace')
const wmc = WMClient({
  consumerId: 'your-consumer-id',
  privateKey: 'your-private-key',
  correlationId: 'your-correlation-id',
  channelType: 'your-channel-type'
})

Usage:

wmc.Inventory.GetInventory({
  sku: 'your-sku'
})
.then((result) => {
  // API Response
})

Roadmap

  • Update the host to accept countries other than the US
  • Finish adding all of the endpoints
  • Add in throttling / pagification
  • Add File upload

Available Endpoints (updated as more are added)

Orders: (Walmart Documentation)

GetAllReleased (Walmart Documentation)

Available Parameters:

  • limit: string. Restrictions: Less than 200
  • createdStartDate: string. Available formats: [UTC date, timestamp]

Usage:

mws.Orders.GetAllReleased({
  // Your parameters
})

GetAll (Walmart Documentation)

Available Parameters:

  • sku: string
  • customerOrderId: string
  • purchaseOrderId: string
  • status: string. Available Statuses: [Created, Acknowledged, Shipped, Canceled]
  • createdStartDate: string. Available formats: [UTC date, timestamp]
  • toExpectedShipDate: string. Format: YYYY-MM-DD
  • limit: string. Restrictions: Less than 200

Usage:

mws.Orders.GetAll({
  // Your parameters
})

GetAnOrder (Walmart Documentation)

Available Parameters:

  • sku: string
  • customerOrderId: string
  • purchaseOrderId: string
  • status: string. Available Statuses: [Created, Acknowledged, Shipped, Canceled]
  • createdStartDate: string. Available formats: [UTC date, timestamp]
  • toExpectedShipDate: string. Format: YYYY-MM-DD
  • limit: string. Restrictions: Less than 200

Usage:

mws.Orders.GetAnOrder({
  // Your parameters
})

Inventory (Walmart Documentation)

GetInventory (Walmart Documentation)

Available Parameters:

  • sku: string

Usage:

mws.Inventory.GetInventory({
  // Your parameters
})

Prices (Walmart Documentation)

ItemPrice ([Walmart Documentation][walmart-prices-item])

Endpoint to update an individual sku's price.

Available Parameters:

  • sku: string. Required
  • price: string. Required

Usage:

mws.Prices.ItemPrice({
  // your parameters
})

Reports (Walmart Documentation)

Reports has a single endpoint, that can generate different types of reports based on the url query.

Available Parameters:

  • type: string

Available Queries:

  • item
  • buyBox
  • cpa

Usage:

mws.Reports.GetReport({
  type: 'item'
})