Flipdish · Schema

PreviousOrder

PreviousOrder schema from Flipdish API - Payments.

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
DeliveryType	string
DeliveryLocationAddressString	string
PaymentAccountType	string
OrderId	integer
ReceiptCode	string
RestaurantName	string
LocalOrderId	string
TableServiceCategory	string
PickupLocationOptionValue	string
CustomerName	string
PhoneNumberInternationalFormatString	string
DeliveryInstructions	string
Currency	string
ProcessingFee	number
ServiceChargePercentage	number
ServiceChargeAmount	number
TipAmount	number
DeliveryAmount	number
DepositReturnFeeAmount	number
TotalTax	number
TotalAmount	number
Items	array
TaxRates	array
WhiteLabelId	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/payments-previous-order-schema.json",
  "title": "PreviousOrder",
  "description": "PreviousOrder schema from Flipdish API - Payments.",
  "type": "object",
  "properties": {
    "DeliveryType": {
      "type": "string",
      "example": "string"
    },
    "DeliveryLocationAddressString": {
      "type": "string",
      "example": "string"
    },
    "PaymentAccountType": {
      "type": "string",
      "example": "string"
    },
    "OrderId": {
      "format": "int32",
      "type": "integer",
      "example": 500123
    },
    "ReceiptCode": {
      "type": "string",
      "example": "string"
    },
    "RestaurantName": {
      "type": "string",
      "example": "Example Name"
    },
    "LocalOrderId": {
      "type": "string",
      "example": "500123"
    },
    "TableServiceCategory": {
      "type": "string",
      "example": "string"
    },
    "PickupLocationOptionValue": {
      "type": "string",
      "example": "string"
    },
    "CustomerName": {
      "type": "string",
      "example": "Example Name"
    },
    "PhoneNumberInternationalFormatString": {
      "type": "string",
      "example": "+353000000000"
    },
    "DeliveryInstructions": {
      "type": "string",
      "example": "string"
    },
    "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"
    },
    "ProcessingFee": {
      "format": "double",
      "type": "number",
      "example": 12.5
    },
    "ServiceChargePercentage": {
      "format": "double",
      "type": "number",
      "example": 1.0
    },
    "ServiceChargeAmount": {
      "format": "double",
      "type": "number",
      "example": 12.5
    },
    "TipAmount": {
      "format": "double",
      "type": "number",
      "example": 12.5
    },
    "DeliveryAmount": {
      "format": "double",
      "type": "number",
      "example": 12.5
    },
    "DepositReturnFeeAmount": {
      "format": "double",
      "type": "number",
      "example": 12.5
    },
    "TotalTax": {
      "format": "double",
      "type": "number",
      "example": 12.5
    },
    "TotalAmount": {
      "format": "double",
      "type": "number",
      "example": 12.5
    },
    "Items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PreviousOrderItem"
      },
      "example": []
    },
    "TaxRates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TaxRate"
      },
      "example": []
    },
    "WhiteLabelId": {
      "format": "int32",
      "type": "integer",
      "example": 500123
    }
  }
}