Flipdish · Schema

FulfillmentStatusConfigurationItem

Fulfillment Status Item

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
StatusId	string	Status Id (no whitespaces)
StatusName	string	Status name
Enabled	boolean	Is status enabled
DisplayName	string	The short status string that is displayed to users in apps, portal. If empty then Order Status Name is displayed instead
Icon	string	Icon/Image that represents that status visual
PublicDescription	string	A string which could be used in notification templates with a placeholder (SMS, email, push, web page with status)
Internal	boolean	Is internal state (internal states not shown to customers)
NextStatuses	array	list of statuses that this status can move to (can be back or forth)
DefaultNextStatus	array	The default next status (on a dropdown or quick button on terminal or portal)
ChangeType	string	How will state change (manually or automated, including timed)
IncludeInReports	boolean	Include in reports
IsCustom	boolean	Is custom state. If not, then it's a system state
OrderTypes	array	If empty then applies to all ordertypes, otherwise a list of order types this state applies to
Communication	boolean	Whether state should fire off a notification to the customer
Image	string	Image (image filename, relative, not absolute URL)

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/orders-fulfillment-status-configuration-item-schema.json",
  "title": "FulfillmentStatusConfigurationItem",
  "description": "Fulfillment Status Item",
  "type": "object",
  "properties": {
    "StatusId": {
      "description": "Status Id (no whitespaces)",
      "type": "string",
      "example": "500123"
    },
    "StatusName": {
      "description": "Status name",
      "type": "string",
      "example": "Example Name"
    },
    "Enabled": {
      "description": "Is status enabled",
      "type": "boolean",
      "example": true
    },
    "DisplayName": {
      "description": "The short status string that is displayed to users in apps, portal. If empty then Order Status Name is displayed instead",
      "type": "string",
      "example": "Example Name"
    },
    "Icon": {
      "description": "Icon/Image that represents that status visual",
      "type": "string",
      "example": "string"
    },
    "PublicDescription": {
      "description": "A string which could be used in notification templates with a placeholder (SMS, email, push, web page with status)",
      "type": "string",
      "example": "string"
    },
    "Internal": {
      "description": "Is internal state (internal states not shown to customers)",
      "type": "boolean",
      "example": true
    },
    "NextStatuses": {
      "description": "list of statuses that this status can move to (can be back or forth)",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "Active"
      ]
    },
    "DefaultNextStatus": {
      "description": "The default next status (on a dropdown or quick button on terminal or portal)",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/NextStatusWithOrderType"
      },
      "example": []
    },
    "ChangeType": {
      "description": "How will state change (manually or automated, including timed)",
      "enum": [
        "Manual",
        "Automated",
        "Integrated"
      ],
      "type": "string",
      "example": "Manual"
    },
    "IncludeInReports": {
      "description": "Include in reports",
      "type": "boolean",
      "example": true
    },
    "IsCustom": {
      "description": "Is custom state. If not, then it's a system state",
      "type": "boolean",
      "example": true
    },
    "OrderTypes": {
      "description": "If empty then applies to all ordertypes, otherwise a list of order types this state applies to",
      "type": "array",
      "items": {
        "enum": [
          "All",
          "Delivery",
          "Collection",
          "DineIn"
        ],
        "type": "string"
      },
      "example": [
        "All"
      ]
    },
    "Communication": {
      "description": "Whether state should fire off a notification to the customer",
      "type": "boolean",
      "example": true
    },
    "Image": {
      "description": "Image (image filename, relative, not absolute URL)",
      "type": "string",
      "example": "string"
    }
  }
}