Flipdish · JSON Structure

Platform Customer Delivery Tracking Order Structure

Defines the order data required for customer driver tracking

Type: object Properties: 19
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

OrderId Address DeliveryNotes StorePhoneNumber AppIconUrl OrderTrackingCode PaymentMethodDescription LastFourDigits OrderLines TotalAmount Currency Latitude Longitude Placed RequestedFor DriverId DriverName DriverImage EstimatedMinutesForDelivery

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/flipdish/refs/heads/main/json-structure/platform-customer-delivery-tracking-order-structure.json",
  "name": "CustomerDeliveryTrackingOrder",
  "description": "Defines the order data required for customer driver tracking",
  "type": "object",
  "properties": {
    "OrderId": {
      "description": "Order Id",
      "type": "int32",
      "example": 500123
    },
    "Address": {
      "description": "Pretified address string in country format",
      "type": "string",
      "example": "string"
    },
    "DeliveryNotes": {
      "description": "Delivery Notes",
      "type": "string",
      "example": "string"
    },
    "StorePhoneNumber": {
      "description": "Phone number of the store",
      "type": "string",
      "example": "+353000000000"
    },
    "AppIconUrl": {
      "description": "App Icon of the store",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "OrderTrackingCode": {
      "description": "Order Tracking Code",
      "type": "string",
      "example": "string"
    },
    "PaymentMethodDescription": {
      "description": "Payment method description i.e Cash/Card/iDeal/Paypal",
      "type": "string",
      "example": "string"
    },
    "LastFourDigits": {
      "description": "Last 4 digits of the card if applicable otherwise null",
      "type": "string",
      "example": "string"
    },
    "OrderLines": {
      "description": "Order lines of the order",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomerDeliveryTrackingOrderLine"
      },
      "example": []
    },
    "TotalAmount": {
      "description": "Total amount for the order including tax",
      "type": "double",
      "example": 12.5
    },
    "Currency": {
      "description": "Currency",
      "enum": [
        "EUR",
        "USD",
        "GBP",
        "CAD",
        "AUD",
        "DJF",
        "ZAR",
        "ETB",
        "AED",
        "BHD",
        "DZD",
        "EGP",
        "IQD",
        "JOD",
        "KWD",
        "LBP",
        "LYD",
        "MAD",
        "OMR",
        "QAR",
        "SAR",
        "SYP",
        "TND",
        "YER",
        "CLP",
        "INR",
        "AZN",
        "RUB",
        "BYN",
        "BGN",
        "NGN",
        "BDT",
        "CNY",
        "BAM",
        "CZK",
        "DKK",
        "CHF",
        "MVR",
        "BTN",
        "XCD",
        "BZD",
        "HKD",
        "IDR",
        "JMD",
        "MYR",
        "NZD",
        "PHP",
        "SGD",
        "TTD",
        "XDR",
        "ARS",
        "BOB",
        "COP",
        "CRC",
        "CUP",
        "DOP",
        "GTQ",
        "HNL",
        "MXN",
        "NIO",
        "PAB",
        "PEN",
        "PYG",
        "UYU",
        "VEF",
        "IRR",
        "XOF",
        "CDF",
        "XAF",
        "HTG",
        "ILS",
        "HRK",
        "HUF",
        "AMD",
        "ISK",
        "JPY",
        "GEL",
        "KZT",
        "KHR",
        "KRW",
        "KGS",
        "LAK",
        "MKD",
        "MNT",
        "BND",
        "MMK",
        "NOK",
        "NPR",
        "PKR",
        "PLN",
        "AFN",
        "BRL",
        "MDL",
        "RON",
        "RWF",
        "SEK",
        "LKR",
        "SOS",
        "ALL",
        "RSD",
        "KES",
        "TJS",
        "THB",
        "ERN",
        "TMT",
        "BWP",
        "TRY",
        "UAH",
        "UZS",
        "VND",
        "MOP",
        "TWD",
        "BMD"
      ],
      "type": "string",
      "example": "EUR"
    },
    "Latitude": {
      "description": "Customer Location Latitude",
      "type": "double",
      "example": 1.0
    },
    "Longitude": {
      "description": "Customer Location Longitude",
      "type": "double",
      "example": 1.0
    },
    "Placed": {
      "description": "Order placed time",
      "type": "datetime",
      "example": "2026-06-02T12:00:00Z"
    },
    "RequestedFor": {
      "description": "Order requested for",
      "type": "datetime",
      "example": "2026-06-02T12:00:00Z"
    },
    "DriverId": {
      "description": "Driver Id",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "DriverName": {
      "description": "Driver Name",
      "type": "string",
      "example": "Example Name"
    },
    "DriverImage": {
      "description": "Driver Image",
      "type": "string",
      "example": "string"
    },
    "EstimatedMinutesForDelivery": {
      "description": "",
      "type": "int32",
      "example": 1
    }
  }
}