MealMe · Schema

OrderRequest

OrderRequest schema from MealMe Food Ordering API

DeliveryFoodGroceryOrderingRestaurants

Properties

Name Type Description
place_order boolean When false, returns a finalizable quote rather than placing.
order_id string
items array
pickup boolean
scheduled_id string
driver_tip_cents integer
pickup_tip_cents integer
user_latitude number
user_longitude number
user_street_num string
user_street_name string
user_apt_num string
user_city string
user_state string
user_country string
user_zipcode string
user_dropoff_notes string
user_pickup_notes string
user_name string
user_email string
user_phone integer
user_id string
payment_method_id string
charge_user boolean
include_final_quote boolean
disable_sms boolean
customer_order_id string
metadata object
tracking_link string
View JSON Schema on GitHub

JSON Schema

mealme-api-order-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mealme/refs/heads/main/json-schema/mealme-api-order-request-schema.json",
  "title": "OrderRequest",
  "description": "OrderRequest schema from MealMe Food Ordering API",
  "type": "object",
  "properties": {
    "place_order": {
      "type": "boolean",
      "description": "When false, returns a finalizable quote rather than placing.",
      "example": false
    },
    "order_id": {
      "type": "string",
      "example": "ord_8f2a1c9b"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CartItem"
      }
    },
    "pickup": {
      "type": "boolean",
      "example": false
    },
    "scheduled_id": {
      "type": "string",
      "example": "id_7b2c4e"
    },
    "driver_tip_cents": {
      "type": "integer",
      "example": 1299
    },
    "pickup_tip_cents": {
      "type": "integer",
      "example": 1299
    },
    "user_latitude": {
      "type": "number",
      "example": 37.7786357
    },
    "user_longitude": {
      "type": "number",
      "example": -122.3918135
    },
    "user_street_num": {
      "type": "string",
      "example": "188"
    },
    "user_street_name": {
      "type": "string",
      "example": "King Street"
    },
    "user_apt_num": {
      "type": "string",
      "example": "example"
    },
    "user_city": {
      "type": "string",
      "example": "San Francisco"
    },
    "user_state": {
      "type": "string",
      "example": "CA"
    },
    "user_country": {
      "type": "string",
      "enum": [
        "US",
        "CA"
      ],
      "example": "US"
    },
    "user_zipcode": {
      "type": "string",
      "example": "94107"
    },
    "user_dropoff_notes": {
      "type": "string",
      "example": "Leave at the front desk"
    },
    "user_pickup_notes": {
      "type": "string",
      "example": "Leave at the front desk"
    },
    "user_name": {
      "type": "string",
      "example": "Steve Jobs"
    },
    "user_email": {
      "type": "string",
      "format": "email",
      "example": "[email protected]"
    },
    "user_phone": {
      "type": "integer",
      "example": 14155550123
    },
    "user_id": {
      "type": "string",
      "example": "user_abc123"
    },
    "payment_method_id": {
      "type": "string",
      "example": "id_7b2c4e"
    },
    "charge_user": {
      "type": "boolean",
      "example": false
    },
    "include_final_quote": {
      "type": "boolean",
      "example": false
    },
    "disable_sms": {
      "type": "boolean",
      "example": false
    },
    "customer_order_id": {
      "type": "string",
      "example": "id_7b2c4e"
    },
    "metadata": {
      "type": "object",
      "example": {}
    },
    "tracking_link": {
      "type": "string",
      "example": "https://example.com/webhook"
    }
  },
  "required": [
    "items",
    "pickup",
    "user_name",
    "user_email",
    "user_phone",
    "user_id"
  ]
}