Deliveroo · JSON Structure

Order Api Order Status Update Structure

Request body for updating an order's status.

Type: object Properties: 3 Required: 1
Food DeliveryGroceryMarketplaceLogisticsRestaurants

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

Properties

status reject_reason notes

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/deliveroo/refs/heads/main/json-structure/order-api-order-status-update-structure.json",
  "name": "OrderStatusUpdate",
  "description": "Request body for updating an order's status.",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "accepted",
        "rejected",
        "confirmed"
      ],
      "description": "The new status for the order.",
      "example": "accepted"
    },
    "reject_reason": {
      "type": "string",
      "nullable": true,
      "enum": [
        "closing_early",
        "busy",
        "ingredient_unavailable",
        "other"
      ],
      "description": "Required when status is rejected. The reason for rejection.",
      "example": "busy"
    },
    "notes": {
      "type": "string",
      "nullable": true,
      "description": "Free-text notes accompanying the status change.",
      "example": "example"
    }
  },
  "required": [
    "status"
  ]
}