doordash · JSON Structure

Doordash Report Ready Payload Structure

ReportReadyPayload structure from DoorDash API

Type: object Properties: 7

ReportReadyPayload is a JSON Structure definition published by doordash, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

report_id report_type status download_url error_message created_at completed_at

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/doordash/refs/heads/main/json-structure/doordash-report-ready-payload-structure.json",
  "name": "ReportReadyPayload",
  "description": "ReportReadyPayload structure from DoorDash API",
  "type": "object",
  "properties": {
    "report_id": {
      "type": "string",
      "description": "The unique identifier for the report.",
      "example": "D-12345"
    },
    "report_type": {
      "type": "string",
      "description": "The type of report that was generated.",
      "enum": [
        "financial",
        "operations",
        "menu",
        "feedback"
      ],
      "example": "financial"
    },
    "status": {
      "type": "string",
      "description": "The report processing status.",
      "enum": [
        "SUCCEEDED",
        "FAILED"
      ],
      "example": "SUCCEEDED"
    },
    "download_url": {
      "type": "uri",
      "description": "A temporary URL to download the report. Only present when status is SUCCEEDED.",
      "example": "https://example.com/path/abc123"
    },
    "error_message": {
      "type": "string",
      "description": "Error details if report generation failed. Only present when status is FAILED.",
      "example": "example"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the report request was originally created.",
      "example": "2026-06-02T14:30:00Z"
    },
    "completed_at": {
      "type": "datetime",
      "description": "When the report generation completed.",
      "example": "2026-06-02T14:30:00Z"
    }
  }
}