{ "opencollection": "1.0.0", "info": { "name": "Flipdish API - Apps Accounts Menus 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": "Menus", "type": "folder" }, "items": [ { "info": { "name": "Flipdish Get Menus by App Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/menus", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "Get Menus for this appId" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menus by App Id via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/menus)." }, { "info": { "name": "Flipdish Create New Menu for App", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/menus", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "App identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create New Menu for App via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus)." }, { "info": { "name": "Flipdish Get Menu by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu by Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId})." }, { "info": { "name": "Flipdish Update Menu", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update Menu via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId})." }, { "info": { "name": "Flipdish Delete Menu", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu Identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete Menu via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId})." }, { "info": { "name": "Flipdish Get Menu Tax Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/tax", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu Tax Details via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/tax)." }, { "info": { "name": "Flipdish Get Menu Name", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/name", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu Name via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/name)." }, { "info": { "name": "Flipdish Set Menu Name", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/name", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set Menu Name via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/name)." }, { "info": { "name": "Flipdish Get Menu Store Names", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/stores", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu Store Names via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/stores)." }, { "info": { "name": "Flipdish Get Menus Checkpoints", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/checkpoints", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menus Checkpoints via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/checkpoints)." }, { "info": { "name": "Flipdish Get All Menu Metadata by Menu Id and Store Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/metadata/store/:storeId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "storeId", "value": "500123", "type": "path", "description": "Store identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get All Menu Metadata by Menu Id and Store Id via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/metadata/store/{storeId})." }, { "info": { "name": "Flipdish Menus_Get Menu Bulk Show Hide", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/bulkshowhide/list", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu id" }, { "name": "isAvailable", "value": "true", "type": "query", "description": "Is available flag" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Menus_Get Menu Bulk Show Hide via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/bulkshowhide/list)." }, { "info": { "name": "Flipdish Get Menu Item Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/menuitem/:menuItemId/metadata/store/:storeId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "storeId", "value": "500123", "type": "path", "description": "Store identifier" }, { "name": "menuItemId", "value": "500123", "type": "path", "description": "Menu item identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu Item Metadata via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/store/{storeId})." }, { "info": { "name": "Flipdish Set Menu Item Metadata", "type": "http" }, "http": { "method": "PUT", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/menuitem/:menuItemId/metadata/store/:storeId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "storeId", "value": "500123", "type": "path", "description": "Store identifier" }, { "name": "menuItemId", "value": "500123", "type": "path", "description": "Menu item identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set Menu Item Metadata via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/store/{storeId})." }, { "info": { "name": "Flipdish Get Menu Item Metadata by Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/menuitem/:menuItemId/metadata/:key/store/:storeId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "storeId", "value": "500123", "type": "path", "description": "Store identifier" }, { "name": "menuItemId", "value": "500123", "type": "path", "description": "Menu item identifier" }, { "name": "key", "value": "string", "type": "path", "description": "Metadata key" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu Item Metadata by Key via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/{key}/store/{storeId})." }, { "info": { "name": "Flipdish Delete Menu Item Metadata", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/menuitem/:menuItemId/metadata/:key/store/:storeId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "storeId", "value": "500123", "type": "path", "description": "Store identifier" }, { "name": "menuItemId", "value": "500123", "type": "path", "description": "Menu item identifier" }, { "name": "key", "value": "string", "type": "path", "description": "Metadata key" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete Menu Item Metadata via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/menuitem/{menuItemId}/metadata/{key}/store/{storeId})." }, { "info": { "name": "Flipdish Get Menu Item Option Set Item Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/optionsetitem/:optionSetItemId/metadata/store/:storeId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "storeId", "value": "500123", "type": "path", "description": "Store identifier" }, { "name": "optionSetItemId", "value": "500123", "type": "path", "description": "Menu item option set item identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Menu Item Option Set Item Metadata via the Flipdish Open API v1.0 (GET /api/v1.0/menus/{menuId}/optionsetitem/{optionSetItemId}/metadata/store/{storeId})." }, { "info": { "name": "Flipdish Set Menu Item Option Set Item Metadata", "type": "http" }, "http": { "method": "PUT", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/optionsetitem/:optionSetItemId/metadata/store/:storeId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "storeId", "value": "500123", "type": "path", "description": "Store identifier" }, { "name": "optionSetItemId", "value": "500123", "type": "path", "description": "Menu item option set item identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set Menu Item Option Set Item Metadata via the Flipdish Open API v1.0 (PUT /api/v1.0/menus/{menuId}/optionsetitem/{optionSetItemId}/metadata/store/{storeId})." }, { "info": { "name": "Flipdish Upload New Menu for App", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/menus/xlsx", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "App identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload New Menu for App via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus/xlsx)." }, { "info": { "name": "Flipdish Set Menu Lock", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/lock", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Set Menu Lock via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/lock)." }, { "info": { "name": "Flipdish Upload Menu Image", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/image", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload Menu Image via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/image)." }, { "info": { "name": "Flipdish Delete Menu Image", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/image", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete Menu Image via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/image)." }, { "info": { "name": "Flipdish Menus_Upsert Tax Rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/taxrate", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Menus_Upsert Tax Rate via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/taxrate)." }, { "info": { "name": "Flipdish Create Draft Menu from Existing Menu", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/clone/:newName", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "newName", "value": "Example Name", "type": "path", "description": "Name of the new Menu" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create Draft Menu from Existing Menu via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/clone/{newName})." }, { "info": { "name": "Flipdish Menus_Set Display on Menu Tax", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/tax/show/:show", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "show", "value": "true", "type": "path", "description": "Boolean show or dont show tax (Exclusive tax type can only ever be TRUE)" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Menus_Set Display on Menu Tax via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/tax/show/{show})." }, { "info": { "name": "Flipdish Menus_Update Tax Type", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/tax/type/:type", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "type", "value": "IncludedInBasePrice", "type": "path", "description": "Type of Tax" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Menus_Update Tax Type via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/tax/type/{type})." }, { "info": { "name": "Flipdish Create New Menu Async", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/menus/async", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "App id" }, { "name": "orgId", "value": "500123", "type": "query", "description": "Org id" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create New Menu Async via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/menus/async)." }, { "info": { "name": "Flipdish Menus_Set Item Display Orders", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/sectiondisplayorders", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Menus_Set Item Display Orders via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/sectiondisplayorders)." }, { "info": { "name": "Flipdish Restore a Menu Checkpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/checkpoints/:checkpointId/restore", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "checkpointId", "value": "500123", "type": "path", "description": "Checkpoint to restore menu to" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Restore a Menu Checkpoint via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/checkpoints/{checkpointId}/restore)." }, { "info": { "name": "Flipdish Menus_Show Hide Bulk Items", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/bulkshowhide", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu id" }, { "name": "isAvailable", "value": "true", "type": "query", "description": "Is available flag" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Menus_Show Hide Bulk Items via the Flipdish Open API v1.0 (POST /api/v1.0/menus/{menuId}/bulkshowhide)." }, { "info": { "name": "Flipdish Menus_Delete Tax Rate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.flipdish.co/api/v1.0/menus/:menuId/tax/:taxId", "params": [ { "name": "menuId", "value": "500123", "type": "path", "description": "Menu identifier" }, { "name": "taxId", "value": "500123", "type": "path", "description": "Id of Menu Tax to be removed" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Menus_Delete Tax Rate via the Flipdish Open API v1.0 (DELETE /api/v1.0/menus/{menuId}/tax/{taxId})." } ] } ], "bundled": true }