grubhub · JSON Structure

Grubhub Merchantstatusupdaterequest Structure

Request to update online/offline status for a batch of merchants.

Type: object Properties: 1 Required: 1

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

Properties

merchants

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-merchantstatusupdaterequest-structure.json",
  "name": "MerchantStatusUpdateRequest",
  "description": "Request to update online/offline status for a batch of merchants.",
  "type": "object",
  "properties": {
    "merchants": {
      "type": "array",
      "description": "List of merchants to update.",
      "items": {
        "type": "object",
        "required": [
          "merchant_id",
          "status"
        ],
        "properties": {
          "merchant_id": {
            "type": "string",
            "description": "The Grubhub merchant identifier."
          },
          "status": {
            "type": "string",
            "description": "The desired status for the merchant.",
            "enum": [
              "ONLINE",
              "OFFLINE"
            ]
          },
          "pause_type": {
            "type": "string",
            "description": "The type of pause to apply when setting offline. A soft pause takes the merchant offline for the remainder of the business day. A hard pause takes the merchant offline for multiple days.",
            "enum": [
              "SOFT",
              "HARD"
            ]
          }
        }
      }
    }
  },
  "required": [
    "merchants"
  ]
}