Flipdish · Schema

OrderDeliveryInformation

Order Delivery Status Information

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
OrderId integer Order Id
ExternalReferenceId string External Reference Id
TrackUrl string Tracking Url
Status string Delivery Status
DeliveryStatusNotes string Delivery Status Notes
ErrorMessage string Error Message
IntegrationCode string Integration Code
IntegrationName string Integration Name
View JSON Schema on GitHub

JSON Schema

orders-order-delivery-information-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/orders-order-delivery-information-schema.json",
  "title": "OrderDeliveryInformation",
  "description": "Order Delivery Status Information",
  "type": "object",
  "properties": {
    "OrderId": {
      "format": "int32",
      "description": "Order Id",
      "type": "integer",
      "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"
    }
  }
}