{ "opencollection": "1.0.0", "info": { "name": "Flipdish API - Apps Accounts Vouchers 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": "Vouchers", "type": "folder" }, "items": [ { "info": { "name": "Flipdish Get Voucher by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/vouchers/:voucherId", "params": [ { "name": "voucherId", "value": "500123", "type": "path", "description": "The voucher id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Voucher by Id via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/{voucherId})." }, { "info": { "name": "Flipdish Update Voucher", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/vouchers/:voucherId", "params": [ { "name": "voucherId", "value": "500123", "type": "path", "description": "The voucher id path parameter." }, { "name": "storeId", "value": "500123", "type": "query", "description": "The store id query parameter." }, { "name": "percentValue", "value": "1", "type": "query", "description": "The percent value query parameter." }, { "name": "lumpValue", "value": "1", "type": "query", "description": "The lump value query parameter." }, { "name": "maxDiscountAmount", "value": "12.5", "type": "query", "description": "The max discount amount query parameter." } ], "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 Voucher via the Flipdish Open API v1.0 (POST /api/v1.0/vouchers/{voucherId})." }, { "info": { "name": "Flipdish Get Voucher by Code", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/vouchers/code/:code", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "code", "value": "string", "type": "path", "description": "The code path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Voucher by Code via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/code/{code})." }, { "info": { "name": "Flipdish Get Vouchers by Customer for App", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/vouchers/:appId/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." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Vouchers by Customer for App via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/{appId}/customer/{customerId})." }, { "info": { "name": "Flipdish Get Voucher Validity Periods", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/vouchers/:voucherId/validity-periods", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "voucherId", "value": "500123", "type": "path", "description": "The voucher id path parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Voucher Validity Periods via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/{voucherId}/validity-periods)." }, { "info": { "name": "Flipdish Get Voucher Stats by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/vouchers/stats/:voucherId", "params": [ { "name": "voucherId", "value": "500123", "type": "path", "description": "The voucher id path parameter." }, { "name": "aggregateDataBy", "value": "Daily", "type": "query", "description": "The aggregate data by query parameter." }, { "name": "dataPointLimit", "value": "1", "type": "query", "description": "The data point limit query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Voucher Stats by Id via the Flipdish Open API v1.0 (GET /api/v1.0/vouchers/stats/{voucherId})." }, { "info": { "name": "Flipdish Get Vouchers", "type": "http" }, "http": { "method": "GET", "url": "https://api.flipdish.co/api/v1.0/:appId/vouchers/summaries", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "pageIndex", "value": "1", "type": "query", "description": "The page index query parameter." }, { "name": "pageSize", "value": "1", "type": "query", "description": "The page size query parameter." }, { "name": "searchCodes", "value": "string", "type": "query", "description": "The search codes query parameter." }, { "name": "statusSearch", "value": "Valid", "type": "query", "description": "The status search query parameter." }, { "name": "typeSearch", "value": "PercentageDiscount", "type": "query", "description": "The type search query parameter." }, { "name": "subTypeSearch", "value": "None", "type": "query", "description": "The sub type search query parameter." }, { "name": "storeIds", "value": "1", "type": "query", "description": "The store ids query parameter." }, { "name": "channelRestrictions", "value": "Ios", "type": "query", "description": "The channel restrictions query parameter." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.flipdish.co/identity/connect/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get Vouchers via the Flipdish Open API v1.0 (GET /api/v1.0/{appId}/vouchers/summaries)." }, { "info": { "name": "Flipdish Create Voucher", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/vouchers/:appId", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." } ], "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 Voucher via the Flipdish Open API v1.0 (POST /api/v1.0/vouchers/{appId})." }, { "info": { "name": "Flipdish Update Voucher Usage", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/vouchers/:voucherId/usage", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "voucherId", "value": "500123", "type": "path", "description": "The voucher id path parameter." } ], "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 Voucher Usage via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/vouchers/{voucherId}/usage)." }, { "info": { "name": "Flipdish Set Voucher Validity Periods Simplified", "type": "http" }, "http": { "method": "POST", "url": "https://api.flipdish.co/api/v1.0/:appId/vouchers/:voucherId/validity-periods-simplified", "params": [ { "name": "appId", "value": "500123", "type": "path", "description": "The app id path parameter." }, { "name": "voucherId", "value": "500123", "type": "path", "description": "The voucher id path parameter." } ], "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 Voucher Validity Periods Simplified via the Flipdish Open API v1.0 (POST /api/v1.0/{appId}/vouchers/{voucherId}/validity-periods-simplified)." } ] } ], "bundled": true }