MerchantOrderTypeHeartbeatPayload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/grubhub/main/json-schema/grubhub-merchantordertypeheartbeatpayload-schema.json",
  "title": "MerchantOrderTypeHeartbeatPayload",
  "x-generated": "2026-09-17",
  "x-method": "derived",
  "x-source": "openapi/grubhub-merchant-data-openapi.yml#/components/schemas/MerchantOrderTypeHeartbeatPayload",
  "required": [
    "merchant_id",
    "order_type_statuses"
  ],
  "type": "object",
  "properties": {
    "merchant_id": {
      "type": "string",
      "description": "The short Grubhub ID for the merchant OR the Partner merchant ID."
    },
    "order_type_statuses": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/HeartbeatTriggeredPayload"
      },
      "description": "Map of order type to heartbeat payload. Order type keys must be valid."
    }
  },
  "description": "Request to set merchant status online or offline for specific order types, with merchant ID.",
  "$defs": {
    "HeartbeatTriggeredPayload": {
      "required": [
        "new_pos_status"
      ],
      "type": "object",
      "properties": {
        "new_pos_status": {
          "type": "string",
          "description": "Merchant status, whether online/offline.",
          "enum": [
            "OFFLINE",
            "ONLINE"
          ]
        },
        "reason": {
          "type": "string",
          "description": "Reason for status change"
        }
      },
      "description": "Request to set merchant status online or offline."
    }
  }
}