Inventory API overview
Manage your Marketplace inventory
Use the Walmart Marketplace Inventory API to manage and update the inventory for items you list on Walmart.com. Walmart sellers and solution providers can:
- Retrieve current inventory levels for your SKUs.
- Update item quantities by SKU and ship node.
How it works
Overall seller journey
In a common user journey, a seller or solution provider might complete the following Marketplace flow:
- Item setup: Create or register products (SKUs) with Walmart using the Marketplace Item Management API.
- Inventory management: Keep SKU quantities accurate using the Marketplace Inventory API.
- Order management: Retrieve and confirm orders, shipments, and cancellations through the Orders API.
- Pricing: Adjust item prices through Pricing APIs.
Inventory management flow
Within inventory management, a typical flow is to view your current inventory levels and then update the inventory count as needed. Each GET endpoint has a corresponding PUT or POST endpoint for updates:
Scenario | View | Update |
---|---|---|
Single SKU at default ship node | GET /v3/inventory?sku={SKU} Returns the inventory for a SKU at the default ship node. | PUT /v3/inventory Updates the inventory for that SKU at the default ship node. |
Single SKU across ship nodes | GET /v3/inventories/{SKU} Retrieves inventory details across all ship nodes for a SKU. | PUT /v3/inventories/{SKU} Updates the inventory for that SKU across multiple ship nodes. |
Full catalog view | GET /v3/inventories Retrieves inventory for all SKUs (with pagination). |
|
Reference guide
This guide explains how to use the Marketplace Inventory API, providing practical examples and step-by-step instructions for integrating inventory management into your solution.
For full technical details, including endpoints, parameters, and brief descriptions, refer to the Marketplace Inventory API reference guide.
Prerequisites
Complete the following before integrating an Inventory API:
- Complete the steps in the Getting started guide:
- If you are a seller, refer to the Marketplace getting started guide for sellers.
- If you are a solution provider, refer to the Marketplace getting started guide for solution providers.
- OAuth 2.0 authentication is required to access the Walmart Marketplace APIs. Ensure you have obtained the credentials and tokens before making API requests. For more information, refer to OAuth 2.0 authorization.
- Set up and register your item SKUs with Walmart before you can manage the inventory using the Inventory API.
Commonly used terms
Terms | Description |
---|---|
SKU (Stock keeping unit) | A unique identifier for an item. |
Ship node | A physical location (for example, a warehouse) where you store inventory or ship orders. Ship nodes are also known as fulfillment centers. |
Market availability
The Marketplace Inventory API is available for sellers listing on Walmart marketplaces in Canada, Chile, Mexico, and the U.S.
Next steps
- Learn how to set inventory lag time, the delay between when an inventory change occurs and when that change is reflected as available for sale.
- Learn how to calculate your inventory quantity and different quantity types.
- Download schemas and decide which Marketplace Inventory APIs to integrate.
See also
Learn how to create event notifications to receive inventory alerts.
Updated 11 days ago