Flipdish

The Flipdish Developer Hub

Welcome to the Flipdish developer hub. You'll find comprehensive guides and documentation to help you start working with Flipdish as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
 
Suggest Edits

Gets the current account detail

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/accounts
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/accounts
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/accounts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/accounts");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{}
An error has occured

Response

OK

Dataobject

Generic data object.

Data.Namestring

Name

Data.Emailstring

Email

Data.Languagestring

Language Id

Data.SignupStepsarray

Signup steps

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Update account with name and language

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
puthttps://api.flipdish.co/api/v1.0/accounts
curl --request PUT \
  --url https://api.flipdish.co/api/v1.0/accounts
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.flipdish.co/api/v1.0/accounts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts");
var request = new RestRequest(Method.PUT);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.flipdish.co/api/v1.0/accounts");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts"

response = requests.request("PUT", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

An error has occured

Body Params

Name
string

Name of the user

Language
string

Language of the user

Response

OK

NoContent

BadRequest

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Create account with email address and store name

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/accounts
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/accounts
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/accounts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/accounts");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

An error has occured

Body Params

Email
string
required

Email addres

StoreName
string
required

Store name

Response

OK

NoContent

BadRequest

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Request password reset. Flipdish system will send a token via email.

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/accounts/password
curl --request GET \
  --url 'https://api.flipdish.co/api/v1.0/accounts/password?email=email'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/accounts/password',
  qs: { email: 'email' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/password?email=email");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/password?email=email")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/accounts/password?email=email");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/password"

querystring = {"email":"email"}

response = requests.request("GET", url, params=querystring)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/password?email=email")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

An error has occured

Query Params

email
string
required

Email address

Response

OK

BadRequest

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Change password

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
puthttps://api.flipdish.co/api/v1.0/accounts/password
curl --request PUT \
  --url https://api.flipdish.co/api/v1.0/accounts/password
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.flipdish.co/api/v1.0/accounts/password' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/password");
var request = new RestRequest(Method.PUT);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/password")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.flipdish.co/api/v1.0/accounts/password");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/password"

response = requests.request("PUT", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/password")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

An error has occured

Body Params

OldPassword
string
required

Old password

NewPassword
string
required

New password

PasswordConfirmation
string
required

Password confirmation

Response

OK

NoContent

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Conflict

Suggest Edits

Reset password with token.

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/accounts/password
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/accounts/password
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/accounts/password' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/password");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/password")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/accounts/password");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/password"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/password")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

An error has occured

Body Params

Email
string

Email address

Password
string
required

Password

PasswordConfirmation
string
required

Password confirmation

Token
string

Password reset token

Response

OK

NoContent

BadRequest

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Login with username and password

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/accounts/login
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/accounts/login
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/accounts/login' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/login");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/accounts/login");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/login"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/login")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

An error has occured

Body Params

Email
string
required

Email addres

Password
string
required

Password

Response

OK

NoContent

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Log out. It removes Flipdish authorization Cookie.

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/accounts/logout
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/accounts/logout
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/accounts/logout' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/logout");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/logout")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/accounts/logout");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/logout"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/logout")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

An error has occured

Response

OK

NoContent

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

/api/v1.0/accounts/signupstep/{signupStepAction}/skip

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/skip")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

signupStepAction
string
required

Signup step action

Response

OK

NoContent

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

/api/v1.0/accounts/signupstep/{signupStepAction}/answer

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

signupStepAction
string
required

Signup step action

Response

OK

NoContent

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Answer a signup question

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/accounts/signupstep/signupStepAction/answer")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

signupStepAction
string
required

Signup step action

Response

OK

NoContent

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/apps
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/apps
var request = require("request");

var options = { method: 'GET', url: 'https://api.flipdish.co/api/v1.0/apps' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/apps");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/apps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/apps");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/apps"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/apps")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

[
  {
    "MapCenter": {
      "Latitude": 0,
      "Longitude": 0
    },
    "MapNorthEast": {
      "Latitude": 0,
      "Longitude": 0
    },
    "MapSouthWest": {
      "Latitude": 0,
      "Longitude": 0
    }
  }
]

Query Params

nameFilter
string
page
int32
limit
int32

Response

OK

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

Dataarray

Generic data object.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

AuthorizationTokens

 
Suggest Edits

Get authorization tokens

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/authorizationtokens/clientId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/authorizationtokens/clientId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/authorizationtokens/clientId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/authorizationtokens/clientId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/authorizationtokens/clientId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/authorizationtokens/clientId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/authorizationtokens/clientId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/authorizationtokens/clientId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

[
  {
    "Key": "pJebldHbNHl5oIiGsmEumQB-uSMBJTCUcJTeDpghH-4",
    "TokenType": "TokenHandle",
    "SubjectId": "12345",
    "ClientId": "6364835052359684607444",
    "Expiry": "0001-01-01T00:00:00+00:00"
  }
]
Authentication has been denied for this request.
Successful authentication, but authorization has been denied for this request.
An error has occured

Path Params

clientId
string
required

Client identifier

Query Params

page
int32

Requested page number

limit
int32

Requested page limit

Response

OK

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

Dataarray

Generic data object.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Unauthorized

Messagestring

Message

Forbidden

Messagestring

Message

NotFound

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Suggest Edits

Revoke token

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
deletehttps://api.flipdish.co/api/v1.0/authorizationtokens/key
curl --request DELETE \
  --url https://api.flipdish.co/api/v1.0/authorizationtokens/key
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.flipdish.co/api/v1.0/authorizationtokens/key' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/authorizationtokens/key");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/authorizationtokens/key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.flipdish.co/api/v1.0/authorizationtokens/key");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/authorizationtokens/key"

response = requests.request("DELETE", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/authorizationtokens/key")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Authentication has been denied for this request.
Successful authentication, but authorization has been denied for this request.
An error has occured

Path Params

key
string
required

Token identifier key

Response

OK

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Unauthorized

Messagestring

Message

Forbidden

Messagestring

Message

NotFound

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Suggest Edits

DeliveryZone

 
Suggest Edits

Get all the delivery zones associated with a store

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

[
  {
    "Id": 1337,
    "DeliveryFee": 0,
    "MinimumDeliveryOrderAmount": 0,
    "WellKnownText": "POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))"
  }
]

Path Params

storeId
int32
required

Store Id to which the delivery zones are associated

Response

OK

Dataarray

Generic data object.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Adds a delivery zone to the store id

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "Id": 1337,
  "DeliveryFee": 0,
  "MinimumDeliveryOrderAmount": 0,
  "WellKnownText": "POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))"
}

Path Params

storeId
int32
required

Store Id to which the delivery zone will be added

Body Params

DeliveryFee
double

Delivery fee

MinimumDeliveryOrderAmount
double

Minimum delivery order amount

WellKnownText
string

Spatial data in Well Known Text format
We also support CIRCLE((0 0, 200)) - (centerX centerY, radius in m)

Response

OK

Dataobject

Generic data object.

Data.Idinteger

Delivery Fee Area Id

Data.DeliveryFeenumber

Delivery fee

Data.MinimumDeliveryOrderAmountnumber

Minimum delivery order amount

Data.WellKnownTextstring

Spatial data in Well Known Text format
We also support CIRCLE((0 0, 200)) - (centerX centerY, radius in m)

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Updates the existing delivery zone

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "Id": 1337,
  "DeliveryFee": 0,
  "MinimumDeliveryOrderAmount": 0,
  "WellKnownText": "POLYGON ((30 10, 40 40, 20 40, 10 20, 30 10))"
}

Path Params

storeId
int32
required

Store Id to which the delivery zone belongs

deliveryZoneId
int32
required

Delivery zone id to be updated

Body Params

DeliveryFee
double

Delivery fee

MinimumDeliveryOrderAmount
double

Minimum delivery order amount

WellKnownText
string

Spatial data in Well Known Text format
We also support CIRCLE((0 0, 200)) - (centerX centerY, radius in m)

Response

OK

Dataobject

Generic data object.

Data.Idinteger

Delivery Fee Area Id

Data.DeliveryFeenumber

Delivery fee

Data.MinimumDeliveryOrderAmountnumber

Minimum delivery order amount

Data.WellKnownTextstring

Spatial data in Well Known Text format
We also support CIRCLE((0 0, 200)) - (centerX centerY, radius in m)

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Removes the existing delivery zone

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
deletehttps://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId
curl --request DELETE \
  --url https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId"

response = requests.request("DELETE", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/stores/storeId/deliveryzones/deliveryZoneId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

storeId
int32
required

Store Id to which the delivery zone belongs

deliveryZoneId
int32
required

Delivery zone id to be removed

Response

OK

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get event by Id

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/eventId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events/eventId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/eventId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/eventId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/eventId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/eventId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/eventId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/eventId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

[
  {
    "EventName": "analytics.website",
    "EventType": "pageview",
    "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
    "CreateTime": "0001-01-01T00:00:00",
    "Position": 0
  }
]

Path Params

eventId
uuid
required

Event identifier (Guid)

Response

OK

AnalyticsClientEventarray

Client Analytics events

OrderAcceptedEventarray

Order accepted events

OrderCreatedEventarray

Order created events

OrderRatingUpdatedEventarray

Order rating updated events

OrderRefundedEventarray

Order refunded events

OrderRejectedEventarray

Order rejected events

OrderTipUpdatedEventarray

Order tip updated events

StoreCreatedEventarray

Store created events

StoreDeletedEventarray

Store deleted events

StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

StoreUpdatedEventarray

Store updated events

MenuCreatedEventarray

Menu created events

MenuUpdatedEventarray

Menu updated events

StoreGroupCreatedEventarray

Store group created events

StoreGroupUpdatedEventarray

Store group updated events

StoreGroupDeletedEventarray

Store group deleted events

CustomerCreatedEventarray

Customer created events

CustomerUpdatedEventarray

Customer updated events

CustomerConsentUpdatedEventarray

Customer consent updated events

WebhookSubscriptionCreatedEventarray

Webhook subscription created events

WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

PrinterTurnedOnEventarray

Printer turned ON event

PrinterTurnedOffEventarray

Printer turned OFF event

PrinterAssignedToStoreEventarray

Printer assigned to store event

PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

PhoneCallStartedEventarray

Phone call started event

PhoneCallEndedEventarray

Phone call ended event

LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

RetentionCampaignCreatedEventarray

Retention campaign created event

RetentionCampaignDeletedEventarray

Retention campaign deleted event

RetentionCampaignUpdatedEventarray

Retention campaign updated event

SmsReceivedEventarray

Sms received event

UserLoginEventarray

User login event

UserCreatedEventarray

User created event

UserUpdatedEventarray

User updated event

UserDeletedEventarray

User deleted event

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get menu events

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/menu/menuId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events/menu/menuId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/menu/menuId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/menu/menuId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/menu/menuId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/menu/menuId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/menu/menuId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/menu/menuId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Path Params

menuId
int32
required

Menu Identifier

Query Params

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get user events

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/user/userId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events/user/userId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/user/userId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/user/userId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/user/userId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/user/userId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/user/userId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/user/userId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Path Params

userId
int32
required

User identifier

Query Params

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get order events

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/order/orderId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events/order/orderId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/order/orderId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/order/orderId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/order/orderId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/order/orderId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/order/orderId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/order/orderId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Path Params

orderId
int32
required

Order identifier

Query Params

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get store events

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/store/storeId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events/store/storeId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/store/storeId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/store/storeId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/store/storeId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/store/storeId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/store/storeId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/store/storeId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Path Params

storeId
int32
required

Id of the store

Query Params

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get customer events

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/customer/customerId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events/customer/customerId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/customer/customerId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/customer/customerId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/customer/customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/customer/customerId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/customer/customerId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/customer/customerId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Path Params

customerId
int32
required

Customer identifier identifier

Query Params

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get WhiteLabel events

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/whitelabel/whitelabelId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Path Params

whitelabelId
int32
required

White Label Identifier

Query Params

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get order events by customer

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events/order
curl --request GET \
  --url 'https://api.flipdish.co/api/v1.0/events/order?customerId=customerId'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events/order',
  qs: { customerId: 'customerId' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events/order?customerId=customerId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events/order?customerId=customerId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events/order?customerId=customerId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events/order"

querystring = {"customerId":"customerId"}

response = requests.request("GET", url, params=querystring)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events/order?customerId=customerId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Query Params

customerId
int32
required

Customer identifier

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get events

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/events
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/events
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/events");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/events");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/events"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/events")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "OrderCreatedEvent": [
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    },
    {
      "EventName": "order.created",
      "Description": "Customer 1234 palced a DELIVERY order",
      "OrderCreatedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ],
  "OrderRejectedEvent": [
    {
      "EventName": "order.rejected",
      "Description": "Store rejected a collection order",
      "OrderRejectedTime": "2017-12-15T12:00:00",
      "Order": {
        "Store": {
          "Id": 123,
          "Name": "Restaurant",
          "MenuId": 123,
          "Metadata": {
            "foo": "bar"
          },
          "Currency": "EUR",
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          }
        },
        "Customer": {
          "Id": 1234,
          "Name": "John Doe",
          "EmailAddress": "john@doe.com",
          "PhoneNumberLocalFormat": "0818204488",
          "PhoneNumber": "+353818204488"
        },
        "Voucher": {
          "Name": "-€5 (abc123)",
          "Description": "abc123",
          "Code": "abc123",
          "Amount": 0,
          "Type": "PercentageDiscount",
          "SubType": "None"
        },
        "Fees": {
          "FeeAmount": 0,
          "PercentageRate": 0,
          "PerTransactionFee": 0
        },
        "OrderItems": [
          {
            "OrderItemOptions": [
              {
                "Metadata": {
                  "foo": "bar"
                },
                "MenuItemOptionId": 654645,
                "IsMasterOptionSetItem": false,
                "Name": "Option 1",
                "Price": 0,
                "MenuItemOptionDisplayOrder": 1,
                "MenuItemOptionSetDisplayOrder": 1
              }
            ],
            "Metadata": {
              "foo": "bar"
            },
            "MenuSectionName": "Section 1",
            "MenuSectionDisplayOrder": 1,
            "Name": "Item 1",
            "Description": "First order item",
            "Price": 0,
            "PriceIncludingOptionSetItems": 0,
            "MenuItemId": 5545,
            "MenuItemDisplayOrder": 1,
            "IsAvailable": true
          }
        ],
        "DeliveryLocation": {
          "Coordinates": {
            "Latitude": 0,
            "Longitude": 0
          },
          "Building": "38",
          "Street": "Pearse Street",
          "Town": "Dublin",
          "PostCode": "xx xxx",
          "DeliveryInstructions": "building is on the right",
          "PrettyAddressString": "38 Parse Street, Dublin, xx xxx"
        },
        "CustomerLocation": {
          "Latitude": 0,
          "Longitude": 0
        },
        "OrderId": 1234,
        "DeliveryType": "Delivery",
        "PickupLocationType": "TakeOut",
        "TipAmount": 0,
        "DeliveryAmount": 0,
        "OrderItemsAmount": 0,
        "Amount": 0,
        "ProcessingFee": 0,
        "PaymentAccountType": "Card",
        "PaymentAccountDescription": "Visa ****2371",
        "OrderState": "ReadyToProcess",
        "IsPreOrder": true,
        "PlacedTime": "2017-12-15T11:00:00",
        "RequestedForTime": "2017-12-15T12:00:00",
        "ChefNote": "no oregano please",
        "AppType": "Ios",
        "UserRating": 2
      },
      "FlipdishEventId": "00000000-0000-0000-0000-000000000000",
      "CreateTime": "0001-01-01T00:00:00",
      "Position": 0
    }
  ]
}

Query Params

storeId
int32

Store Id

whiteLabelId
int32

White Label Id

customerId
int32

Customer Id

limit
int32

The maximum elements to return

page
int32

The index of the page to return, starting by 1

start
date-time

Start date

end
date-time

End date

name
array of strings

Event names to filter in

Response

OK

Dataobject

Event results

Data.AnalyticsClientEventarray

Client Analytics events

Data.OrderAcceptedEventarray

Order accepted events

Data.OrderCreatedEventarray

Order created events

Data.OrderRatingUpdatedEventarray

Order rating updated events

Data.OrderRefundedEventarray

Order refunded events

Data.OrderRejectedEventarray

Order rejected events

Data.OrderTipUpdatedEventarray

Order tip updated events

Data.StoreCreatedEventarray

Store created events

Data.StoreDeletedEventarray

Store deleted events

Data.StoreDeliveryZoneUpdatedEventarray

Store delivery zone updated events

Data.StoreOpeningHoursUpdatedEventarray

Store opening hours updated events

Data.StoreUpdatedEventarray

Store updated events

Data.MenuCreatedEventarray

Menu created events

Data.MenuUpdatedEventarray

Menu updated events

Data.StoreGroupCreatedEventarray

Store group created events

Data.StoreGroupUpdatedEventarray

Store group updated events

Data.StoreGroupDeletedEventarray

Store group deleted events

Data.CustomerCreatedEventarray

Customer created events

Data.CustomerUpdatedEventarray

Customer updated events

Data.CustomerConsentUpdatedEventarray

Customer consent updated events

Data.WebhookSubscriptionCreatedEventarray

Webhook subscription created events

Data.WebhookSubscriptionUpdatedEventarray

Webhook subscription updated events

Data.WebhookSubscriptionDeletedEventarray

Webhook subscription deleted events

Data.PrinterTurnedOnEventarray

Printer turned ON event

Data.PrinterTurnedOffEventarray

Printer turned OFF event

Data.PrinterAssignedToStoreEventarray

Printer assigned to store event

Data.PrinterUnassignedFromStoreEventarray

Printer unassigned from store event

Data.PhoneCallStartedEventarray

Phone call started event

Data.PhoneCallEndedEventarray

Phone call ended event

Data.LoyaltyCampaignCreatedEventarray

Loyalty campaign created event

Data.LoyaltyCampaignDeletedEventarray

Loyalty campaign deleted event

Data.LoyaltyCampaignUpdatedEventarray

Loyalty campaign updated event

Data.RetentionCampaignCreatedEventarray

Retention campaign created event

Data.RetentionCampaignDeletedEventarray

Retention campaign deleted event

Data.RetentionCampaignUpdatedEventarray

Retention campaign updated event

Data.SmsReceivedEventarray

Sms received event

Data.UserLoginEventarray

User login event

Data.UserCreatedEventarray

User created event

Data.UserUpdatedEventarray

User updated event

Data.UserDeletedEventarray

User deleted event

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Heartbeat

 
Suggest Edits

/api/v1.0/heartbeat

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/heartbeat
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/heartbeat
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/heartbeat' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/heartbeat");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/heartbeat")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/heartbeat");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/heartbeat"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/heartbeat")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

foobar

Response

OK

Datastring

Data string

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

HttpRequestResponseLogs

 
Suggest Edits

Get API interaction logs

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/interactions/logs
curl --request GET \
  --url 'https://api.flipdish.co/api/v1.0/interactions/logs?start=start&end=end'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/interactions/logs',
  qs: 
   { start: 'start',
     end: 'end' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/interactions/logs?start=start&end=end");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/interactions/logs?start=start&end=end")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/interactions/logs?start=start&end=end");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/interactions/logs"

querystring = {"start":"start","end":"end"}

response = requests.request("GET", url, params=querystring)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/interactions/logs?start=start&end=end")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

[
  {
    "Verb": "GET",
    "RequestUri": "http://localhost/api/v1/interactions/logs",
    "StatusCode": 0,
    "ReasonPhrase": "OK",
    "CallDurationInMilliseconds": 0,
    "UserId": "5124",
    "IpAddress": "212.23.68.141",
    "CreatedDateTime": "2017-12-12 11:06:07Z",
    "RequestBody": "{  \"User\": {    \"UserId\": 123,    \"UserName\": \"John\",    \"UserPhoneNumber\": \"+353831234567\",    \"UserEmail\": john@doe.com  }}",
    "RequestLength": 0,
    "ResponseBody": "{\"Data\":[]}",
    "ResponseLength": 0
  }
]
Authentication has been denied for this request.
Successful authentication, but authorization has been denied for this request.

Query Params

start
date-time
required

Start date time

end
date-time
required

End date time

filterByUserId
int32

User id (optional)

page
int32

Page number

limit
int32

Page size

Response

OK

Pageinteger

Current page index

Limitinteger

Current page size

TotalRecordCountinteger

Total record count

Dataarray

Generic data object.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Lightspeed

 
Suggest Edits

/api/v1.0/lightspeed/{storeId}/settings

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/lightspeed/storeId/settings
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "CompanyId": "14123",
  "Enabled": true,
  "EstimatedMinutesForDelivery": 20,
  "EstimatedMinutesForCollection": 15,
  "GeographicLocation": "euc1",
  "Establishment": true,
  "VoucherId": "123456|FLIPDISH-VOUCHER",
  "DeliveryFeeId": "123456|FLIPDISH-DELIVERY-FEE",
  "ProcessingFeeId": "123456|FLIPDISH-PROCESSING-FEE",
  "MenuId": 0
}

Path Params

storeId
int32
required

Response

OK

Dataobject

Generic data object.

Data.CompanyIdstring

Company Id

Data.Enabledboolean

Enabled

Data.EstimatedMinutesForDeliveryinteger

Estimated minutes for delivery

Data.EstimatedMinutesForCollectioninteger

Estimated minutes for collection

Data.GeographicLocationstring

Geographic location (euc1, nae1, euw2, ....))

Data.Establishmentboolean

Is the CompanyId an establishment (kind of the store of a group of store)

Data.VoucherIdstring

The Lightspeed voucher identifier to map with our

Data.DeliveryFeeIdstring

The Lightspeed delivery fee identifier to map with our

Data.ProcessingFeeIdstring

The Lightspeed processing fee identifier to map with our

Data.PriceTypestring

Which price to choose from Lightspeed menu

Data.MenuIdinteger

The menu id of the store

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

/api/v1.0/lightspeed/{storeId}/settings

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/lightspeed/storeId/settings
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/lightspeed/storeId/settings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "CompanyId": "14123",
  "Enabled": true,
  "EstimatedMinutesForDelivery": 20,
  "EstimatedMinutesForCollection": 15,
  "GeographicLocation": "euc1",
  "Establishment": true,
  "VoucherId": "123456|FLIPDISH-VOUCHER",
  "DeliveryFeeId": "123456|FLIPDISH-DELIVERY-FEE",
  "ProcessingFeeId": "123456|FLIPDISH-PROCESSING-FEE",
  "MenuId": 0
}

Path Params

storeId
int32
required

Body Params

CompanyId
string

Company Id

Enabled
boolean

Enabled

EstimatedMinutesForDelivery
int32

Estimated minutes for delivery

EstimatedMinutesForCollection
int32

Estimated minutes for collection

GeographicLocation
string

Geographic location (euc1, nae1, euw2, ....))

Establishment
boolean

Is the CompanyId an establishment (kind of the store of a group of store)

VoucherId
string

The Lightspeed voucher identifier to map with our

DeliveryFeeId
string

The Lightspeed delivery fee identifier to map with our

ProcessingFeeId
string

The Lightspeed processing fee identifier to map with our

PriceType
string

Which price to choose from Lightspeed menu

MenuId
int32

The menu id of the store

Response

OK

Dataobject

Generic data object.

Data.CompanyIdstring

Company Id

Data.Enabledboolean

Enabled

Data.EstimatedMinutesForDeliveryinteger

Estimated minutes for delivery

Data.EstimatedMinutesForCollectioninteger

Estimated minutes for collection

Data.GeographicLocationstring

Geographic location (euc1, nae1, euw2, ....))

Data.Establishmentboolean

Is the CompanyId an establishment (kind of the store of a group of store)

Data.VoucherIdstring

The Lightspeed voucher identifier to map with our

Data.DeliveryFeeIdstring

The Lightspeed delivery fee identifier to map with our

Data.ProcessingFeeIdstring

The Lightspeed processing fee identifier to map with our

Data.PriceTypestring

Which price to choose from Lightspeed menu

Data.MenuIdinteger

The menu id of the store

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

/api/v1.0/lightspeed/{storeId}/menu/generate

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/lightspeed/storeId/menu/generate")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

storeId
int32
required

Response

OK

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

Suggest Edits

Get menu item option set items

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

[
  {
    "MenuItemOptionSetItemId": 123,
    "ImageUrl": "http://flipdish/image.png",
    "PublicId": "c85f952c-893f-4898-b3c7-11ba6d6b084f",
    "Name": "Rice",
    "Price": 0,
    "IsAvailable": true,
    "DisplayOrder": 0,
    "CellLayoutType": "Medium"
  }
]

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

optionSetId
int32
required

Option set identifier

Response

OK

Dataarray

Generic data object.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Create menu item option set item

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "MenuItemOptionSetItemId": 123,
  "ImageUrl": "http://flipdish/image.png",
  "PublicId": "c85f952c-893f-4898-b3c7-11ba6d6b084f",
  "Name": "Rice",
  "Price": 0,
  "IsAvailable": true,
  "DisplayOrder": 0,
  "CellLayoutType": "Medium"
}

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

optionSetId
int32
required

Option set identifier

Body Params

Name
string

Name

Price
double

Price

IsAvailable
boolean

Is available

DisplayOrder
int32

Display order. Displayed in ascending order.

CellLayoutType
string

Small | Medium | Large
Affects the layout of the menu.

Response

OK

Created

Dataobject

Generic data object.

Data.MenuItemOptionSetItemIdinteger

Menu item option set item identifier

Data.ImageUrlstring

Image url

Data.PublicIdstring

Permanent reference to the item.

Data.Namestring

Name

Data.Pricenumber

Price

Data.IsAvailableboolean

Is available

Data.DisplayOrderinteger

Display order. Displayed in ascending order.

Data.CellLayoutTypestring

Small | Medium | Large
Affects the layout of the menu.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Get menu item option set item by identifier

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "MenuItemOptionSetItemId": 123,
  "ImageUrl": "http://flipdish/image.png",
  "PublicId": "c85f952c-893f-4898-b3c7-11ba6d6b084f",
  "Name": "Rice",
  "Price": 0,
  "IsAvailable": true,
  "DisplayOrder": 0,
  "CellLayoutType": "Medium"
}

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

optionSetId
int32
required

Option set identifier

menuItemOptionSetItemId
int32
required

Option set item identifier

Response

OK

Dataobject

Generic data object.

Data.MenuItemOptionSetItemIdinteger

Menu item option set item identifier

Data.ImageUrlstring

Image url

Data.PublicIdstring

Permanent reference to the item.

Data.Namestring

Name

Data.Pricenumber

Price

Data.IsAvailableboolean

Is available

Data.DisplayOrderinteger

Display order. Displayed in ascending order.

Data.CellLayoutTypestring

Small | Medium | Large
Affects the layout of the menu.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Update menu item option set item

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

optionSetId
int32
required

Option set identifier

menuItemOptionSetItemId
int32
required

Option set item identifier

Query Params

undoAfter
double

An optional time period, in hours, after which the hide-section operaton will be undone.

Body Params

Name
string

Name

Price
double

Price

IsAvailable
boolean

Is available

DisplayOrder
int32

Display order. Displayed in ascending order.

CellLayoutType
string

Small | Medium | Large
Affects the layout of the menu.

Response

OK

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Delete menu item option set item

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
deletehttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId
curl --request DELETE \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId"

response = requests.request("DELETE", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

optionSetId
int32
required

Option set identifier

menuItemOptionSetItemId
int32
required

Option set item identifier

Response

OK

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Upload menu item option set item image

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

foobar

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

optionSetId
int32
required

Option set identifier

menuItemOptionSetItemId
int32
required

Option set item identifier

Form Data

Image
file
required

Option set item image

Response

OK

Datastring

Data string

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Delete menu item option set item image

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
deletehttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image
curl --request DELETE \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image");
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image"

response = requests.request("DELETE", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets/optionSetId/optionsetitems/menuItemOptionSetItemId/image")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "DELETE"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

optionSetId
int32
required

Option set identifier

menuItemOptionSetItemId
int32
required

Option set item identifier

Response

OK

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Get menu item option sets

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
gethttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets
curl --request GET \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets"

response = requests.request("GET", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

[
  {
    "MenuItemOptionSetId": 123,
    "ImageUrl": "http://flipdish/image.png",
    "MenuItemOptionSetItems": [
      {
        "MenuItemOptionSetItemId": 123,
        "ImageUrl": "http://flipdish/image.png",
        "PublicId": "c85f952c-893f-4898-b3c7-11ba6d6b084f",
        "Name": "Rice",
        "Price": 0,
        "IsAvailable": true,
        "DisplayOrder": 0,
        "CellLayoutType": "Medium"
      }
    ],
    "PublicId": "33f3e239-b699-479f-8a47-f6dd28843aa6",
    "Name": "Salads",
    "IsMasterOptionSet": false,
    "DisplayOrder": 0,
    "MinSelectCount": 1,
    "MaxSelectCount": 4,
    "CellLayoutType": "Medium"
  }
]

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

Response

OK

Dataarray

Generic data object.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Messagestring

Message

Successful authentication, but authorization has been denied for this request.

Messagestring

Message

NotFound

Suggest Edits

Create menu item option set

 

OAuth2 Auth

OAuth2 Implicit Grant

Bearer
 Authentication is required for this endpoint.
posthttps://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets
curl --request POST \
  --url https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
var client = new RestClient("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
require 'uri'
require 'net/http'

url = URI("https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets");

xhr.send(data);
import requests

url = "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets"

response = requests.request("POST", url)

print(response.text)
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.flipdish.co/api/v1.0/menus/menuId/sections/menuSectionId/sectionitems/menuSectionItemId/optionsets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
A binary file was returned

Your OAuth2 token is incorrect or has expired

{
  "MenuItemOptionSetId": 123,
  "ImageUrl": "http://flipdish/image.png",
  "MenuItemOptionSetItems": [
    {
      "MenuItemOptionSetItemId": 123,
      "ImageUrl": "http://flipdish/image.png",
      "PublicId": "c85f952c-893f-4898-b3c7-11ba6d6b084f",
      "Name": "Rice",
      "Price": 0,
      "IsAvailable": true,
      "DisplayOrder": 0,
      "CellLayoutType": "Medium"
    }
  ],
  "PublicId": "33f3e239-b699-479f-8a47-f6dd28843aa6",
  "Name": "Salads",
  "IsMasterOptionSet": false,
  "DisplayOrder": 0,
  "MinSelectCount": 1,
  "MaxSelectCount": 4,
  "CellLayoutType": "Medium"
}

Path Params

menuId
int32
required

Menu identifier

menuSectionId
int32
required

Menu section identifier

menuSectionItemId
int32
required

Menu section item identifier

Body Params

Name
string

Menu item option set name

IsMasterOptionSet
boolean

Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition ("with ketchup") or modifier ("large").

DisplayOrder
int32

Display order. Displayed in ascending order.

MinSelectCount
int32

Minimum items must be selected

MaxSelectCount
int32

Maximum number of items can be selected

CellLayoutType
string

Small | Medium | Large
Affects the layout of the menu.

Response

OK

Created

Dataobject

Generic data object.

Data.MenuItemOptionSetIdinteger

Menu item option set identifier

Data.ImageUrlstring

Image url

Data.MenuItemOptionSetItemsarray

Option set items

Data.PublicIdstring

Permanent reference to the item.

Data.Namestring

Menu item option set name

Data.IsMasterOptionSetboolean

Is master option set. This can affect the layout of the options in the menu displayed to the customer. Usually it is true if the option could be considerd a standalone item as opposed to an addition ("with ketchup") or modifier ("large").

Data.DisplayOrderinteger

Display order. Displayed in ascending order.

Data.MinSelectCountinteger

Minimum items must be selected

Data.MaxSelectCountinteger

Maximum number of items can be selected

Data.CellLayoutTypestring

Small | Medium | Large
Affects the layout of the menu.

BadRequest

Messagestring

Error message

Errorsarray

List of errors grouped by field name

Authentication has been denied for this request.

Mess