grubhub · Schema

Grubhub Courier Location Payload

Webhook payload for a courier location or ETA update.

Properties

Name Type Description
event_type string The type of delivery event.
order_uuid string The UUID of the associated order.
delivery_id string The unique identifier for the delivery.
latitude number The courier's current latitude coordinate.
longitude number The courier's current longitude coordinate.
pickup_eta string Updated estimated time of arrival at pickup.
dropoff_eta string Updated estimated time of arrival at dropoff.
timestamp string When this location update was recorded.
View JSON Schema on GitHub

JSON Schema

grubhub-courierlocationpayload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.grubhub.com/schemas/grubhub/courierlocationpayload.json",
  "title": "Grubhub Courier Location Payload",
  "description": "Webhook payload for a courier location or ETA update.",
  "type": "object",
  "properties": {
    "event_type": {
      "type": "string",
      "description": "The type of delivery event.",
      "const": "COURIER_LOCATION_UPDATE",
      "example": "STANDARD"
    },
    "order_uuid": {
      "type": "string",
      "format": "uuid",
      "description": "The UUID of the associated order.",
      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "delivery_id": {
      "type": "string",
      "description": "The unique identifier for the delivery.",
      "example": "id-1234567890"
    },
    "latitude": {
      "type": "number",
      "format": "double",
      "description": "The courier's current latitude coordinate.",
      "example": 41.8781
    },
    "longitude": {
      "type": "number",
      "format": "double",
      "description": "The courier's current longitude coordinate.",
      "example": -87.6298
    },
    "pickup_eta": {
      "type": "string",
      "format": "date-time",
      "description": "Updated estimated time of arrival at pickup.",
      "example": "2026-06-02T18:30:00Z"
    },
    "dropoff_eta": {
      "type": "string",
      "format": "date-time",
      "description": "Updated estimated time of arrival at dropoff.",
      "example": "2026-06-02T18:30:00Z"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "When this location update was recorded.",
      "example": "2026-06-02T18:30:00Z"
    }
  }
}