OpenAPI Specification
openapi: 3.0.3
info:
title: Flipdish API - Apps Accounts Vouchers 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: Vouchers
description: Operations for Vouchers.
paths:
/api/v1.0/vouchers/{voucherId}:
get:
tags:
- Vouchers
operationId: GetVoucherById
parameters:
- name: voucherId
in: path
required: true
schema:
type: integer
format: int32
description: The voucher id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_VoucherWithStats_'
examples:
GetVoucherById200Example:
summary: Default GetVoucherById 200 response
x-microcks-default: true
value:
Data:
TotalUsed: 12.5
TotalCustomers: 12.5
TotalAmountFromOrders: 12.5
TotalDiscounted: 12.5
AverageOrderSize: 1.0
VoucherId: 500123
Status: Valid
VoucherType: PercentageDiscount
Currency: EUR
StoreNames:
- Example Name
PromotionDetails:
PromotionId: 500123
Name: Example Name
PromotionAwards: []
CreditNoteDetails:
RemainingCredit: 1.0
LumpDiscountDetails:
DiscountAmount: 12.5
PercentDiscountDetails:
PercentageDiscount: 3
MaxDiscountAmount: 12.5
Code: string
Description: string
Stores:
- 1
ValidOnOrdersOver: 1.0
TakesPriority: true
IsEnabled: true
IsAutomaticallyApplied: true
IncludeDeliveryFee: true
IsValidForDeliveryOrders: true
IsValidForPickupOrders: true
IsValidForOrdersPayedOnline: true
IsValidForOrdersPayedByCash: true
IsValidForFirstOrderOnly: true
IsValidOncePerCustomer: true
IsValidOnlyOnce: true
IsDiscoverable: true
ForceDiscount: true
StartDate: '2026-06-02T12:00:00Z'
ExpiryDate: '2026-06-02T12:00:00Z'
ChannelRestrictions:
- Ios
ValidityPeriods: []
VoucherSubType: None
CustomerId: 500123
MaxRedemptions: 1
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetVoucherById400Example:
summary: Default GetVoucherById 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:
GetVoucherById401Example:
summary: Default GetVoucherById 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:
GetVoucherById403Example:
summary: Default GetVoucherById 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:
GetVoucherById404Example:
summary: Default GetVoucherById 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:
GetVoucherById500Example:
summary: Default GetVoucherById 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 Voucher by Id
description: Get Voucher by Id via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/{voucherId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Vouchers
operationId: UpdateVoucher
parameters:
- name: voucherId
in: path
required: true
schema:
type: integer
format: int32
description: The voucher id path parameter.
example: 500123
- name: storeId
in: query
required: false
explode: true
schema:
type: array
items:
type: integer
format: int32
description: The store id query parameter.
example:
- 500123
- name: percentValue
in: query
required: false
schema:
type: integer
format: int32
description: The percent value query parameter.
example: 1
- name: lumpValue
in: query
required: false
schema:
type: number
format: double
description: The lump value query parameter.
example: 1.0
- name: maxDiscountAmount
in: query
required: false
schema:
type: number
format: double
description: The max discount amount query parameter.
example: 12.5
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateVoucher'
examples:
UpdateVoucherRequestExample:
summary: Default UpdateVoucher request
x-microcks-default: true
value:
PromotionId: 500123
PromotionName: Example Name
PromotionAwardMenuItemPublicIds:
- 00000000-0000-0000-0000-000000000000
Code: string
Description: string
Stores:
- 1
ValidOnOrdersOver: 1.0
TakesPriority: true
IsEnabled: true
IsAutomaticallyApplied: true
IncludeDeliveryFee: true
IsValidForDeliveryOrders: true
IsValidForPickupOrders: true
IsValidForOrdersPayedOnline: true
IsValidForOrdersPayedByCash: true
IsValidForFirstOrderOnly: true
IsValidOncePerCustomer: true
IsValidOnlyOnce: true
IsDiscoverable: true
ForceDiscount: true
StartDate: '2026-06-02T12:00:00Z'
ExpiryDate: '2026-06-02T12:00:00Z'
ChannelRestrictions:
- Ios
ValidityPeriods: []
VoucherSubType: None
CustomerId: 500123
MaxRedemptions: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_VoucherWithStats_'
examples:
UpdateVoucher200Example:
summary: Default UpdateVoucher 200 response
x-microcks-default: true
value:
Data:
TotalUsed: 12.5
TotalCustomers: 12.5
TotalAmountFromOrders: 12.5
TotalDiscounted: 12.5
AverageOrderSize: 1.0
VoucherId: 500123
Status: Valid
VoucherType: PercentageDiscount
Currency: EUR
StoreNames:
- Example Name
PromotionDetails:
PromotionId: 500123
Name: Example Name
PromotionAwards: []
CreditNoteDetails:
RemainingCredit: 1.0
LumpDiscountDetails:
DiscountAmount: 12.5
PercentDiscountDetails:
PercentageDiscount: 3
MaxDiscountAmount: 12.5
Code: string
Description: string
Stores:
- 1
ValidOnOrdersOver: 1.0
TakesPriority: true
IsEnabled: true
IsAutomaticallyApplied: true
IncludeDeliveryFee: true
IsValidForDeliveryOrders: true
IsValidForPickupOrders: true
IsValidForOrdersPayedOnline: true
IsValidForOrdersPayedByCash: true
IsValidForFirstOrderOnly: true
IsValidOncePerCustomer: true
IsValidOnlyOnce: true
IsDiscoverable: true
ForceDiscount: true
StartDate: '2026-06-02T12:00:00Z'
ExpiryDate: '2026-06-02T12:00:00Z'
ChannelRestrictions:
- Ios
ValidityPeriods: []
VoucherSubType: None
CustomerId: 500123
MaxRedemptions: 1
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateVoucher400Example:
summary: Default UpdateVoucher 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:
UpdateVoucher401Example:
summary: Default UpdateVoucher 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:
UpdateVoucher403Example:
summary: Default UpdateVoucher 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:
UpdateVoucher404Example:
summary: Default UpdateVoucher 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:
UpdateVoucher500Example:
summary: Default UpdateVoucher 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 Update Voucher
description: Update Voucher via the Flipdish Open API v1.0 (POST /api/v1.0/vouchers/{voucherId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/vouchers/code/{code}:
get:
tags:
- Vouchers
operationId: GetVoucherByCode
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: code
in: path
required: true
schema:
type: string
description: The code path parameter.
example: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_Voucher_'
examples:
GetVoucherByCode200Example:
summary: Default GetVoucherByCode 200 response
x-microcks-default: true
value:
Data:
VoucherId: 500123
Status: Valid
VoucherType: PercentageDiscount
Currency: EUR
StoreNames:
- Example Name
PromotionDetails:
PromotionId: 500123
Name: Example Name
PromotionAwards: []
CreditNoteDetails:
RemainingCredit: 1.0
LumpDiscountDetails:
DiscountAmount: 12.5
PercentDiscountDetails:
PercentageDiscount: 3
MaxDiscountAmount: 12.5
Code: string
Description: string
Stores:
- 1
ValidOnOrdersOver: 1.0
TakesPriority: true
IsEnabled: true
IsAutomaticallyApplied: true
IncludeDeliveryFee: true
IsValidForDeliveryOrders: true
IsValidForPickupOrders: true
IsValidForOrdersPayedOnline: true
IsValidForOrdersPayedByCash: true
IsValidForFirstOrderOnly: true
IsValidOncePerCustomer: true
IsValidOnlyOnce: true
IsDiscoverable: true
ForceDiscount: true
StartDate: '2026-06-02T12:00:00Z'
ExpiryDate: '2026-06-02T12:00:00Z'
ChannelRestrictions:
- Ios
ValidityPeriods: []
VoucherSubType: None
CustomerId: 500123
MaxRedemptions: 1
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetVoucherByCode400Example:
summary: Default GetVoucherByCode 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:
GetVoucherByCode401Example:
summary: Default GetVoucherByCode 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:
GetVoucherByCode403Example:
summary: Default GetVoucherByCode 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:
GetVoucherByCode404Example:
summary: Default GetVoucherByCode 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:
GetVoucherByCode500Example:
summary: Default GetVoucherByCode 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 Voucher by Code
description: Get Voucher by Code via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/code/{code}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/vouchers/{appId}/customer/{customerId}:
get:
tags:
- Vouchers
operationId: GetVouchersByCustomerForApp
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: customerId
in: path
required: true
schema:
type: integer
format: int32
description: The customer id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_VoucherSummary_'
examples:
GetVouchersByCustomerForApp200Example:
summary: Default GetVouchersByCustomerForApp 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetVouchersByCustomerForApp400Example:
summary: Default GetVouchersByCustomerForApp 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:
GetVouchersByCustomerForApp401Example:
summary: Default GetVouchersByCustomerForApp 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:
GetVouchersByCustomerForApp403Example:
summary: Default GetVouchersByCustomerForApp 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:
GetVouchersByCustomerForApp404Example:
summary: Default GetVouchersByCustomerForApp 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:
GetVouchersByCustomerForApp500Example:
summary: Default GetVouchersByCustomerForApp 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 Vouchers by Customer for App
description: Get Vouchers by Customer for App via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/{appId}/customer/{customerId}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/vouchers/{voucherId}/validity-periods:
get:
tags:
- Vouchers
operationId: GetVoucherValidityPeriods
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: voucherId
in: path
required: true
schema:
type: integer
format: int32
description: The voucher id path parameter.
example: 500123
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetVoucherValidityPeriods400Example:
summary: Default GetVoucherValidityPeriods 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:
GetVoucherValidityPeriods401Example:
summary: Default GetVoucherValidityPeriods 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:
GetVoucherValidityPeriods403Example:
summary: Default GetVoucherValidityPeriods 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:
GetVoucherValidityPeriods404Example:
summary: Default GetVoucherValidityPeriods 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:
GetVoucherValidityPeriods500Example:
summary: Default GetVoucherValidityPeriods 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 Voucher Validity Periods
description: Get Voucher Validity Periods via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/{voucherId}/validity-periods).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/vouchers/stats/{voucherId}:
get:
tags:
- Vouchers
operationId: GetVoucherStatsById
parameters:
- name: voucherId
in: path
required: true
schema:
type: integer
format: int32
description: The voucher id path parameter.
example: 500123
- name: aggregateDataBy
in: query
required: true
schema:
type: string
enum:
- Daily
- Weekly
- Monthly
description: The aggregate data by query parameter.
example: Daily
- name: dataPointLimit
in: query
required: false
schema:
type: integer
format: int32
description: The data point limit query parameter.
example: 1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_VoucherDataPoint_'
examples:
GetVoucherStatsById200Example:
summary: Default GetVoucherStatsById 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetVoucherStatsById400Example:
summary: Default GetVoucherStatsById 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:
GetVoucherStatsById401Example:
summary: Default GetVoucherStatsById 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:
GetVoucherStatsById403Example:
summary: Default GetVoucherStatsById
# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-vouchers-api-openapi.yml