API Request Documentation
The following API request documentation is available. The requests are listed in the general sequence of being called.
| Request Name | Endpoint | Meaning |
|---|---|---|
| Create an authentication token | POST https://developer.api.us.walmart.com/api-proxy/service/identity/oauth/v1/token proxy/service/identity/oauth/v1/token | This request creates an access token. The access token (also known as an authentication token) is required to make a request. |
| Add Location Eligibility | POST /deliveries/location/eligibility | This request confirms a customer’s order can be delivered based on the order delivery destination. Call this request before booking a delivery to determine if a customer's location is eligible for a delivery. |
| Book Delivery | POST /deliveries | This request books Walmart GoLocal to deliver the customer’s order. Call this request when the order is ready to book a Walmart GoLocal delivery. |
| Quote | POST /deliveries/quote | This request returns the delivery price. You can request a quote before booking a delivery. If you book a delivery while the quote is still valid, the quote will be respected. The duration for which the fee is valid will be provided to you in the response to your quote request. |
| Update Delivery | PUT /deliveries/{deliveryId}/update | This request updates delivery details after delivery booking. Call this request after the delivery is booked and the customer's information, such as the delivery address or the customer name, needs to be updated. |
| Cancel Delivery | PUT /deliveries/{deliveryId}/cancel | This request cancels a delivery after delivery booking and before the delivery driver pickup. Call this request when the order is canceled, either by the customer or for any other reason. |
| Order Status | PUT /deliveries/{deliveryId}/orderStatus | This request is reserved for future enhancements. This API is used to provide drivers an update when an order is ready for pickup. |
| Add Tip | POST /clients/tips | This request provides a tip for the delivery driver. Call this request to add a tip for the driver. Tips may be added up to 14 days after the delivery is completed. Tips may also be added after a delivery is created, but before it is delivered (requires pre-tipping to be enabled by Walmart for specific stores). |
| Retrieve Tip Details | GET /clients/tips/client/{clientId}/externalorder/{externalOrderId} | This request retrieves the tipping details for the delivery driver. Call this request to retrieve tip details. |
| Add Feedback | POST /clients/feedbacks | This request provides feedback about the delivery or delivery driver. Call this request after capturing customer's feedback about the delivery and delivery driver experience. |
| Retrieve Feedback Details | GET /clients/feedbacks?clientId={clientId}&externalOrder={externalOrderId} | This request retrieves feedback about the delivery or delivery driver. Call this request to retrieve customer's feedback and ratings about their delivery experiences. |
| Retrieve delivery details by deliveryId | GET Delivery Details Request (by deliveryId) /deliveries/{deliveryId} | This API request provides order information, delivery status updates, and the URL to access a delivery's Live Order Tracking. Use this request to retrieve details about the specified delivery. This request provides order information and delivery details as well as the URL to access a delivery’s Live Order Tracking. See Live Order Tracking for additional information. |
| Retrieve delivery details by clientId and externalOrderId | GET /deliveries?clientId={clientId}&externalOrderId={externalOrderId} | This request retrieves details about all deliveries for an externalOrderId. There can be multiple deliveries for an order, based on the following actions by Walmart: 1. Reschedule Action: The delivery is canceled. A new delivery will be booked with a new delivery window. 2. Add Driver Action: A delivery is attached to the original order due to a large order or forgotten items. This request provides order information, delivery details, and the URL to access a delivery’s Live Order Tracking. See Live Order Tracking for additional information. |
| Search Deliveries | POST /deliveries/search | Use this request to search for, and to get additional information about deliveries. |
Updated 8 days ago