Guides
My Account

Webhook Requests

(Events will be published to the webhook endpoint provided by the client.)

Webhooks notify clients when specified events occur.

There are two webhooks Walmart GoLocal supports.

  • Delivery Status Webhook. This webhook provides delivery status updates throughout the Walmart GoLocal delivery process for a specific customer’s order. Walmart GoLocal sends chain of custody details (scanDetails) in the Delivery Status webhook to include all scanIds scanned by driver at pickup and drop-off events. This will inform the client that items have been scanned at pickup through the ENROUTE_TO_DROPOFF status webhook and at drop-off through the DELIVERED status webhook. Listen to this webhook for real-time updates to ongoing deliveries. It also provides the URL to access a delivery’s Live Order Tracking. Select which events to trigger notifications to the customers and dependent systems. Use the Delivery Updates request parameter set for the delivery destination address object.
  • Driver Location Webhook. This provides the client the delivery driver's location every 30 seconds once the delivery trip has started. It provides a URL for the client to access a delivery's Live Order Tracking. This webhook provides the client the delivery driver location’s latitude and longitude coordinates every 30 seconds once the delivery trip has started. Use this information to populate a map to share with the end customer. Use the Driver_Location_Updates request parameter set for the delivery driver Location object.

Live Order Tracking

Once a delivery driver is assigned to the delivery, Walmart GoLocal provides a URL to access Live Order Tracking for the delivery in process in this Webhook response. Walmart GoLocal recommends using the full URL as provided. Do not construct or store it as the base URL and the deliveryId. The URL may change over time.

The Live Order Tracking URL routes the user to a Walmart GoLocal-hosted webpage. This webpage provides live status about the delivery order and delivery driver location. Tracking will end one month after delivery completion.

Walmart GoLocal passes this URL along to the end customer in all related communications, such as SMS messages.

Batching Orders

A batchId field is added to the Webhook payload. This identifier is pushed during an ongoing delivery to your system, once Walmart GoLocal batches that delivery. Implement the system design and operational processes with this in mind.

A notification will be sent once a delivery is batched. A batchId will be sent in that update, which identifies the other deliveries that are part of the same batch. Those deliveries will be picked up by the same delivery driver. Notify users and operations about this or display those deliveries as grouped together on your internal apps and systems.

The following fields are available in the webhook payload. These fields will be returned in the payload once Walmart GoLocal batches the associated delivery with other deliveries (after trip creation). Implement system design and operational processes keeping this in mind.

  • batchingDetails
  • routeId
  • dropSequence
  • count

Updated 7 days ago