OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts Clients 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: Clients
description: Operations for Clients.
paths:
/api/v1.0/clients/{clientId}:
get:
tags:
- Clients
operationId: GetClient
parameters:
- name: clientId
in: path
required: true
schema:
type: integer
format: int32
description: The client id path parameter.
example: 500123
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetClient400Example:
summary: Default GetClient 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetClient401Example:
summary: Default GetClient 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:
GetClient403Example:
summary: Default GetClient 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:
GetClient404Example:
summary: Default GetClient 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetClient500Example:
summary: Default GetClient 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 Client
description: Get Client via the Flipdish Open API v1.0 (GET /api/v1.0/clients/{clientId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/clients/{clientId}/stripecustomerid:
post:
tags:
- Clients
operationId: SetStripeCustomerId
parameters:
- name: clientId
in: path
required: true
schema:
type: integer
format: int32
description: The client id path parameter.
example: 500123
requestBody:
required: false
content: {}
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStripeCustomerId400Example:
summary: Default SetStripeCustomerId 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStripeCustomerId401Example:
summary: Default SetStripeCustomerId 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:
SetStripeCustomerId403Example:
summary: Default SetStripeCustomerId 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:
SetStripeCustomerId404Example:
summary: Default SetStripeCustomerId 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetStripeCustomerId500Example:
summary: Default SetStripeCustomerId 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 Set Stripe Customer Id
description: Set Stripe Customer Id via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{clientId}/stripecustomerid).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/clients/{clientId}/salesforcecontactid:
post:
tags:
- Clients
operationId: SetSalesForceContactId
parameters:
- name: clientId
in: path
required: true
schema:
type: integer
format: int32
description: The client id path parameter.
example: 500123
requestBody:
required: false
content: {}
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetSalesForceContactId400Example:
summary: Default SetSalesForceContactId 400 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetSalesForceContactId401Example:
summary: Default SetSalesForceContactId 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:
SetSalesForceContactId403Example:
summary: Default SetSalesForceContactId 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:
SetSalesForceContactId404Example:
summary: Default SetSalesForceContactId 404 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'500':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SetSalesForceContactId500Example:
summary: Default SetSalesForceContactId 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 Set Sales Force Contact Id
description: Set Sales Force Contact Id via the Flipdish Open API v1.0 (POST /api/v1.0/clients/{clientId}/salesforcecontactid).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
FlipdishError:
type: object
description: Standard Flipdish API error response. Errors are returned as a JSON object with a human-readable message and a programmatic error code (see https://developers.flipdish.com/docs/error-handling).
properties:
error:
type: object
description: Error detail object.
properties:
errorMessage:
type: string
description: Descriptive explanation of the issue.
example: Invalid or missing parameters.
errorCode:
type: string
description: Unique identifier for programmatic error handling.
example: BadRequest
details:
type: string
description: Additional context returned in non-production environments.
example: Validation failed for field 'storeId'.
securitySchemes:
oauth2:
type: oauth2
description: OAuth 2.0. Implicit grant for first-party portal apps; client credentials grant for server-to-server App Store apps (exchange Client ID + Secret Key for a bearer access token).
flows:
implicit:
authorizationUrl: https://api.flipdish.co/identity/connect/authorize
scopes:
api: Access to the Flipdish API
clientCredentials:
tokenUrl: https://api.flipdish.co/identity/connect/token
scopes:
api: Access to the Flipdish API