Owned Orders API Overview
The Walmart Purchase Order Management API (also known as the Orders Management API) allows suppliers to view and track the status of changes on Walmart purchase orders (PO) with suppliers. The PO contains items shipped to a Walmart, Sam’s Club facility, distribution center, or directly to a store or club.
Sync (Read): View All Walmart Purchase Orders
The View all Walmart purchase ordersAPI request (GET /v3/walmartOrders)
, returns all Walmart POs for an individual supplier with a 6-digit supplier ID. The API response is limited to the supplier’s information request. All relevant PO information is returned in JSON format.
The supplier can limit the number of PO responses to the following query parameters:
supplierId (9-digit supplier ID)
hostPurchaseOrderId
type
purchaseOrderStatus
purchaseOrderSupplyChainStatus
createdAfter
createdBefore
mustArriveByDateAfterDate
mustArriveByDateBeforeDate
limit
nextCursor
The nextCursor
mechanism lets suppliers paginate responses. The API returns the dates of the POs (from most recent to the oldest) based on the createDate
, has a limit of up-to 100 responses per API call. If a user has more than 100 orders, they will need to use the nextCursor
value in the API response in their subsequent API call to view the next 100 POs.`
Please see an example of the nextCursor API response below:
"purchaseOrdersListMeta": {
"totalCount": 200,
"limit": 100,
"nextCursor": "123456789" }
Currently, the Walmart Purchase Order Management API allows a total of 5,000 API calls per hour.
Examples of most commonly used queries:
- Get a list of today’s orders:
createdAfter
= today’s date (i.e., 2024-01-01T00:00:00Z)
- Get all orders for a specific brand:
supplierId
= 9 digit Sam’s or Walmart supplier ID
- Get all orders with delivered status to DC and/or store:
purchaseOrderSupplyChainStatus
= received
- Get all cancelled orders
purchaseOrderStatus
= cancelled
- Get all manually generated orders
type
= 03 (Buyer Generated – domestic only)
Sync (Read): Get a Single Purchase Order Information
The Retrieve a single Walmart purchase order with details API request (GET /v3/walmartOrders}
lets suppliers search for specific POs.
This API call returns all relevant PO information, such as PO line details, item number, cost, and line status.
The supplier has the ability to limit the number of POs shown in response by filtering the query parameters or the purchaseOrderID
.
Updated 5 days ago