Orders API overview

Use the Walmart Marketplace Orders API to manage and process orders for items sold on Walmart.com. As a Walmart seller or approved Solution Provider, you can:

• Retrieve order lists and individual order details.
• Update order statuses, including shipping, cancellations, and refunds.
• Track the lifecycle of each order from creation through fulfillment.

How it works

Overall seller journey

In a common user journey, a seller or approved Solution Provider might complete the following flow:

1. Item Setup: Create or register products (SKUs) with Walmart using the Item Management API.
2. Order Management: Retrieve and confirm orders, shipments, and cancellations through the Orders API.
3. Inventory Management: Keep SKU quantities accurate using the Inventory API.
4. Pricing: Adjust item prices through Pricing APIs.

Orders management flow

Within order management, refer to the following for a common user flow:

Order lifecycle and status

Every order on Walmart Marketplace progresses through the following statuses:

1. Created – A new order has been placed and is ready to be acknowledged.
2. Acknowledged – You've confirmed receipt and plan to fulfill the order.
3. Shipped – You've marked the order as shipped and submitted the tracking information.
4. Canceled – You've canceled an order line.
5. Delivered – You delivered the order. Purchase order lines that are delivered to customers have status=Delivered.

Reference guide

This guide explains how to use the Marketplace Orders API, providing practical examples and step-by-step instructions for integrating order management into your solution.

For full technical details, including endpoints, parameters, and brief descriptions, refer to the Marketplace Orders API reference guide.

Prerequisites

Complete the following before you start integrating the Orders 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 an approved Solution Providers, 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.
• Ensure your account is set up to receive and process orders in the Walmart Marketplace Seller Center.

Commonly used terms

Charge types

Each order line includes charge details that define the amount billed to the customer. Walmart supports the following charge types:

Market availability

The Walmart Orders API is available for sellers listing on Walmart marketplaces in Canada, Chile, Mexico, and the U.S.

Next steps

Decide which Orders APIs to integrate.

Download schemas and decide which Marketplace Orders APIs to integrate.