grubhub · JSON Structure

Grubhub Referralresponse Structure

Response after successfully creating a merchant referral.

Type: object Properties: 3

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

Properties

referral_id merchant_id status

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-referralresponse-structure.json",
  "name": "ReferralResponse",
  "description": "Response after successfully creating a merchant referral.",
  "type": "object",
  "properties": {
    "referral_id": {
      "type": "string",
      "description": "The unique identifier for this referral."
    },
    "merchant_id": {
      "type": "string",
      "description": "The assigned Grubhub merchant identifier."
    },
    "status": {
      "type": "string",
      "description": "The current status of the referral.",
      "enum": [
        "PENDING",
        "APPROVED",
        "REJECTED"
      ]
    }
  }
}