Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/flipdish-orders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Flipdish API - Apps Accounts Orders 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: Orders
description: Operations for Orders.
paths:
/api/v1.0/orders/{id}:
get:
tags:
- Orders
operationId: GetOrderById
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
description: The id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_Order_'
examples:
GetOrderById200Example:
summary: Default GetOrderById 200 response
x-microcks-default: true
value:
Data:
Store:
Id: 500123
Name: Example Name
MenuId: 500123
MenuPublishId: 00000000-0000-0000-0000-000000000000
Metadata: {}
Currency: EUR
Coordinates: {}
StoreTimezone: string
StoreIanaTimezone: string
StoreGroupId: 500123
TaxId: '500123'
PrettyAddress: string
CountryCode: IE
PropertyId: '500123'
Customer:
Id: 500123
Name: Example Name
EmailAddress: owner@example.com
PhoneNumberLocalFormat: '2026-06-02T12:00:00Z'
PhoneNumber: '+353000000000'
LanguagePreference: string
Voucher:
VoucherId: 500123
Name: Example Name
Description: string
Code: string
Amount: 12.5
Type: PercentageDiscount
SubType: None
Fees:
FeeAmount: 12.5
PercentageRate: 1.0
PerTransactionFee: 12.5
OrderItems: []
DeliveryLocation:
Coordinates: {}
Building: string
Street: string
Town: string
PostCode: string
DeliveryInstructions: string
PrettyAddressString: string
CustomerLocation:
Latitude: 1.0
Longitude: 1.0
MaskedPhoneNumber:
IsEnabled: true
PhoneNumber: '+353000000000'
Code: string
DropOffLocationId: 500123
DropOffLocation: string
AcceptedFor: '2026-06-02T12:00:00Z'
InFraudZone: true
UnusualHighValueOrder: true
RejectedByUserId: 500123
ChannelOrderId: '500123'
ChannelOrderDisplayId: '500123'
Channel:
ChannelId: 500123
TranslationKey: string
Source: Internal
LogoUri: https://api.flipdish.co/example
Available: true
MaintainedExternally: true
OrderDropOffLocation:
OrderId: 500123
LocationName: Example Name
LocationAreaName: Example Name
LocationId: 500123
LocationAreaId: 500123
ExternalLocationId: '500123'
FulfillmentStatus:
StatusId: '500123'
StatusName: Example Name
Icon: string
OrderBatchInfo:
Id: 500123
DisplayCode: string
CreateTime: '2026-06-02T12:00:00Z'
IsPublished: true
TaxItems: []
CreatedCampaignVoucherId: 500123
OrderId: 500123
LocalOrderId: '500123'
DeliveryType: Delivery
PickupLocationType: TakeOut
TableServiceCatagory: Generic
TipAmount: 12.5
DeliveryAmount: 12.5
OrderItemsAmount: 12.5
ServiceChargeAmount: 12.5
ServiceChargePercentage: 1.0
Amount: 12.5
ProcessingFee: 12.5
PaymentAccountType: Card
PaymentAccountDescription: string
OrderState: Created
IsPreOrder: true
PlacedTime: '2026-06-02T12:00:00Z'
RequestedForTime: '2026-06-02T12:00:00Z'
ChefNote: string
AppType: Unknown
UserRating: 1
PaymentStatus: Paid
RejectionReason: TooBusy
RefundedAmount: 12.5
DeliveryTrackingStatus: Unassigned
DriverId: 500123
TotalTax: 12.5
OrderTrackingCode: string
DeliveryFeeAreaId: 500123
ReceiptCode: string
TotalDepositReturnFeeAmount: 12.5
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetOrderById400Example:
summary: Default GetOrderById 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:
GetOrderById401Example:
summary: Default GetOrderById 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:
GetOrderById403Example:
summary: Default GetOrderById 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:
GetOrderById500Example:
summary: Default GetOrderById 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 Order by Id
description: Get Order by Id via the Flipdish Open API v1.0 (GET /api/v1.0/orders/{id}).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/orders/{orderId}/deliveryinfo:
get:
tags:
- Orders
operationId: GetDeliveryInformation
parameters:
- name: orderId
in: path
required: true
schema:
type: integer
format: int32
description: The order id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_OrderDeliveryInformation_'
examples:
GetDeliveryInformation200Example:
summary: Default GetDeliveryInformation 200 response
x-microcks-default: true
value:
Data:
OrderId: 500123
ExternalReferenceId: '500123'
TrackUrl: https://api.flipdish.co/example
Status: None
DeliveryStatusNotes: Active
ErrorMessage: string
IntegrationCode: string
IntegrationName: Example Name
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetDeliveryInformation400Example:
summary: Default GetDeliveryInformation 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:
GetDeliveryInformation401Example:
summary: Default GetDeliveryInformation 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:
GetDeliveryInformation403Example:
summary: Default GetDeliveryInformation 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: Either the order was not found or there is no delivery information associated to it.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetDeliveryInformation404Example:
summary: Default GetDeliveryInformation 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:
GetDeliveryInformation500Example:
summary: Default GetDeliveryInformation 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 Delivery Information
description: Get Delivery Information via the Flipdish Open API v1.0 (GET /api/v1.0/orders/{orderId}/deliveryinfo).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Orders
operationId: UpdateDeliveryInformation
parameters:
- name: orderId
in: path
required: true
schema:
type: integer
format: int32
description: The order id path parameter.
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrderDeliveryInformationBase'
examples:
UpdateDeliveryInformationRequestExample:
summary: Default UpdateDeliveryInformation request
x-microcks-default: true
value:
ExternalReferenceId: '500123'
TrackUrl: https://api.flipdish.co/example
Status: None
DeliveryStatusNotes: Active
ErrorMessage: string
IntegrationCode: string
IntegrationName: Example Name
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateDeliveryInformation400Example:
summary: Default UpdateDeliveryInformation 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:
UpdateDeliveryInformation401Example:
summary: Default UpdateDeliveryInformation 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:
UpdateDeliveryInformation403Example:
summary: Default UpdateDeliveryInformation 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:
UpdateDeliveryInformation500Example:
summary: Default UpdateDeliveryInformation 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 Delivery Information
description: Update Delivery Information via the Flipdish Open API v1.0 (POST /api/v1.0/orders/{orderId}/deliveryinfo).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/orders/{orderId}/fulfillment/state:
get:
tags:
- Orders
operationId: GetFulfillmentState
parameters:
- name: orderId
in: path
required: true
schema:
type: integer
format: int32
description: The order id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_OrderFulfillmentStatus_'
examples:
GetFulfillmentState200Example:
summary: Default GetFulfillmentState 200 response
x-microcks-default: true
value:
Data:
OrderId: 500123
StatusId: '500123'
StatusName: Example Name
Icon: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetFulfillmentState400Example:
summary: Default GetFulfillmentState 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:
GetFulfillmentState401Example:
summary: Default GetFulfillmentState 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:
GetFulfillmentState403Example:
summary: Default GetFulfillmentState 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: Either the order was not found or there is no fulfillment status information associated to it.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetFulfillmentState404Example:
summary: Default GetFulfillmentState 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:
GetFulfillmentState500Example:
summary: Default GetFulfillmentState 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 State
description: Get Fulfillment State via the Flipdish Open API v1.0 (GET /api/v1.0/orders/{orderId}/fulfillment/state).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Orders
operationId: UpdateFulfillmentState
parameters:
- name: orderId
in: path
required: true
schema:
type: integer
format: int32
description: The order id path parameter.
example: 500123
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OrderFulfillmentStatusUpdate'
examples:
UpdateFulfillmentStateRequestExample:
summary: Default UpdateFulfillmentState request
x-microcks-default: true
value:
StatusId: '500123'
responses:
'200':
description: OK
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
UpdateFulfillmentState400Example:
summary: Default UpdateFulfillmentState 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:
UpdateFulfillmentState401Example:
summary: Default UpdateFulfillmentState 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:
UpdateFulfillmentState403Example:
summary: Default UpdateFulfillmentState 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:
UpdateFulfillmentState500Example:
summary: Default UpdateFulfillmentState 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 Fulfillment State
description: Update Fulfillment State via the Flipdish Open API v1.0 (POST /api/v1.0/orders/{orderId}/fulfillment/state).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/orders/{orderId}/fulfillment/state/details:
get:
tags:
- Orders
operationId: GetFulfillmentStatusWithDetailsAndActions
parameters:
- name: orderId
in: path
required: true
schema:
type: integer
format: int32
description: The order id path parameter.
example: 500123
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiResult_OrderFulfillmentStatusWithConfigurationActions_'
examples:
GetFulfillmentStatusWithDetailsAndActions200Example:
summary: Default GetFulfillmentStatusWithDetailsAndActions 200 response
x-microcks-default: true
value:
Data:
DefaultNextStatus: Active
NextStatuses: []
OrderId: 500123
StatusId: '500123'
StatusName: Example Name
Icon: string
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetFulfillmentStatusWithDetailsAndActions400Example:
summary: Default GetFulfillmentStatusWithDetailsAndActions 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:
GetFulfillmentStatusWithDetailsAndActions401Example:
summary: Default GetFulfillmentStatusWithDetailsAndActions 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:
GetFulfillmentStatusWithDetailsAndActions403Example:
summary: Default GetFulfillmentStatusWithDetailsAndActions 403 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
details: Validation failed for field 'storeId'.
'404':
description: Either the order was not found or there is no fulfillment status information associated to it.
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
GetFulfillmentStatusWithDetailsAndActions404Example:
summary: Default GetFulfillmentStatusWithDetailsAndActions 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:
GetFulfillmentStatusWithDetailsAndActions500Example:
summary: Default GetFulfillmentStatusWithDetailsAndActions 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 Status with Details and Actions
description: Get Fulfillment Status with Details and Actions via the Flipdish Open API v1.0 (GET /api/v1.0/orders/{orderId}/fulfillment/state/details).
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v1.0/{appId}/orders/fulfillmentstatuses:
get:
tags:
- Orders
operationId: SearchFulfillmentStatuses
parameters:
- name: appId
in: path
required: true
schema:
type: string
description: The app id path parameter.
example: '500123'
- name: orderIds
in: query
required: true
schema:
type: string
description: The order ids query parameter.
example: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RestApiArrayResult_OrderFulfillmentStatus_'
examples:
SearchFulfillmentStatuses200Example:
summary: Default SearchFulfillmentStatuses 200 response
x-microcks-default: true
value:
Data: []
'400':
description: BadRequest
content:
application/json:
schema:
$ref: '#/components/schemas/FlipdishError'
examples:
SearchFulfillmentStatuses400Example:
summary: Default SearchFulfillmentStatuses 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:
SearchFulfillmentStatuses401Example:
summary: Default SearchFulfillmentStatuses 401 response
x-microcks-default: true
value:
error:
errorMessage: Invalid or missing parameters.
errorCode: BadRequest
d
# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/openapi/flipdish-orders-api-openapi.yml