Flipdish · Schema

UpdateFulfillmentStatesConfiguration

Update fulfillment states configuration

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
OverwriteSystemTemplate boolean Set to true if a system configuration template is to be updated (permissions also needed)
StoreIds array Stores id's
StoreSelectorType string Store Selector Type
States array Settings
AutomaticTransitionsEnabled boolean Enable automatic transitions
Name string Name
View JSON Schema on GitHub

JSON Schema

orders-update-fulfillment-states-configuration-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-update-fulfillment-states-configuration-schema.json",
  "title": "UpdateFulfillmentStatesConfiguration",
  "description": "Update fulfillment states configuration",
  "type": "object",
  "properties": {
    "OverwriteSystemTemplate": {
      "description": "Set to true if a system configuration template is to be updated (permissions also needed)",
      "type": "boolean",
      "nullable": true,
      "example": true
    },
    "StoreIds": {
      "description": "Stores id's",
      "type": "array",
      "items": {
        "format": "int32",
        "type": "integer"
      },
      "example": [
        1
      ]
    },
    "StoreSelectorType": {
      "description": "Store Selector Type",
      "enum": [
        "None",
        "Single",
        "Multiple"
      ],
      "type": "string",
      "example": "None"
    },
    "States": {
      "description": "Settings",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FulfillmentStatusConfigurationItem"
      },
      "example": []
    },
    "AutomaticTransitionsEnabled": {
      "description": "Enable automatic transitions",
      "type": "boolean",
      "nullable": true,
      "example": true
    },
    "Name": {
      "description": "Name",
      "type": "string",
      "example": "Example Name"
    }
  }
}