{ "opencollection": "1.0.0", "info": { "name": "Flipdish API - Apps Accounts Events API", "version": "v1.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Flipdish Get Events by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/:eventId", "params": [ { "name": "eventId", "value": "500123", "type": "path", "description": "The event id path parameter." }, { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Events by Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/{eventId})." }, { "info": { "name": "Flipdish Get Menu Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/menu/:menuId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "menuId", "value": "500123", "type": "path", "description": "The menu id path parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/menu/{menuId})." }, { "info": { "name": "Flipdish Get User Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/user/:userId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "userId", "value": "500123", "type": "path", "description": "The user id path parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get User Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/user/{userId})." }, { "info": { "name": "Flipdish Get Order Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/order/:orderId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "orderId", "value": "500123", "type": "path", "description": "The order id path parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Order Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/order/{orderId})." }, { "info": { "name": "Flipdish Get Store Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/store/:storeId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "storeId", "value": "500123", "type": "path", "description": "The store id path parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Store Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/store/{storeId})." }, { "info": { "name": "Flipdish Get Customer Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/customer/:customerId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "customerId", "value": "500123", "type": "path", "description": "The customer id path parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Customer Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/customer/{customerId})." }, { "info": { "name": "Flipdish Get White Label Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/whitelabel/:whitelabelId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "whitelabelId", "value": "500123", "type": "path", "description": "The whitelabel id path parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get White Label Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/whitelabel/{whitelabelId})." }, { "info": { "name": "Flipdish Get Order Events by Customer", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events/order", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "customerId", "value": "500123", "type": "query", "description": "The customer id query parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Order Events by Customer via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events/order)." }, { "info": { "name": "Flipdish Get Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/events", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "whiteLabelId", "value": "500123", "type": "query", "description": "The white label id query parameter." }, { "name": "customerId", "value": "500123", "type": "query", "description": "The customer id query parameter." }, { "name": "limit", "value": "1", "type": "query", "description": "The maximum elements to return" }, { "name": "page", "value": "1", "type": "query", "description": "The index of the page to return, starting by 1" }, { "name": "start", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "Start date" }, { "name": "end", "value": "2026-06-02T12:00:00Z", "type": "query", "description": "End date" }, { "name": "orderId", "value": "500123", "type": "query", "description": "Events that have Order Id" }, { "name": "storeId", "value": "500123", "type": "query", "description": "Events that have Store Id" }, { "name": "storeIdList", "value": "1", "type": "query", "description": "Events that have Store Id List" }, { "name": "storeGroupId", "value": "500123", "type": "query", "description": "Events that have Store Group Id" }, { "name": "userId", "value": "500123", "type": "query", "description": "Events that have User Id" }, { "name": "menuId", "value": "500123", "type": "query", "description": "Events that have Menu Id" }, { "name": "campaignId", "value": "500123", "type": "query", "description": "Events that have Campaign Id" }, { "name": "userEmail", "value": "owner@example.com", "type": "query", "description": "Events that have User Email" }, { "name": "userName", "value": "Example Name", "type": "query", "description": "Events that have User Name" }, { "name": "voucherCode", "value": "string", "type": "query", "description": "Events that have voucher code" }, { "name": "eventType", "value": "string", "type": "query", "description": "Events that have event type\\s" }, { "name": "flipdishEventId", "value": "500123", "type": "query", "description": "Unique Identifier of Event, if this is specified, all other criteria are ignored." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Events via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/events)." } ] } ], "bundled": true }