Flipdish

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!

> POS integration quick start guide
> Driver dispatch integration quick start guide

Flipdish SDK

.NET

Download our .NET SDK as nuget package or fork our Github repository

Installation

PM> Install-Package Flipdish
> dotnet add package Flipdish --version 1.0.22
> paket add Flipdish

Usage

using System;
using System.Diagnostics;
using Flipdish.Api;
using Flipdish.Client;
using Flipdish.Model;

namespace Example
{
    public class GetStoresExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new StoresApi();
            var searchQuery = searchQuery_example;  // string | Search query (optional) 
            var page = 56;  // int? | Requested page index (optional) 
            var limit = 56;  // int? | Requested page limit (optional) 

            try
            {
                // Get all stores
                RestApiPaginationResultStore result = apiInstance.GetStores(searchQuery, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StoresApi.GetStores: " + e.Message );
            }
        }
    }
}

JavaScript

Download our JavaScript SDK as npm package or fork our Github repository

Installation

npm install @flipdish/api-client-javascript --save

Usage

var Flipdish = require('@flipdish/api-client-javascript');
var defaultClient = Flipdish.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Flipdish.StoresApi();

var opts = { 
  'searchQuery': "mexican cafe", // String | Search query
  'page': 1, // Number | Requested page index
  'limit': 20 // Number | Requested page limit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getStores(opts, callback);

Node with TypeScript

Download our Node with Typescript SDK as npm package or fork our Github repository

Installation

npm install @flipdish/api-client-typescript --save
yarn add @flipdish/api-client-typescript
bower install @flipdish/api-client-typescript --save

Usage

import { StoresApi } from '@flipdish/api-client-typescript';
 
let storesApi = new StoresApi();
storesApi.accessToken = '<your_access_token>';
storesApi.getStores('mexican cafe', 1, 20)
.then(response => {
        response.body.Data.map(store => console.log(store));
    }).catch(error => {
        console.error(error);    
    });

Flipdish SDK


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.