Flipdish · JSON Structure

Orders Order Delivery Information Structure

Order Delivery Status Information

Type: object Properties: 8
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

OrderId ExternalReferenceId TrackUrl Status DeliveryStatusNotes ErrorMessage IntegrationCode IntegrationName

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/orders-order-delivery-information-structure.json",
  "name": "OrderDeliveryInformation",
  "description": "Order Delivery Status Information",
  "type": "object",
  "properties": {
    "OrderId": {
      "description": "Order Id",
      "type": "int32",
      "example": 500123
    },
    "ExternalReferenceId": {
      "description": "External Reference Id",
      "type": "string",
      "example": "500123"
    },
    "TrackUrl": {
      "description": "Tracking Url",
      "type": "string",
      "example": "https://api.flipdish.co/example"
    },
    "Status": {
      "description": "Delivery Status",
      "enum": [
        "None",
        "Unassigned",
        "Unaccepted",
        "Accepted",
        "Carrying",
        "OnTheWay",
        "ArrivedAtLocation",
        "Delivered",
        "CannotDeliver"
      ],
      "type": "string",
      "nullable": true,
      "example": "None"
    },
    "DeliveryStatusNotes": {
      "description": "Delivery Status Notes",
      "type": "string",
      "example": "Active"
    },
    "ErrorMessage": {
      "description": "Error Message",
      "type": "string",
      "example": "string"
    },
    "IntegrationCode": {
      "description": "Integration Code",
      "type": "string",
      "example": "string"
    },
    "IntegrationName": {
      "description": "Integration Name",
      "type": "string",
      "example": "Example Name"
    }
  }
}