grubhub · JSON Structure

Grubhub Orderstatusupdate Structure

Payload for updating an order's lifecycle status.

Type: object Properties: 2 Required: 1

OrderStatusUpdate is a JSON Structure definition published by grubhub, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status reason

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/grubhub/refs/heads/main/json-structure/grubhub-orderstatusupdate-structure.json",
  "name": "OrderStatusUpdate",
  "description": "Payload for updating an order's lifecycle status.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The new status for the order.",
      "enum": [
        "IN_PROGRESS",
        "READY",
        "OUT_FOR_DELIVERY",
        "COMPLETED",
        "CANCELLED"
      ]
    },
    "reason": {
      "type": "string",
      "description": "Reason for the status change, particularly relevant for cancellations."
    }
  },
  "required": [
    "status"
  ]
}