Flipdish Orders API
Retrieve, batch, and manage orders, tips, and fulfillment state configuration for online ordering.
OpenAPI Specification
{
"openapi": "3.0.3",
"info": {
"title": "Flipdish API - Orders",
"version": "v1.0",
"description": "Flipdish Open API v1.0 \u2014 Orders operations. Flipdish is an online ordering and branded-app platform for restaurants and takeaways. This specification was derived from the official Flipdish Swagger document and grouped by resource domain.",
"contact": {
"name": "Flipdish Support",
"email": "[email protected]",
"url": "https://help.flipdish.com"
},
"x-generated-from": "https://api.flipdish.co/swagger/docs/v1.0",
"x-last-validated": "2026-06-02"
},
"servers": [
{
"url": "https://api.flipdish.co",
"description": "Flipdish production API"
}
],
"security": [
{
"oauth2": [
"api"
]
}
],
"tags": [
{
"name": "FulfillmentStateConfiguration",
"description": "Operations for Fulfillment State Configuration."
},
{
"name": "OrderBatches",
"description": "Operations for Order Batches."
},
{
"name": "OrderBatchingConfiguration",
"description": "Operations for Order Batching Configuration."
},
{
"name": "Orders",
"description": "Operations for Orders."
},
{
"name": "Tips",
"description": "Operations for Tips."
}
],
"paths": {
"/api/v1.0/{appId}/fulfillment/configuration/states": {
"get": {
"tags": [
"FulfillmentStateConfiguration"
],
"operationId": "SearchFulfillmentStatesConfigurations",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiArrayResult_FulfillmentStatesConfigurationSummary_"
},
"examples": {
"SearchFulfillmentStatesConfigurations200Example": {
"summary": "Default SearchFulfillmentStatesConfigurations 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SearchFulfillmentStatesConfigurations400Example": {
"summary": "Default SearchFulfillmentStatesConfigurations 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SearchFulfillmentStatesConfigurations401Example": {
"summary": "Default SearchFulfillmentStatesConfigurations 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SearchFulfillmentStatesConfigurations403Example": {
"summary": "Default SearchFulfillmentStatesConfigurations 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"SearchFulfillmentStatesConfigurations500Example": {
"summary": "Default SearchFulfillmentStatesConfigurations 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Search Fulfillment States Configurations",
"description": "Search Fulfillment States Configurations via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/fulfillment/configuration/states).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"post": {
"tags": [
"FulfillmentStateConfiguration"
],
"operationId": "CreateFulfillmentStatesConfig",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFulfillmentStatesConfiguration"
},
"examples": {
"CreateFulfillmentStatesConfigRequestExample": {
"summary": "Default CreateFulfillmentStatesConfig request",
"x-microcks-default": true,
"value": {
"StoreIds": [
1
],
"StoreSelectorType": "None",
"States": [],
"AutomaticTransitionsEnabled": true,
"Name": "Example Name"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_FulfillmentStatesConfiguration_"
},
"examples": {
"CreateFulfillmentStatesConfig200Example": {
"summary": "Default CreateFulfillmentStatesConfig 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"States": [],
"AutomaticTransitionsEnabled": true,
"AppId": "500123",
"ConfigurationUid": "500123",
"StoreSelectorType": "None",
"StoreIds": [
1
],
"Name": "Example Name"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateFulfillmentStatesConfig400Example": {
"summary": "Default CreateFulfillmentStatesConfig 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateFulfillmentStatesConfig401Example": {
"summary": "Default CreateFulfillmentStatesConfig 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateFulfillmentStatesConfig403Example": {
"summary": "Default CreateFulfillmentStatesConfig 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"404": {
"description": "NotFound",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateFulfillmentStatesConfig404Example": {
"summary": "Default CreateFulfillmentStatesConfig 404 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"CreateFulfillmentStatesConfig500Example": {
"summary": "Default CreateFulfillmentStatesConfig 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Create Fulfillment States Config",
"description": "Create Fulfillment States Config via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/fulfillment/configuration/states).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/fulfillment/configuration/states_template": {
"get": {
"tags": [
"FulfillmentStateConfiguration"
],
"operationId": "GetFulfillmentStatesConfigurationTemplate",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FulfillmentStatesConfiguration"
},
"examples": {
"GetFulfillmentStatesConfigurationTemplate200Example": {
"summary": "Default GetFulfillmentStatesConfigurationTemplate 200 response",
"x-microcks-default": true,
"value": {
"States": [],
"AutomaticTransitionsEnabled": true,
"AppId": "500123",
"ConfigurationUid": "500123",
"StoreSelectorType": "None",
"StoreIds": [
1
],
"Name": "Example Name"
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfigurationTemplate400Example": {
"summary": "Default GetFulfillmentStatesConfigurationTemplate 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfigurationTemplate401Example": {
"summary": "Default GetFulfillmentStatesConfigurationTemplate 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfigurationTemplate403Example": {
"summary": "Default GetFulfillmentStatesConfigurationTemplate 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"404": {
"description": "NotFound",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfigurationTemplate404Example": {
"summary": "Default GetFulfillmentStatesConfigurationTemplate 404 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfigurationTemplate500Example": {
"summary": "Default GetFulfillmentStatesConfigurationTemplate 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Get Fulfillment States Configuration Template",
"description": "Get Fulfillment States Configuration Template via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/fulfillment/configuration/states_template).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/{appId}/fulfillment/configuration/states/{configId}": {
"get": {
"tags": [
"FulfillmentStateConfiguration"
],
"operationId": "GetFulfillmentStatesConfiguration",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "configId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The config id path parameter.",
"example": "500123"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FulfillmentStatesConfiguration"
},
"examples": {
"GetFulfillmentStatesConfiguration200Example": {
"summary": "Default GetFulfillmentStatesConfiguration 200 response",
"x-microcks-default": true,
"value": {
"States": [],
"AutomaticTransitionsEnabled": true,
"AppId": "500123",
"ConfigurationUid": "500123",
"StoreSelectorType": "None",
"StoreIds": [
1
],
"Name": "Example Name"
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfiguration400Example": {
"summary": "Default GetFulfillmentStatesConfiguration 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfiguration401Example": {
"summary": "Default GetFulfillmentStatesConfiguration 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfiguration403Example": {
"summary": "Default GetFulfillmentStatesConfiguration 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"404": {
"description": "NotFound",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfiguration404Example": {
"summary": "Default GetFulfillmentStatesConfiguration 404 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetFulfillmentStatesConfiguration500Example": {
"summary": "Default GetFulfillmentStatesConfiguration 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
}
},
"security": [
{
"oauth2": [
"api"
]
}
],
"summary": "Flipdish Get Fulfillment States Configuration",
"description": "Get Fulfillment States Configuration via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/fulfillment/configuration/states/{configId}).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"post": {
"tags": [
"FulfillmentStateConfiguration"
],
"operationId": "UpdateFulfillmentStatesConfig",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "configId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The config id path parameter.",
"example": "500123"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateFulfillmentStatesConfiguration"
},
"examples": {
"UpdateFulfillmentStatesConfigRequestExample": {
"summary": "Default UpdateFulfillmentStatesConfig request",
"x-microcks-default": true,
"value": {
"OverwriteSystemTemplate": true,
"StoreIds": [
1
],
"StoreSelectorType": "None",
"States": [],
"AutomaticTransitionsEnabled": true,
"Name": "Example Name"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateFulfillmentStatesConfig400Example": {
"summary": "Default UpdateFulfillmentStatesConfig 400 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"401": {
"description": "Authentication has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateFulfillmentStatesConfig401Example": {
"summary": "Default UpdateFulfillmentStatesConfig 401 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"403": {
"description": "Successful authentication, but authorization has been denied for this request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateFulfillmentStatesConfig403Example": {
"summary": "Default UpdateFulfillmentStatesConfig 403 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"404": {
"description": "NotFound",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateFulfillmentStatesConfig404Example": {
"summary": "Default UpdateFulfillmentStatesConfig 404 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
"errorCode": "BadRequest",
"details": "Validation failed for field 'storeId'."
}
}
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"UpdateFulfillmentStatesConfig500Example": {
"summary": "Default UpdateFulfillmentStatesConfig 500 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or missing parameters.",
# --- truncated at 32 KB (246 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-orders-openapi.json