An order

Market availability: US | CA | CL

Call this 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

Use this API to:

  • Look up specific orders by purchase order ID
  • Check fulfillment and shipment status
  • Read line-item, tax, and charge details
  • Support order processing, packing, and customer service workflows

Sample request

url --request GET \ --url 'https://marketplace.walmartapis.com/v3/orders/purchaseOrderId?replacementInfo=false' \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: us' \ --header 'accept: application/json'

Modify your code

Include Walmart authentication headers

Sample responses

200 Sample 1 - US Response application/json sample code

{ "order": { "purchaseOrderId": "109007446257350", "customerOrderId": "100000715749900", "customerEmailId": "[email protected]", "orderDate": 1741929263638, "shippingInfo": { "phone": "5103295632", "estimatedDeliveryDate": 1742857140000, "estimatedShipDate": 1742018400000, "methodCode": "Value", "postalAddress": { "name": "Astro Test", "address1": "2730 E McKellips Rd", "address2": null, "city": "Mesa", "state": "AZ", "postalCode": "85213", "country": "USA", "addressType": "RESIDENTIAL" }, "carrierMethodName": null }, "orderLines": { "orderLine": [ { "lineNumber": "1", "item": { "productName": "Magic Clean 2.6 cu. ft. Compact Front Loader Clothes Dryer SD-14", "sku": "690741422690MP3", "condition": "New" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "discountType": null, "isDiscount": null, "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 231 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 19.17 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "statusDate": 1741929521532, "orderLineStatuses": { "orderLineStatus": [ { "status": "Created", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": null, "trackingInfo": { "carrierName": { "otherCarrier": null, "carrier": null }, "methodCode": "Value", "actualDeliveryDateTime": null, "carrierMethodCode": null, "packageStatus": null, "trackingURL": null }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "DELIVERY", "shipMethod": "VALUE", "storeId": null, "pickUpDateTime": 1742857140000, "pickUpBy": "Astro Test", "shippingProgramType": null, "shippingSLA": "4", "shippingConfigSource": "SELLER", "predictedShipNodeName": null } }, { "lineNumber": "2", "item": { "productName": "Pre-Owned itemconditionpreownedvariant", "sku": "preowneditemsconditionnewrollupsamegtin5", "condition": "Pre-Owned: Good" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "discountType": null, "isDiscount": null, "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 180 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 16.88 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "2" }, "statusDate": 1741930003613, "orderLineStatuses": { "orderLineStatus": [ { "status": "Acknowledged", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "2" }, "cancellationReason": null, "trackingInfo": { "carrierName": { "otherCarrier": null, "carrier": null }, "methodCode": "Standard", "actualDeliveryDateTime": null, "carrierMethodCode": null, "packageStatus": null, "trackingURL": null }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "DELIVERY", "shipMethod": "STANDARD", "storeId": null, "pickUpDateTime": 1742511540000, "pickUpBy": null, "shippingProgramType": "THREE_TO_FIVE_DAY", "shippingSLA": "4", "shippingConfigSource": "SELLER", "predictedShipNodeName": null } }, { "lineNumber": "3", "item": { "productName": "Pantene Pro-V Daily Moisture Renewal Conditioner", "sku": "SKU-00635878164204", "condition": "New" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "discountType": null, "isDiscount": null, "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 27 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 2.46 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "3" }, "statusDate": 1741903952000, "orderLineStatuses": { "orderLineStatus": [ { "status": "Shipped", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": null, "trackingInfo": { "shipDateTime": 1741903949000, "carrierName": { "otherCarrier": null, "carrier": "Deutsche Post" }, "methodCode": "Standard", "actualDeliveryDateTime": null, "carrierMethodCode": 1001239, "packageStatus": null, "trackingNumber": "783242352352", "trackingURL": "https://example.com/track?number=794644792798" }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null }, { "status": "Shipped", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": null, "trackingInfo": { "shipDateTime": 1741903896000, "carrierName": { "otherCarrier": null, "carrier": "Canada Post" }, "methodCode": "Standard", "actualDeliveryDateTime": null, "carrierMethodCode": null, "packageStatus": null, "trackingNumber": "783242352352", "trackingURL": "https://example.com/track?number=794644792798" }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null }, { "status": "Shipped", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": null, "trackingInfo": { "shipDateTime": 1741903925000, "carrierName": { "otherCarrier": null, "carrier": "China Post" }, "methodCode": "Standard", "actualDeliveryDateTime": null, "carrierMethodCode": null, "packageStatus": null, "trackingNumber": "783242352352", "trackingURL": "https://example.com/track?number=794644792798" }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "DELIVERY", "shipMethod": "STANDARD", "storeId": null, "pickUpDateTime": 1742511540000, "pickUpBy": null, "shippingProgramType": "THREE_TO_FIVE_DAY", "shippingSLA": "4", "shippingConfigSource": "SELLER", "predictedShipNodeName": null } }, { "lineNumber": "4", "item": { "productName": "Magic Clean 2.6 cu. ft. Compact Front Loader Clothes Dryer SD-14", "sku": "690741422690MP3", "condition": "New" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "discountType": null, "isDiscount": null, "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 231 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 17.56 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "statusDate": 1741929153000, "orderLineStatuses": { "orderLineStatus": [ { "status": "Delivered", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": null, "trackingInfo": { "shipDateTime": 1741943518000, "carrierName": { "otherCarrier": null, "carrier": "USPS" }, "methodCode": "Value", "actualDeliveryDateTime": null, "carrierMethodCode": 21, "packageStatus": null, "trackingNumber": "1Z9728W19331607378412", "trackingURL": "https://example.com/track?number=794644792798" }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "DELIVERY", "shipMethod": "VALUE", "storeId": null, "pickUpDateTime": 1742857140000, "pickUpBy": "Astro Test", "shippingProgramType": null, "shippingSLA": "4", "shippingConfigSource": "SELLER", "predictedShipNodeName": null } }, { "lineNumber": "5", "item": { "sku": "AC5MN1" }, "charges": { "charge": [] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "orderLineStatuses": { "orderLineStatus": [ { "status": "Cancelled", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": null, "trackingInfo": { "carrierName": { "otherCarrier": null, "carrier": null }, "methodCode": "Express", "actualDeliveryDateTime": null, "carrierMethodCode": null, "packageStatus": null, "trackingURL": null }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "originalCarrierMethod": "67", "fulfillment": { "fulfillmentOption": "DELIVERY", "shipMethod": "EXPEDITED", "storeId": null, "pickUpDateTime": null, "pickUpBy": null, "shippingProgramType": "TWO_DAY", "shippingSLA": "4", "shippingConfigSource": "SELLER", "predictedShipNodeName": null }, "intentToCancel": "TRUE" } ] }, "shipNode": { "type": "SellerFulfilled", "name": "Seller test-distributor", "id": "10000002941" } }
}

200 Sample 2 - CA Response application/json sample code

{ "order": { "purchaseOrderId": "309003196162504", "customerOrderId": "900000025529848", "customerEmailId": "[email protected]", "orderDate": 1738246672551, "shippingInfo": { "phone": "9876543210", "estimatedDeliveryDate": 1739304000000, "estimatedShipDate": 1738306800000, "methodCode": "Standard", "postalAddress": { "name": "Pooja seller", "address1": "Streetsville Memorial Park", "address2": null, "city": "Mississauga", "state": "AB", "postalCode": "T1L 0A1", "country": "CA", "addressType": "RESIDENTIAL" }, "carrierMethodName": null }, "orderLines": { "orderLine": [ { "lineNumber": "1", "item": { "productName": "SIGNATURE", "sku": "KNJ05700473062295" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "CAD", "amount": 70 }, "tax": { "taxName": "TAX", "taxAmount": { "currency": "CAD", "amount": 0.65 } }, "taxDetails": [ { "taxName": "HST", "taxAmount": { "currency": "CAD", "amount": 0.65 } } ], "isDiscount": false, "discountType": null }, { "chargeType": "SHIPPING", "chargeName": "SHIPPING", "chargeAmount": { "currency": "CAD", "amount": 4.42 }, "tax": { "taxName": "GST", "taxAmount": { "currency": "CAD", "amount": 0.22 } }, "isDiscount": false, "discountType": null }, { "chargeType": "PRODUCT", "chargeName": "ITEM_PRICE_AFTER_DISCOUNT", "chargeAmount": { "currency": "CAD", "amount": 70 }, "tax": { "taxAmount": { "currency": "CAD", "amount": 0 } }, "isDiscount": null, "discountType": null }, { "chargeType": "TAX", "chargeName": "TAX", "chargeAmount": { "currency": "CAD", "amount": 3.72 }, "tax": { "taxAmount": { "currency": "CAD", "amount": 0 } }, "isDiscount": false, "discountType": null } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "2" }, "orderLineStatuses": { "orderLineStatus": [ { "status": "Created", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "2" }, "cancellationReason": null, "trackingInfo": null, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "S2H", "shipMethod": "STANDARD", "storeId": null, "offerId": "0E3874750D8233BCAF98946AAD2B58F9", "pickUpDateTime": null, "pickUpBy": null, "shippingProgramType": null, "predictedShipNodeId": "10011361366", "predictedShipNodeName": "selleronboardingtestad2011 - 10011361366 - MP" } } ] } }
}
{ "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" } }
}

200 Sample 3 - CL Response application/json sample code

{ "order": { "purchaseOrderId": "P100650592", "customerOrderId": "2582530000022", "orderDate": 1740683830000, "shippingInfo": { "phone": "+56567657687", "estimatedDeliveryDate": 1741215600000, "estimatedShipDate": 1740722400000, "methodCode": "STANDARD", "postalAddress": { "name": "user chile", "address1": "Rosario Sur", "address2": "615", "city": "Las Condes", "state": "Región Metropolitana", "country": "CL", "addressType": null }, "carrierMethodName": null }, "orderSummary": { "totalAmount": { "amount": 268143.5, "currency": "CLP" }, "orderSubTotal": [ { "subTotalType": "SHIPPING", "totalAmount": { "amount": 2504, "currency": "CLP" } }, { "subTotalType": "TAX", "totalAmount": { "amount": 8500.5, "currency": "CLP" } }, { "subTotalType": "PRODUCT", "totalAmount": { "amount": 257139, "currency": "CLP" } }, { "subTotalType": "DISCOUNT", "totalAmount": { "amount": 0, "currency": "CLP" } } ] }, "orderLines": { "orderLine": [ { "lineNumber": "1", "item": { "productName": "Category Translation ByGTIN", "sku": "S23053108130613" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "CLP", "amount": 114284 }, "tax": { "taxName": "IVA_TAX", "taxAmount": { "currency": "CLP", "amount": 14477.32 } }, "isDiscount": null, "discountType": null }, { "chargeType": "COMMISSION", "chargeName": "Commission", "chargeAmount": { "currency": "CLP", "amount": 0 }, "tax": { "taxAmount": { "currency": "CLP", "amount": 0 } }, "isDiscount": null, "discountType": null }, { "chargeType": "SHIPPING", "chargeName": "Shipping", "chargeAmount": { "currency": "CLP", "amount": 5008 }, "tax": { "taxName": "SHIP_IVA_TAX", "taxAmount": { "currency": "CLP", "amount": 634.68 } }, "isDiscount": null, "discountType": null }, { "chargeType": "TAX", "chargeName": "TAX", "chargeAmount": { "currency": "CLP", "amount": 15112 }, "tax": { "taxAmount": { "currency": "CLP", "amount": 0 } }, "isDiscount": null, "discountType": null }, { "chargeType": "DISCOUNT", "chargeName": "DISCOUNT", "chargeAmount": { "currency": "CLP", "amount": 0 }, "tax": { "taxAmount": { "currency": "CLP", "amount": 0 } }, "isDiscount": null, "discountType": null } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "4" }, "orderLineStatuses": { "orderLineStatus": [ { "status": "Acknowledged", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "4" }, "cancellationReason": null, "trackingInfo": { "carrierName": { "otherCarrier": null, "carrier": null }, "methodCode": "STANDARD", "carrierMethodCode": null, "trackingURL": null, "packageStatus": null, "shipmentNo": "778510292_1", "actualDeliveryDateTime": null }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null }, { "status": "Cancelled", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "2" }, "cancellationReason": "", "trackingInfo": { "carrierName": { "otherCarrier": null, "carrier": null }, "methodCode": "STANDARD", "carrierMethodCode": null, "trackingURL": null, "packageStatus": null, "shipmentNo": null, "actualDeliveryDateTime": null }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "Seller", "shipMethod": "STANDARD", "storeId": "10900069993", "offerId": "5BCA7D78D4F035C6844D032D81FECA08", "pickUpDateTime": null, "pickUpBy": null, "shippingProgramType": null, "predictedShipNodeId": "10900069993", "predictedShipNodeName": "TestWFS_Sept1" } }, { "lineNumber": "2", "item": { "productName": "Bicicleta Guayacan Aro 27.5 Negro/Amarillo 2", "sku": "SKU98764786095340" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "CLP", "amount": 17639 }, "tax": { "taxName": "IVA_TAX", "taxAmount": { "currency": "CLP", "amount": 3351 } }, "isDiscount": null, "discountType": null }, { "chargeType": "COMMISSION", "chargeName": "Commission", "chargeAmount": { "currency": "CLP", "amount": 0 }, "tax": { "taxAmount": { "currency": "CLP", "amount": 0 } }, "isDiscount": null, "discountType": null }, { "chargeType": "SHIPPING", "chargeName": "Shipping", "chargeAmount": { "currency": "CLP", "amount": 0 }, "tax": { "taxName": "SHIP_IVA_TAX", "taxAmount": { "currency": "CLP", "amount": 0 } }, "isDiscount": null, "discountType": null }, { "chargeType": "TAX", "chargeName": "TAX", "chargeAmount": { "currency": "CLP", "amount": 3351 }, "tax": { "taxAmount": { "currency": "CLP", "amount": 0 } }, "isDiscount": null, "discountType": null }, { "chargeType": "DISCOUNT", "chargeName": "DISCOUNT", "chargeAmount": { "currency": "CLP", "amount": 0 }, "tax": { "taxAmount": { "currency": "CLP", "amount": 0 } }, "isDiscount": null, "discountType": null } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "5" }, "orderLineStatuses": { "orderLineStatus": [ { "status": "Acknowledged", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "5" }, "cancellationReason": null, "trackingInfo": { "carrierName": { "otherCarrier": null, "carrier": null }, "methodCode": "STANDARD", "carrierMethodCode": null, "trackingURL": null, "packageStatus": null, "shipmentNo": "779510292_1", "actualDeliveryDateTime": null }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null }, { "status": "Cancelled", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": "", "trackingInfo": { "carrierName": { "otherCarrier": null, "carrier": null }, "methodCode": "STANDARD", "carrierMethodCode": null, "trackingURL": null, "packageStatus": null, "shipmentNo": null, "actualDeliveryDateTime": null }, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "Seller", "shipMethod": "STANDARD", "storeId": "10900069993", "offerId": "C101C8B5182632CDA23B42E15C2B845E", "pickUpDateTime": null, "pickUpBy": null, "shippingProgramType": null, "predictedShipNodeId": "10900069993", "predictedShipNodeName": "TestWFS_Sept1" } } ] } }
}
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.GMP_ORDER_API", "description": "Invalid request content.", "info": "Request content is not valid.", "severity": "ERROR", "category": "DATA" } ]
}

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" } ]
}

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

{ "code": "REQUEST_THRESHOLD_VIOLATED", "description": "Too many requests in a given amount of time.", "info": "You have exceeded the rate limit for this API. Retry after the time indicated in the Retry-After header.", "severity": "ERROR", "category": "SYSTEM", "causes": [], "errorIdentifiers": {}, "field": "RateLimitExceeded"
}

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" } ]
}

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"
}

500 Response application/problem+json sample code

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

Result

A successful response returns:

  • purchaseOrderId: Purchase order ID
  • customerOrderId: Customer order ID
  • customerEmailId: Customer email ID
  • orderDate: The order date
  • shippingInfo: Shipping info which includes phone number, delivery estimate, ship estimate, method, and postal address
  • orderLines.orderLine: Shipment or cancellation details for a single line in the purchase order.
  • charges: The price, shipping, tax, commission, and discount amounts
  • orderLineQuantity: The number of units for each line
  • orderLineStatuses: The status, such as created, acknowledged, shipped, delivered, or cancelled
  • trackingInfo: The tracking details, such as carrier name, tracking number, tracking URL, shipment number, package status, and delivery time
  • fulfillment: The fulfillment type, shipping method, service level agreement (SLA), predicted ship node, and pickup fields
  • shipNode: The fulfillment center

Error responses indicates:

  • 400 invalid request content
  • 401 authentication failure
  • 403 permission denied
  • 404 order not found
  • 429 rate limit exceeded
  • 500 server error

Next Steps

  • Add the purchaseOrderId to the request path.
  • Include the required Walmart authentication headers.
  • Parse the returned order object into your OMS screens or downstream workflow.
  • Use orderLineStatuses and trackingInfo to determine shipment progress.
  • Handle regional currency and address differences in your application logic.
  • Add error handling for invalid requests, authentication failures, missing orders, rate limiting, or server errors.