Guides
My Account
  1. Orders Management
  2. Retrieve orders

An order

Call the An order endpoint to retrieve detailed information about a specific order. You can view the order's items, customer details, and current status. For example, you might query a single order to troubleshoot a fulfillment issue or confirm specific line item quantities.

Note: This page describes an example using only the required parameters and inputs for getting an order. For a full list of customization options and additional capabilities, refer to the Walmart Orders API Reference.

Endpoint

GET https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}

Function

This API is used to:

  • Pull recent orders for processing
  • Check shipment and delivery status
  • Review order line details
  • Handle cancellations and replacements
  • Support operational order-management workflows

Sample request

curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/orders/purchaseOrderId?productInfo=false&replacementInfo=false&incentiveInfo=false' \ --header 'accept: application/json'

Modify your code

Include Walmart authentication headers

Sample responses

200 Response Order application/json sample code

{ "order": { "purchaseOrderId": "1815367951431", "customerOrderId": "4372135469400", "customerEmailId": "[email protected]", "orderDate": 1623796407000, "shippingInfo": { "phone": "3143450432", "estimatedDeliveryDate": 1624647600000, "estimatedShipDate": 1623906000000, "methodCode": "Value", "postalAddress": { "name": "Donald Ashley", "address1": "6600 gazebo drive", "city": "Cedar hill", "state": "MO", "postalCode": "63016", "country": "USA", "addressType": "RESIDENTIAL" } }, "orderLines": { "orderLine": [ { "lineNumber": "1", "item": { "productName": "Mac Sports Heavy Duty Steel Double Decker Collapsible Yard Cart Wagon, Purple", "sku": "YHY-FN25200B2" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 5 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0.34 } }, "taxAndOtherFees": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0.34 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "statusDate": 1623835855623, "orderLineStatuses": { "orderLineStatus": [ { "status": "Shipped", "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "trackingInfo": { "shipDateTime": 1623835855000, "carrierName": { "carrier": "USPS" }, "methodCode": "Value", "trackingNumber": "435678956435467", "trackingURL": "https://www.walmart.com/tracking?tracking_id=435678956435467&order_id=1815367951431" } } ] }, "fulfillment": { "fulfillmentOption": "S2H", "shipMethod": "VALUE", "pickUpDateTime": 1624647600000 } } ] }, "shipNode": { "type": "SellerFulfilled" } }
}

200 Response Attributes application/json sample code

{ "order": { "purchaseOrderId": "1796277083022", "customerOrderId": "5281956426648", "customerEmailId": "[email protected]", "orderType": "REPLACEMENT", "originalCustomerOrderID": "1234567891234", "orderDate": 1568466571000, "shippingInfo": { "phone": "3155598681", "estimatedDeliveryDate": 1569438000000, "estimatedShipDate": 1568700000000, "methodCode": "Value", "postalAddress": { "name": "Kathryn Cole", "address1": "3258BWarners rd", "address2": "Garage", "city": "Warners", "state": "NY", "postalCode": "13164", "country": "USA", "addressType": "RESIDENTIAL" } }, "orderLines": { "orderLine": [ { "lineNumber": "4", "item": { "productName": "Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag", "sku": "test1" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 10 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0.8 } }, "taxAndOtherFees": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0.8 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "statusDate": 1568466647000, "orderLineStatuses": { "orderLineStatus": [ { "status": "Created", "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": "xyz", "trackingInfo": { "shipDateTime": 1241715945678, "carrierName": { "otherCarrier": "xyz", "carrier": "FED_EX" }, "methodCode": "Standard", "carrierMethodCode": 19, "trackingNumber": "001792410114462199", "trackingURL": "http://www.fedex.com/Tracking?action=track=english=us=x=001792410114462199" }, "returnCenterAddress": { "name": "xyz", "address1": "xyz", "address2": "xyz", "city": "Sunnyvale", "state": "CA", "postalCode": "123", "country": "CA", "dayPhone": "9999999", "emailId": "[email protected]" } } ] }, "refund": { "refundId": "123", "refundComments": "xyz", "refundCharges": { "refundCharge": [ { "refundReason": "INCORRECT_ITEM_RECEIVED", "charge": { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 798 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 798 } }, "taxAndOtherFees": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 798 } } } } ] } }, "fulfillment": { "fulfillmentOption": "S2H", "shipMethod": "VALUE", "storeId": "xyz", "pickUpDateTime": 1568919600000, "pickUpBy": "xyz", "shippingProgramType": "THREE_TO_FIVE_DAY" } } ] }, "shipNode": { "type": "3PLFulfilled", "name": "xyz", "id": "123" } }
}
{ "order": { "purchaseOrderId": "1796277083022", "customerOrderId": "5281956426648", "customerEmailId": "[email protected]", "orderType": "REPLACEMENT", "originalCustomerOrderID": "1234567891234", "orderDate": 1568466571000, "shippingInfo": { "phone": "3155598681", "estimatedDeliveryDate": 1569438000000, "estimatedShipDate": 1568700000000, "methodCode": "Value", "postalAddress": { "name": "Kathryn Cole", "address1": "3258BWarners rd", "address2": "Garage", "city": "Warners", "state": "NY", "postalCode": "13164", "country": "USA", "addressType": "RESIDENTIAL" } }, "orderLines": { "orderLine": [ { "lineNumber": "4", "item": { "productName": "Beba Bean Pee-pee Teepee Airplane - Blue - Laundry Bag", "sku": "test1" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 10 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0.8 } }, "taxAndOtherFees": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0.8 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "statusDate": 1568466647000, "orderLineStatuses": { "orderLineStatus": [ { "status": "Created", "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": "xyz", "trackingInfo": { "shipDateTime": 1241715945678, "carrierName": { "otherCarrier": "xyz", "carrier": "FED_EX" }, "methodCode": "Standard", "carrierMethodCode": 19, "trackingNumber": "001792410114462199", "trackingURL": "http://www.fedex.com/Tracking?action=track=english=us=x=001792410114462199" }, "returnCenterAddress": { "name": "xyz", "address1": "xyz", "address2": "xyz", "city": "Sunnyvale", "state": "CA", "postalCode": "123", "country": "CA", "dayPhone": "9999999", "emailId": "[email protected]" } } ] }, "refund": { "refundId": "123", "refundComments": "xyz", "refundCharges": { "refundCharge": [ { "refundReason": "INCORRECT_ITEM_RECEIVED", "charge": { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 798 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 798 } }, "taxAndOtherFees": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 798 } } } } ] } }, "fulfillment": { "fulfillmentOption": "S2H", "shipMethod": "VALUE", "storeId": "xyz", "pickUpDateTime": 1568919600000, "pickUpBy": "xyz", "shippingProgramType": "THREE_TO_FIVE_DAY" } } ] }, "shipNode": { "type": "3PLFulfilled", "name": "xyz", "id": "123" } }
}

400 Response application/json sample code

{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.GMP_ORDER_API", "description": "Invalid request content.", "info": "Request content is not valid.", "severity": "ERROR", "category": "DATA" } ]
}
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.GMP_ORDER_API", "description": "Invalid request content.", "info": "Request content is not valid.", "severity": "ERROR", "category": "DATA" } ]
}

401 Response application/json sample code

{ "errors": [ { "code": "UNAUTHORIZED.GMP_ORDER_API", "description": "Unauthorized request.", "info": "Authentication failed. Verify your credentials.", "severity": "ERROR", "category": "APPLICATION" } ]
}

403 Response application/json sample code

{ "errors": [ { "code": "FORBIDDEN.GMP_ORDER_API", "description": "Access denied.", "info": "You do not have permission to perform this action.", "severity": "ERROR", "category": "APPLICATION" } ]
}

404 Response application/json sample code

{ "errors": [ { "code": "NOT_FOUND.GMP_ORDER_API", "description": "Resource not found.", "info": "The requested purchase order was not found.", "severity": "ERROR", "category": "DATA" } ]
}

429 Response application/json sample code

{ "errors": [ { "code": "RATE_LIMIT_EXCEEDED.GMP_ORDER_API", "description": "Too many requests.", "info": "Rate limit exceeded. Retry after the specified time.", "severity": "ERROR", "category": "APPLICATION" } ]
}

500 Response application/json sample code

{ "errors": [ { "code": "INTERNAL_SERVER_ERROR.GMP_ORDER_API", "description": "An internal server error occurred.", "info": "Retry the request. If the issue persists, contact support.", "severity": "ERROR", "category": "SYSTEM" } ]
}

200 Response application/xml sample code

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:order xmlns:ns2="http://walmart.com/mp/orders" xmlns:ns3="http://walmart.com/mp/v3/orders" xmlns:ns4="com.walmart.services.common.model.money" xmlns:ns5="com.walmart.services.common.model.name" xmlns:ns6="com.walmart.services.common.model.address" xmlns:ns7="com.walmart.services.common.model.address.validation" xmlns:ns8="http://walmart.com/"> <ns3:purchaseOrderId> 1815367951431 </ns3:purchaseOrderId> <ns3:customerOrderId> 4372135469400 </ns3:customerOrderId> <ns3:customerEmailId> [email protected] </ns3:customerEmailId> <ns3:orderType> REPLACEMENT </ns3:orderType> <ns3:orderDate> 2021-06-15T22:33:27.000Z </ns3:orderDate> <ns3:shippingInfo> <ns3:phone> 3143450432 </ns3:phone> <ns3:estimatedDeliveryDate> 2021-06-25T19:00:00.000Z </ns3:estimatedDeliveryDate> <ns3:estimatedShipDate> 2021-06-17T05:00:00.000Z </ns3:estimatedShipDate> <ns3:methodCode> Value </ns3:methodCode> <ns3:postalAddress> <ns3:name> Donald Ashley </ns3:name> <ns3:address1> 6600 gazebo drive </ns3:address1> <ns3:city> Cedar hill </ns3:city> <ns3:state> MO </ns3:state> <ns3:postalCode> 63016 </ns3:postalCode> <ns3:country> USA </ns3:country> <ns3:addressType> RESIDENTIAL </ns3:addressType> </ns3:postalAddress> </ns3:shippingInfo> <ns3:orderLines> <ns3:orderLine> <ns3:lineNumber> 1 </ns3:lineNumber> <ns3:item> <ns3:productName> Mac Sports Heavy Duty Steel Double Decker Collapsible Yard Cart Wagon, Purple </ns3:productName> <ns3:sku> YHY-FN25200B2 </ns3:sku> </ns3:item> <ns3:charges> <ns3:charge> <ns3:chargeType> PRODUCT </ns3:chargeType> <ns3:chargeName> ItemPrice </ns3:chargeName> <ns3:chargeAmount> <ns3:currency> USD </ns3:currency> <ns3:amount> 5.00 </ns3:amount> </ns3:chargeAmount> <ns3:tax> <ns3:taxName> Tax1 </ns3:taxName> <ns3:taxAmount> <ns3:currency> USD </ns3:currency> <ns3:amount> 0.34 </ns3:amount> </ns3:taxAmount> </ns3:tax> </ns3:charge> </ns3:charges> <ns3:orderLineQuantity> <ns3:unitOfMeasurement> EACH </ns3:unitOfMeasurement> <ns3:amount> 1 </ns3:amount> </ns3:orderLineQuantity> <ns3:statusDate> 2021-06-16T09:30:55.623Z </ns3:statusDate> <ns3:orderLineStatuses> <ns3:orderLineStatus> <ns3:status> Shipped </ns3:status> <ns3:statusQuantity> <ns3:unitOfMeasurement> EACH </ns3:unitOfMeasurement> <ns3:amount> 1 </ns3:amount> </ns3:statusQuantity> <ns3:trackingInfo> <ns3:shipDateTime> 2021-06-16T09:30:55.000Z </ns3:shipDateTime> <ns3:carrierName> <ns3:carrier> USPS </ns3:carrier> </ns3:carrierName> <ns3:methodCode> Value </ns3:methodCode> <ns3:trackingNumber> 435678956435467 </ns3:trackingNumber> <ns3:trackingURL> https://www.walmart.com/tracking?tracking_id=435678956435467&order_id=1815367951431 </ns3:trackingURL> </ns3:trackingInfo> </ns3:orderLineStatus> </ns3:orderLineStatuses> <ns3:fulfillment> <ns3:fulfillmentOption> S2H </ns3:fulfillmentOption> <ns3:shipMethod> VALUE </ns3:shipMethod> <ns3:pickUpDateTime> 2021-06-25T19:00:00.000Z </ns3:pickUpDateTime> </ns3:fulfillment> </ns3:orderLine> </ns3:orderLines> <ns3:shipNode> <ns3:type> SellerFulfilled </ns3:type> </ns3:shipNode>
</ns3:order>

400 Response application/problem+json sample code

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"
}

401 Response application/problem+json sample code

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"
}

403 Response application/problem+json sample code

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"
}

404 Response application/problem+json sample code

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"
}

429 Response application/problem+json sample code

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"
}

500 Response application/problem+json sample code

{ "type": "string", "title": "string", "status": 0, "detail": "string", "instance": "string"
}

Result

A successful response returns:

  • purchaseOrderId: The Walmart purchase order number
  • customerOrderId: The customer-facing order number
  • customerEmailId: The relay email address associated with the order
  • orderDate: Order timestamp
  • shippingInfo: Phone number, estimated dates, shipping method, and postal address
  • charges: Item price, taxes, and any other charge details
  • orderLineQuantity: The quantity of the order line
  • orderLineStatuses: The current status of the order line
  • trackingInfo: Carrier, tracking number, and the tracking URL for shipping
  • refund: Refund details
  • fulfillment: Fulfillment option, ship method, pickup timing, and shipping program type
  • shipNode: The fulfillment center

The error responses indicate:

  • 400 invalid request content
  • 401 unauthorized request
  • 403 access denied
  • 404 purchase order not found
  • 429 rate limit exceeded
  • 500 internal server error

Next Steps

  • Replace the purchaseOrderId with a real order identifier.
  • Add the required Walmart authentication headers in your implementation.
  • Parse the order object and map it into your OMS workflow.
  • Use orderLineStatuses and trackingInfo to monitor shipment progress.
  • Handle both JSON success responses and problem+json error responses.