OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts Drivers API
version: v1.0
description: Flipdish Open API v1.0 — Apps 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: help@flipdish.com
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: Drivers
description: Operations for Drivers.
paths:
/api/v1.0/drivers/profile:
get:
tags:
- Drivers
operationId: Drivers_GetDriverProfile
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_GetDriverProfile200Example:
summary: Default Drivers_GetDriverProfile 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_GetDriverProfile400Example:
summary: Default Drivers_GetDriverProfile 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:
Drivers_GetDriverProfile401Example:
summary: Default Drivers_GetDriverProfile 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:
Drivers_GetDriverProfile403Example:
summary: Default Drivers_GetDriverProfile 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_GetDriverProfile500Example:
summary: Default Drivers_GetDriverProfile 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 Drivers_Get Driver Profile
description: Drivers_Get Driver Profile via the Flipdish Open API v1.0 (GET /api/v1.0/drivers/profile).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Drivers
operationId: Drivers_UpdateDriverProfile
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDriverProfileModel'
examples:
Drivers_UpdateDriverProfileRequestExample:
summary: Default Drivers_UpdateDriverProfile request
x-microcks-default: true
value:
Name: Example Name
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_UpdateDriverProfile200Example:
summary: Default Drivers_UpdateDriverProfile 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_UpdateDriverProfile400Example:
summary: Default Drivers_UpdateDriverProfile 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:
Drivers_UpdateDriverProfile401Example:
summary: Default Drivers_UpdateDriverProfile 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:
Drivers_UpdateDriverProfile403Example:
summary: Default Drivers_UpdateDriverProfile 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:
Drivers_UpdateDriverProfile500Example:
summary: Default Drivers_UpdateDriverProfile 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 Drivers_Update Driver Profile
description: Drivers_Update Driver Profile via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/profile).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/drivers/assignedstores:
get:
tags:
- Drivers
operationId: Drivers_GetStoresForDriver
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_GetStoresForDriver200Example:
summary: Default Drivers_GetStoresForDriver 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_GetStoresForDriver400Example:
summary: Default Drivers_GetStoresForDriver 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:
Drivers_GetStoresForDriver401Example:
summary: Default Drivers_GetStoresForDriver 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:
Drivers_GetStoresForDriver403Example:
summary: Default Drivers_GetStoresForDriver 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_GetStoresForDriver500Example:
summary: Default Drivers_GetStoresForDriver 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 Drivers_Get Stores for Driver
description: Drivers_Get Stores for Driver via the Flipdish Open API v1.0 (GET /api/v1.0/drivers/assignedstores).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/drivers/pin:
post:
tags:
- Drivers
operationId: Drivers_DriverRequestLoginCodeSms
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DriverRequestLoginPinModel'
examples:
Drivers_DriverRequestLoginCodeSmsRequestExample:
summary: Default Drivers_DriverRequestLoginCodeSms request
x-microcks-default: true
value:
PhoneNumber: '+353000000000'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_DriverRequestLoginCodeSms200Example:
summary: Default Drivers_DriverRequestLoginCodeSms 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_DriverRequestLoginCodeSms400Example:
summary: Default Drivers_DriverRequestLoginCodeSms 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:
Drivers_DriverRequestLoginCodeSms401Example:
summary: Default Drivers_DriverRequestLoginCodeSms 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:
Drivers_DriverRequestLoginCodeSms403Example:
summary: Default Drivers_DriverRequestLoginCodeSms 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_DriverRequestLoginCodeSms500Example:
summary: Default Drivers_DriverRequestLoginCodeSms 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 Drivers_Driver Request Login Code Sms
description: Drivers_Driver Request Login Code Sms via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/pin).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/drivers/login:
post:
tags:
- Drivers
operationId: Drivers_DriverLogin
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DriverLoginModel'
examples:
Drivers_DriverLoginRequestExample:
summary: Default Drivers_DriverLogin request
x-microcks-default: true
value:
PhoneNumber: '+353000000000'
Code: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_DriverLogin200Example:
summary: Default Drivers_DriverLogin 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_DriverLogin400Example:
summary: Default Drivers_DriverLogin 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:
Drivers_DriverLogin401Example:
summary: Default Drivers_DriverLogin 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:
Drivers_DriverLogin403Example:
summary: Default Drivers_DriverLogin 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_DriverLogin500Example:
summary: Default Drivers_DriverLogin 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 Drivers_Driver Login
description: Drivers_Driver Login via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/login).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/drivers/token:
post:
tags:
- Drivers
operationId: Drivers_AddDriverNotificationToken
requestBody:
required: false
content: {}
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_AddDriverNotificationToken200Example:
summary: Default Drivers_AddDriverNotificationToken 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_AddDriverNotificationToken400Example:
summary: Default Drivers_AddDriverNotificationToken 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:
Drivers_AddDriverNotificationToken401Example:
summary: Default Drivers_AddDriverNotificationToken 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:
Drivers_AddDriverNotificationToken403Example:
summary: Default Drivers_AddDriverNotificationToken 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_AddDriverNotificationToken500Example:
summary: Default Drivers_AddDriverNotificationToken 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 Drivers_Add Driver Notification Token
description: Drivers_Add Driver Notification Token via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/token).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Drivers
operationId: Drivers_RemoveDriverNotificationToken
requestBody:
required: false
content: {}
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_RemoveDriverNotificationToken200Example:
summary: Default Drivers_RemoveDriverNotificationToken 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_RemoveDriverNotificationToken400Example:
summary: Default Drivers_RemoveDriverNotificationToken 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:
Drivers_RemoveDriverNotificationToken401Example:
summary: Default Drivers_RemoveDriverNotificationToken 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:
Drivers_RemoveDriverNotificationToken403Example:
summary: Default Drivers_RemoveDriverNotificationToken 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_RemoveDriverNotificationToken500Example:
summary: Default Drivers_RemoveDriverNotificationToken 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 Drivers_Remove Driver Notification Token
description: Drivers_Remove Driver Notification Token via the Flipdish Open API v1.0 (DELETE /api/v1.0/drivers/token).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/drivers/profile/image:
post:
tags:
- Drivers
operationId: Drivers_SetDriverProfileImage
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_SetDriverProfileImage200Example:
summary: Default Drivers_SetDriverProfileImage 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_SetDriverProfileImage400Example:
summary: Default Drivers_SetDriverProfileImage 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:
Drivers_SetDriverProfileImage401Example:
summary: Default Drivers_SetDriverProfileImage 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:
Drivers_SetDriverProfileImage403Example:
summary: Default Drivers_SetDriverProfileImage 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_SetDriverProfileImage500Example:
summary: Default Drivers_SetDriverProfileImage 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 Drivers_Set Driver Profile Image
description: Drivers_Set Driver Profile Image via the Flipdish Open API v1.0 (POST /api/v1.0/drivers/profile/image).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Drivers
operationId: Drivers_DeleteDriverProfileImage
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Drivers_DeleteDriverProfileImage200Example:
summary: Default Drivers_DeleteDriverProfileImage 200 response
x-microcks-default: true
value: {}
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_DeleteDriverProfileImage400Example:
summary: Default Drivers_DeleteDriverProfileImage 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:
Drivers_DeleteDriverProfileImage401Example:
summary: Default Drivers_DeleteDriverProfileImage 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:
Drivers_DeleteDriverProfileImage403Example:
summary: Default Drivers_DeleteDriverProfileImage 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'410':
description: Gone
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
Drivers_DeleteDriverProfileImage500Example:
summary: Default Drivers_DeleteDriverProfileImage 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 Drivers_Delete Driver Profile Image
description: Drivers_Delete Driver Profile Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/drivers/profile/image).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-drivers-api-openapi.yml