Order management API overview

Use the Walmart Marketplace Orders Management 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.

Note: For Canada and Mexico markets, you can ship multiple items in a single shipment. You can also ship one item in multiple packages each with its own label. For Walmart generated labels, you must now generate labels separately using the Create Label API.

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 Management 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.
   1. Ready to ship Market availability: MX only - Order items are expected and ready for shipment, but shipment has not yet been marked as shipped.
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.

Market availability: Canada

Order management spec

Extract the Order Management XSDs from the below directory:

Canada-Orders-XSD-v3.zip

A Walmart order object represents a purchase order and consists of a group of one or more line items that a customer ordered.

Note: The order has no inherit status, but the line items do.

The valid statuses for a line item are:

• Created: The purchase orders for the line items are created and have been released from the Walmart Order Management System to the seller for processing. You will need to acknowledge this order before shipping.
• Acknowledged: The purchase order has been acknowledged by the assigned sellers, including all of its order line items. If it is in this state by default, it already has been acknowledged.
• Shipped: The items included in the purchase order have been shipped.
• Canceled: The line order has been canceled. Sellers cannot fulfill the purchase order.

The values that support Walmart charge types are:

• Product: The product charges for the specified line item in purchase order.
• Shipping: The shipping charges for the specified purchase order line item. Walmart only supports UTC shipDateTime.

Canada Order Workflow

To successfully fulfill and/or refund orders properly, Walmart follows this order process workflow:

Market availability: Mexico and Chile

Mexico WFS orders

You can use the WFS APIs to track WFS orders.

Walmart fulfilled orders do not have a purchase order. They are referenced by the customer order itself and are view only.

The valid statuses for a WFS line item are:

• Created: This is the default status when an order drops into Seller Center, when Payment has been completed/ Fraud check is released/passed.
• SentForFulfillment: The order is confirmed and is waiting to be shipped.
• Shipped: The items included in the order have been shipped.
• Delivered: Order moves to this status when the carrier updates the tracking details.
• Cancelled: Order moves to this status when the customer cancels the order.

Mexico order fulfillment workflow

To successfully fulfill or refund orders properly, Walmart follows this workflow.

Reference guide

This guide explains how to use the Marketplace Orders Management 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 Management API:

• Complete the steps in the Getting started guide:
  • If you are a seller, refer to the Get started as a seller.
  • If you are an approved Solution Providers, refer to the Get started as an approved Solution Provider.
• OAuth 2.0 authentication Market availability: US only - 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.
• Delegated access authorization Market availability: CA | CL | MX - Use delegated access authorization to create separate API Keys and credentials for each approved Solution Provider. For more information, refer to Delegated access 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 Management API is available for sellers listing on Walmart marketplaces in Canada, Chile, Mexico, and the U.S.

Next steps

Decide which Orders Management APIs to integrate.

Download order schemas and decide which Marketplace Orders Management APIs to integrate.