Flipdish Stores API
Manage stores, store groups, locations, delivery zones, and store order capacity across a Flipdish brand.
OpenAPI Specification
{
"openapi": "3.0.3",
"info": {
"title": "Flipdish API - Stores",
"version": "v1.0",
"description": "Flipdish Open API v1.0 \u2014 Stores 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": "Address",
"description": "Operations for Address."
},
{
"name": "DeliveryZone",
"description": "Operations for Delivery Zone."
},
{
"name": "Location",
"description": "Operations for Location."
},
{
"name": "LocationAreas",
"description": "Operations for Location Areas."
},
{
"name": "StoreGroups",
"description": "Operations for Store Groups."
},
{
"name": "StoreOrderCapacity",
"description": "Operations for Store Order Capacity."
},
{
"name": "Stores",
"description": "Operations for Stores."
}
],
"paths": {
"/api/v1.0/address/countries": {
"get": {
"tags": [
"Address"
],
"operationId": "GetCountries",
"parameters": [
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The language query parameter.",
"example": "string"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_CountryFormResponse_"
},
"examples": {
"GetCountries200Example": {
"summary": "Default GetCountries 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"Value": "string",
"Label": "string"
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetCountries400Example": {
"summary": "Default GetCountries 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": {
"GetCountries401Example": {
"summary": "Default GetCountries 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": {
"GetCountries403Example": {
"summary": "Default GetCountries 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": {
"GetCountries500Example": {
"summary": "Default GetCountries 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 Countries",
"description": "Get Countries via the Flipdish Open API v1.0 (GET /api/v1.0/address/countries).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/app/{appId}/address/form": {
"get": {
"tags": [
"Address"
],
"operationId": "FormByApp",
"parameters": [
{
"name": "appId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The app id path parameter.",
"example": "500123"
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The language query parameter.",
"example": "string"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_AddressFormResponse_"
},
"examples": {
"FormByApp200Example": {
"summary": "Default FormByApp 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FormData": [],
"CountryCode": "IE",
"Language": "string",
"DisplayFormat": {
"OneLine": "string",
"TwoLines": [
"string"
]
}
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"FormByApp400Example": {
"summary": "Default FormByApp 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": {
"FormByApp401Example": {
"summary": "Default FormByApp 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": {
"FormByApp403Example": {
"summary": "Default FormByApp 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": {
"FormByApp500Example": {
"summary": "Default FormByApp 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 Form by App",
"description": "Form by App via the Flipdish Open API v1.0 (GET /api/v1.0/app/{appId}/address/form).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/address/country/{countryCode}/form": {
"get": {
"tags": [
"Address"
],
"operationId": "FormByCountry",
"parameters": [
{
"name": "countryCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The country code path parameter.",
"example": "IE"
},
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The language query parameter.",
"example": "string"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_AddressFormResponse_"
},
"examples": {
"FormByCountry200Example": {
"summary": "Default FormByCountry 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FormData": [],
"CountryCode": "IE",
"Language": "string",
"DisplayFormat": {
"OneLine": "string",
"TwoLines": [
"string"
]
}
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"FormByCountry400Example": {
"summary": "Default FormByCountry 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": {
"FormByCountry401Example": {
"summary": "Default FormByCountry 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": {
"FormByCountry403Example": {
"summary": "Default FormByCountry 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": {
"FormByCountry500Example": {
"summary": "Default FormByCountry 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 Form by Country",
"description": "Form by Country via the Flipdish Open API v1.0 (GET /api/v1.0/address/country/{countryCode}/form).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/address/templates": {
"post": {
"tags": [
"Address"
],
"operationId": "AddressTemplates",
"requestBody": {
"required": false,
"content": {}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiStringResult"
},
"examples": {
"AddressTemplates200Example": {
"summary": "Default AddressTemplates 200 response",
"x-microcks-default": true,
"value": {
"Data": "string"
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"AddressTemplates400Example": {
"summary": "Default AddressTemplates 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": {
"AddressTemplates401Example": {
"summary": "Default AddressTemplates 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": {
"AddressTemplates403Example": {
"summary": "Default AddressTemplates 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": {
"AddressTemplates500Example": {
"summary": "Default AddressTemplates 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 Address Templates",
"description": "Address Templates via the Flipdish Open API v1.0 (POST /api/v1.0/address/templates).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/address/google": {
"post": {
"tags": [
"Address"
],
"operationId": "FormatGoogleAddress",
"parameters": [
{
"name": "language",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"description": "The language query parameter.",
"example": "string"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GoogleAddress"
},
"examples": {
"FormatGoogleAddressRequestExample": {
"summary": "Default FormatGoogleAddress request",
"x-microcks-default": true,
"value": {
"Results": [],
"Result": {
"Address_components": [],
"Formatted_address": "string",
"Geometry": {
"Location": {},
"Location_type": "string",
"Viewport": {}
},
"Place_id": "500123",
"Types": [
"string"
]
},
"Status": "Active"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiResult_AddressFormResponse_"
},
"examples": {
"FormatGoogleAddress200Example": {
"summary": "Default FormatGoogleAddress 200 response",
"x-microcks-default": true,
"value": {
"Data": {
"FormData": [],
"CountryCode": "IE",
"Language": "string",
"DisplayFormat": {
"OneLine": "string",
"TwoLines": [
"string"
]
}
}
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"FormatGoogleAddress400Example": {
"summary": "Default FormatGoogleAddress 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": {
"FormatGoogleAddress401Example": {
"summary": "Default FormatGoogleAddress 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": {
"FormatGoogleAddress403Example": {
"summary": "Default FormatGoogleAddress 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": {
"FormatGoogleAddress500Example": {
"summary": "Default FormatGoogleAddress 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 Format Google Address",
"description": "Format Google Address via the Flipdish Open API v1.0 (POST /api/v1.0/address/google).",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/api/v1.0/stores/{storeId}/deliveryzones": {
"get": {
"tags": [
"DeliveryZone"
],
"operationId": "GetDeliveryZones",
"parameters": [
{
"name": "storeId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"description": "The store id path parameter.",
"example": 500123
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RestApiArrayResult_DeliveryZone_"
},
"examples": {
"GetDeliveryZones200Example": {
"summary": "Default GetDeliveryZones 200 response",
"x-microcks-default": true,
"value": {
"Data": []
}
}
}
}
}
},
"400": {
"description": "BadRequest",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlipdishError"
},
"examples": {
"GetDeliveryZones400Example": {
"summary": "Default GetDeliveryZones 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": {
"GetDeliveryZones401Example": {
"summary": "Default GetDeliveryZones 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": {
"GetDeliveryZones403Example": {
"summary": "Default GetDeliveryZones 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": {
"GetDeliveryZones404Example": {
"summary": "Default GetDeliveryZones 404 response",
"x-microcks-default": true,
"value": {
"error": {
"errorMessage": "Invalid or m
# --- truncated at 32 KB (544 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-stores-openapi.json