{ "info": { "_postman_id": "10cc87cc-8e28-454e-9e05-58efbe7048ae", "name": "Resources API", "description": "The Resource API provides a set of APIs to manage resources in the AIR platform including:\n\n- Campaigns\n \n- Schemes\n \n- Reward Banks\n \n- Token Formats\n \n- Inventory Lists\n \n- Units", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "2563138", "_collection_link": "https://go.postman.co/collection/2563138-10cc87cc-8e28-454e-9e05-58efbe7048ae?source=collection_link" }, "item": [ { "name": "Audiences", "item": [ { "name": "Create Audience", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "const CryptoJS = require('crypto-js'); // Import CryptoJS library", "pm.environment.set('audienceReference', CryptoJS.lib.WordArray.random(128/8).toString());", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " const json = pm.response.json();", " pm.environment.set('audienceId', json.id);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Audience Name {{audienceReference}}\",\n \"reference\": \"{{audienceReference}}\"\n}" }, "url": { "raw": "{{url}}/audiences", "host": [ "{{url}}" ], "path": [ "audiences" ] }, "description": "Create a new audience" }, "response": [] }, { "name": "Replace Audience", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " const json = pm.response.json();", " pm.environment.set('audienceId', json.id);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Audience Name {{audienceReference}}\",\n \"reference\": \"{{audienceReference}}\"\n}" }, "url": { "raw": "{{url}}/audiences/{{audienceId}}", "host": [ "{{url}}" ], "path": [ "audiences", "{{audienceId}}" ] }, "description": "Replace an existing audience" }, "response": [] }, { "name": "Delete Audience", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 204\", function () {", " pm.response.to.have.status(204);", "});", "", "if (pm.response.code === 204) {", " const json = pm.response.json();", " pm.environment.unset('audienceId');", " pm.environment.unset('audienceReference');", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{url}}/audiences/{{audienceId}}", "host": [ "{{url}}" ], "path": [ "audiences", "{{audienceId}}" ] }, "description": "Delete an existing audience" }, "response": [] }, { "name": "Retrieve Audiences", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('audeinceId', pm.response.json().results[0].id);", "}" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{url}}/audiences", "host": [ "{{url}}" ], "path": [ "audiences" ] }, "description": "Retrieve all audiences" }, "response": [] } ] }, { "name": "Campaigns", "item": [ { "name": "Get Campaigns", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " const json = pm.response.json();", " pm.environment.set('campaignId', json.results[0].id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/campaigns", "host": [ "{{url}}" ], "path": [ "campaigns" ] }, "description": "Campaigns" }, "response": [] }, { "name": "Create Campaign", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " const json = pm.response.json();", " pm.environment.set('campaignId', json.id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"DISCOUNT_BASKET\",\n \"status\": \"ACTIVE\",\n \"class\": \"COUPON\",\n \"details\": {\n \"name\": \"Campaign Name\",\n \"alternativeName\": \"\",\n \"description\": \"\",\n \"alternativeDescription\": \"\",\n \"printerMessage\": \"\",\n \"screenMessage\": null,\n \"tags\": [],\n \"startDate\": \"2019-01-09 00:00:00\",\n \"endDate\": \"2039-01-24 23:59:00\",\n \"mode\": \"OPEN\"\n },\n \"settings\": {\n \"tokenProvider\": null,\n \"tokenFormat\": null,\n \"walletEnabled\": true,\n \"issuanceMethod\": null,\n \"accountClientType\": null,\n \"defaultAccountClientState\": null\n },\n \"partners\": {\n \"creation\": [],\n \"redemption\": [\n {\n \"redemptionLimit\": null,\n \"partner\": \"{{redemptionPartnerUnit}}\"\n }\n ]\n },\n \"rules\": {\n \"creation\": {\n \"campaignLimit\": null,\n \"consumerLimit\": null,\n \"consumerLimitActive\": 1,\n \"consumerLimitPerPeriod\": null\n },\n \"verification\": {\n \"lock\": false\n },\n \"redemption\": {\n \"maxRedemptionsPerPeriod\": {\n \"active\": false,\n \"period\": \"ACCOUNT_REDEMPTION_CALENDAR_DAY\",\n \"limit\": null\n },\n \"campaignLimit\": null,\n \"couponLimit\": 1,\n \"allowOverride\": true,\n \"allowAccountOverride\": null,\n \"maximumPerTransaction\": null,\n \"maximumPerTransactionPerCampaignTypeCode\": null,\n \"maximumAccountUsage\": 1\n },\n \"locations\": null,\n \"expiry\": {\n \"type\": \"CAMPAIGN_END\",\n \"valueType\": null,\n \"value\": null,\n \"date\": null\n }\n },\n \"windows\": {\n \"creation\": [],\n \"redemption\": []\n },\n \"relationships\": null,\n \"offer\": {\n \"boltOn\": null,\n \"continuity\": null,\n \"offerType\": \"FIXED_AMOUNT_OFF_BASKET\",\n \"qualification\": {\n \"basket\": {\n \"minimumBasketSpend\": 1000,\n \"minimumUnits\": null\n },\n \"locations\": {\n \"instore\": {\n \"excluded\": {\n \"locationTags\": null\n },\n \"included\": {\n \"locationTags\": null\n }\n }\n },\n \"product\": null\n },\n \"reward\": {\n \"basket\": null,\n \"product\": null,\n \"standard\": {\n \"points\": null,\n \"tax\": null,\n \"value\": {\n \"discountAmount\": 100,\n \"percentageAmount\": null\n }\n }\n }\n },\n \"version\": 2\n}" }, "url": { "raw": "{{url}}/campaigns", "host": [ "{{url}}" ], "path": [ "campaigns" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Get Single Campaign", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " const json = pm.response.json();", " pm.environment.set('campaignId', json.id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/campaigns/{{campaignId}}", "host": [ "{{url}}" ], "path": [ "campaigns", "{{campaignId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Update Campaign", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " const json = pm.response.json();", " pm.environment.set('campaignId', json.id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PATCH", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"id\": {{campaignId}},\n \"details\": {\n \"name\": \"Updated TESTING HYDRA and POSTMAN\",\n \"alternativeName\": \"Updated Alternative Name \",\n \"description\": \"Description\",\n \"alternativeDescription\": \"Updated Alternative Description\",\n \"tags\": [\"tag1\", \"tag2\"]\n }\n}\n" }, "url": { "raw": "{{url}}/campaigns/{{campaignId}}", "host": [ "{{url}}" ], "path": [ "campaigns", "{{campaignId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Replace Campaign", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " const json = pm.response.json();", " pm.environment.set('campaignId', json.id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"id\": {{campaignId}},\n \"details\": {\n \"name\": \"Updated TESTING HYDRA and POSTMAN\",\n \"alternativeName\": \"Updated Alternative Name \",\n \"description\": \"Description\",\n \"alternativeDescription\": \"Updated Alternative Description\",\n \"tags\": [\"tag1\", \"tag2\"]\n }\n}\n" }, "url": { "raw": "{{url}}/campaigns/{{campaignId}}", "host": [ "{{url}}" ], "path": [ "campaigns", "{{campaignId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Delete Campaign", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 204\", function () {", " pm.response.to.have.status(204);", "});", "", "if (pm.response.code === 204) {", " pm.environment.unset('campaignId');", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/campaigns/{{campaignId}}", "host": [ "{{url}}" ], "path": [ "campaigns", "{{campaignId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Validate Campaign Payload", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"DISCOUNT_BASKET\",\n \"status\": \"ACTIVE\",\n \"class\": \"COUPON\",\n \"details\": {\n \"name\": \"Campaign Name\",\n \"alternativeName\": \"\",\n \"description\": \"\",\n \"alternativeDescription\": \"\",\n \"printerMessage\": \"\",\n \"screenMessage\": null,\n \"tags\": [],\n \"startDate\": \"2019-01-09T00:00:00+00:00\",\n \"endDate\": \"2029-01-24T23:59:00+00:00\",\n \"mode\": \"OPEN\"\n },\n \"settings\": {\n \"tokenProvider\": null,\n \"tokenFormat\": null,\n \"walletEnabled\": true,\n \"issuanceMethod\": null,\n \"accountClientType\": null,\n \"defaultAccountClientState\": null\n },\n \"partners\": {\n \"creation\": [],\n \"redemption\": [\n {\n \"redemptionLimit\": null,\n \"partner\": \"1234\"\n }\n ]\n },\n \"rules\": {\n \"creation\": {\n \"campaignLimit\": null,\n \"consumerLimit\": null,\n \"consumerLimitActive\": 1,\n \"consumerLimitPerPeriod\": null\n },\n \"verification\": {\n \"lock\": false\n },\n \"redemption\": {\n \"maxRedemptionsPerPeriod\": null,\n \"campaignLimit\": null,\n \"couponLimit\": 1,\n \"allowOverride\": true,\n \"allowAccountOverride\": null,\n \"maximumPerTransaction\": null,\n \"maximumPerTransactionPerCampaignTypeCode\": null,\n \"maximumAccountUsage\": 1\n },\n \"locations\": null,\n \"expiry\": {\n \"type\": \"CAMPAIGN_END\",\n \"valueType\": null,\n \"value\": null,\n \"date\": null\n }\n },\n \"windows\": {\n \"creation\": [],\n \"redemption\": []\n },\n \"relationships\": null,\n \"offer\": {\n \"boltOn\": null,\n \"continuity\": null,\n \"offerType\": \"FIXED_AMOUNT_OFF_BASKET\",\n \"qualification\": {\n \"basket\": {\n \"minimumBasketSpend\": 1000,\n \"minimumUnits\": null\n },\n \"locations\": {\n \"instore\": {\n \"excluded\": {\n \"locationTags\": null\n },\n \"included\": {\n \"locationTags\": null\n }\n }\n },\n \"product\": null\n },\n \"reward\": {\n \"basket\": null,\n \"product\": null,\n \"standard\": {\n \"points\": null,\n \"tax\": null,\n \"value\": {\n \"discountAmount\": 100,\n \"percentageAmount\": null\n }\n }\n }\n },\n \"version\": 2\n}" }, "url": { "raw": "{{url}}/campaigns/validate", "host": [ "{{url}}" ], "path": [ "campaigns", "validate" ] }, "description": "Search campaigns" }, "response": [] } ] }, { "name": "Programmes", "item": [ { "name": "Get Programmes", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " const json = pm.response.json();", " pm.environment.set('programmeId', json.results[0].id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/programmes", "host": [ "{{url}}" ], "path": [ "programmes" ] }, "description": "Get all programmes" }, "response": [] }, { "name": "Get Single Programme", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " const json = pm.response.json();", " pm.environment.set('programmeId', json.id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/programmes/{{programmeId}}", "host": [ "{{url}}" ], "path": [ "programmes", "{{programmeId}}" ] }, "description": "Search a single programme" }, "response": [] }, { "name": "Create Programme", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " pm.environment.set('programmeId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VOUCHER\",\n \"status\": \"ACTIVE\",\n \"details\": {\n \"name\": \"Test Voucher Programme\",\n \"description\": \"\",\n \"startDate\": \"2025-05-09 00:00:00\",\n \"endDate\": \"2040-06-30 23:59:59\",\n \"tags\": []\n },\n \"settings\": {\n \"tokenProvider\": \"StoredValue\",\n \"tokenFormat\": \"000030325\",\n \"cardNumber\": {\n \"bin\": 0,\n \"scheme\": 0\n },\n \"accountClientType\": \"VOUCHER\",\n \"defaultAccountClientState\": \"LOADED\",\n \"passphrase\": false,\n \"refreshToken\": true,\n \"currency\": \"GBP\"\n },\n \"partners\": {\n \"creation\": [],\n \"redemption\": []\n },\n \"rules\": {\n \"expiry\": {\n \"type\": \"NEVER\",\n \"date\": null,\n \"value\": null\n },\n \"balances\": {\n \"maxBalance\": 50000,\n \"minLoadAmount\": 500,\n \"maxLoadAmount\": 50000,\n \"maxDebitAmount\": 10000\n },\n \"redemption\": {\n \"couponLimit\": 0\n }\n }\n}" }, "url": { "raw": "{{url}}/programmes", "host": [ "{{url}}" ], "path": [ "programmes" ] }, "description": "Create a new programme" }, "response": [] }, { "name": "Replace Programme", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " const json = pm.response.json();", " pm.environment.set('programmeId', json.id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"VOUCHER\",\n \"status\": \"ACTIVE\",\n \"details\": {\n \"name\": \"Test Voucher Programme\",\n \"description\": \"\",\n \"startDate\": \"2025-05-09 00:00:00\",\n \"endDate\": \"2035-12-31 23:59:59\",\n \"tags\": []\n },\n \"settings\": {\n \"tokenProvider\": \"StoredValue\",\n \"tokenFormat\": \"000030325\",\n \"cardNumber\": {\n \"bin\": 0,\n \"scheme\": 0\n },\n \"accountClientType\": \"VOUCHER\",\n \"defaultAccountClientState\": \"LOADED\",\n \"passphrase\": false,\n \"refreshToken\": true,\n \"currency\": \"GBP\"\n },\n \"partners\": {\n \"creation\": [],\n \"redemption\": []\n },\n \"rules\": {\n \"expiry\": {\n \"type\": \"NEVER\",\n \"date\": null,\n \"value\": null\n },\n \"balances\": {\n \"maxBalance\": 75000,\n \"minLoadAmount\": 500,\n \"maxLoadAmount\": 50000,\n \"maxDebitAmount\": 10000\n },\n \"redemption\": {\n \"couponLimit\": 0\n },\n \"storeRestrictions\": []\n }\n}" }, "url": { "raw": "{{url}}/programmes/{{programmeId}}", "host": [ "{{url}}" ], "path": [ "programmes", "{{programmeId}}" ] }, "description": "Replace an existing program" }, "response": [] }, { "name": "Delete Programme", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.unset('programmeId');", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{url}}/programmes/{{programmeId}}", "host": [ "{{url}}" ], "path": [ "programmes", "{{programmeId}}" ] }, "description": "Delete an existing program" }, "response": [] } ] }, { "name": "Schemes", "item": [ { "name": "Get all Schemes", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('schemeId', pm.response.json().results[0].id);", " pm.environment.set('reference', pm.response.json().results[0].reference);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/schemes/points", "host": [ "{{url}}" ], "path": [ "schemes", "points" ] } }, "response": [] }, { "name": "Get By Id", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/schemes/points/{{schemeId}}", "host": [ "{{url}}" ], "path": [ "schemes", "points", "{{schemeId}}" ] } }, "response": [] }, { "name": "Create Scheme", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "pm.environment.set('uniqueReference', pm.variables.replaceIn(\"{{$guid}}\"));", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('schemeId', pm.response.json().id);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"LOYALTY\",\n \"accountClientType\": \"RETAILPOINTS\",\n \"status\": \"ACTIVE\",\n \"class\": \"POINTS\",\n \"reference\": \"{{uniqueReference}}\",\n \"details\": {\n \"name\": \"Retail Points\",\n \"alternativeName\": \"\",\n \"description\": \"\",\n \"alternativeDescription\": \"\",\n \"printerMessage\": \"\",\n \"screenMessage\": \"\",\n \"tags\": null,\n \"startDate\": \"2023-01-01T00:00:00+00:00\",\n \"endDate\": \"9999-12-30T23:59:00+00:00\",\n \"mode\": \"OPEN\"\n },\n \"relationships\": [],\n \"services\": {\n \"autoTopup\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"credit\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"debit\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"goodwill\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": [\n {\n \"period\": 0,\n \"metric\": \"SECONDS\",\n \"transactions\": 0,\n \"value\": 0,\n \"singleValue\": 0\n }\n ]\n },\n \"spend\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"earn\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"exchange\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"gift\": {\n \"outgoingGiftLimit\": {\n \"enabled\": true,\n \"rule\": {\n \"periodCount\": 1,\n \"periodType\": \"DAY\",\n \"points\": 10000,\n \"rounding\": \"ABSOLUTE\"\n }\n },\n \"incomingGiftLimit\": {\n \"enabled\": true,\n \"rule\": {\n \"graceTransaction\": false,\n \"periodCount\": 1,\n \"periodType\": \"DAY\",\n \"points\": 1,\n \"rounding\": \"ABSOLUTE\"\n }\n }\n },\n \"expiryPoints\": {\n \"enabled\": false\n }\n },\n \"rates\": {\n \"redemption\": null,\n \"earn\": null,\n \"burn\": null\n },\n \"rules\": {\n \"creation\": {\n \"schemeLimit\": null,\n \"consumerLimit\": null\n }\n },\n \"timeoutOverride\": null,\n \"custom\": null,\n \"negativeBalance\": {\n \"enabled\": true,\n \"autoTopUpFunds\": null\n },\n \"autoReduce\": {\n \"exceed\": false,\n \"limit\": null,\n \"autoReduceFunds\": []\n },\n \"householdSharing\": {\n \"enabled\": true\n },\n \"tiers\": {\n \"enabled\": false\n },\n \"version\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/schemes/points", "host": [ "{{url}}" ], "path": [ "schemes", "points" ] } }, "response": [] }, { "name": "Update By Id", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "pm.environment.set('uniqueReference', pm.variables.replaceIn(\"{{$guid}}\"));", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"LOYALTY\",\n \"accountClientType\": \"RETAILPOINTS\",\n \"status\": \"ACTIVE\",\n \"class\": \"POINTS\",\n \"details\": {\n \"name\": \"Retail Points\",\n \"alternativeName\": \"\",\n \"description\": \"\",\n \"alternativeDescription\": \"\",\n \"printerMessage\": \"\",\n \"screenMessage\": \"\",\n \"tags\": null,\n \"startDate\": \"2023-01-01T00:00:00+00:00\",\n \"endDate\": \"9999-12-30T23:59:00+00:00\",\n \"mode\": \"OPEN\"\n },\n \"relationships\": [],\n \"services\": {\n \"autoTopup\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"credit\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"debit\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"goodwill\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": [\n {\n \"period\": 0,\n \"metric\": \"SECONDS\",\n \"transactions\": 0,\n \"value\": 0,\n \"singleValue\": 0\n }\n ]\n },\n \"spend\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"earn\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"exchange\": {\n \"enabled\": false,\n \"defaultFunding\": null,\n \"reasons\": null,\n \"restrictions\": []\n },\n \"gift\": {\n \"outgoingGiftLimit\": {\n \"enabled\": true,\n \"rule\": {\n \"periodCount\": 1,\n \"periodType\": \"DAY\",\n \"points\": 10000,\n \"rounding\": \"ABSOLUTE\"\n }\n },\n \"incomingGiftLimit\": {\n \"enabled\": true,\n \"rule\": {\n \"graceTransaction\": false,\n \"periodCount\": 1,\n \"periodType\": \"DAY\",\n \"points\": 1,\n \"rounding\": \"ABSOLUTE\"\n }\n }\n },\n \"expiryPoints\": {\n \"enabled\": false\n }\n },\n \"rates\": {\n \"redemption\": null,\n \"earn\": null,\n \"burn\": null\n },\n \"rules\": {\n \"creation\": {\n \"schemeLimit\": null,\n \"consumerLimit\": null\n }\n },\n \"timeoutOverride\": null,\n \"custom\": null,\n \"negativeBalance\": {\n \"enabled\": true,\n \"autoTopUpFunds\": null\n },\n \"autoReduce\": {\n \"exceed\": false,\n \"limit\": null,\n \"autoReduceFunds\": []\n },\n \"householdSharing\": {\n \"enabled\": true\n },\n \"tiers\": {\n \"enabled\": false\n },\n \"version\": 2\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/schemes/points/{{schemeId}}", "host": [ "{{url}}" ], "path": [ "schemes", "points", "{{schemeId}}" ] } }, "response": [] } ] }, { "name": "Reward Banks", "item": [ { "name": "Get Reward Banks", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('rewardBankId', pm.response.json().results[0].pointsRewardBankId);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/banks/pointsreward", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Get Single Reward Bank", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Update Reward Bank By Id", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PATCH", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"FooBar\",\n \"mode\": \"PUBLIC\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Delete Reward Bank", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 204\", function () {", " pm.response.to.have.status(204);", "});", "", "if (pm.response.code === 204) {", " pm.environment.unset('rewardBankId');", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Get Rewards in a Reward Bank", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('rewardBankRewardId', pm.response.json().results[0].pointsRewardBankRewardId);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}/rewards", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}", "rewards" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Create Reward in Existing Bank", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('rewardBankRewardId', pm.response.json().results[0].pointsRewardBankRewardId);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"resourceType\": \"CAMPAIGN\",\n \"resourceId\": \"{{campaignId}}\",\n \"cost\": 100,\n \"status\": \"ACTIVE\"\n }\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}/rewards", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}", "rewards" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Get Single Reward in a Reward Bank", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}/rewards/{{rewardBankRewardId}}", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}", "rewards", "{{rewardBankRewardId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Update a Single Reward in a Reward Bank", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PATCH", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cost\": 100,\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}/rewards/{{rewardBankRewardId}}", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}", "rewards", "{{rewardBankRewardId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Update a Single Reward in a Reward Bank Copy", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/banks/pointsreward/{{rewardBankId}}/rewards/{{rewardBankRewardId}}", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward", "{{rewardBankId}}", "rewards", "{{rewardBankRewardId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Create a Reward Bank with Rewards", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "pm.environment.set('uniqueReference', pm.variables.replaceIn(\"{{$guid}}\"));", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "", "if (pm.response.code === 201) {", " pm.environment.set('rewardBankId', pm.response.json().pointsRewardBankId); ", " pm.environment.set('rewardBankRewardId', pm.response.json().rewards[0].pointsRewardBankRewardId);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"PUBLIC\",\n \"status\": \"ACTIVE\",\n \"name\": \"Rewards\",\n \"reference\": \"{{uniqueReference}}\",\n \"rewards\": [\n {\n \"resourceType\": \"CAMPAIGN\",\n \"resourceId\": \"{{campaignId}}\",\n \"cost\": 1000,\n \"status\": \"ACTIVE\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/banks/pointsreward", "host": [ "{{url}}" ], "path": [ "banks", "pointsreward" ] }, "description": "Search campaigns" }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Inventory Lists", "item": [ { "name": "Get All Inventory Lists", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('inventoryListId', pm.response.json().results[0].inventoryListId);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/inventoryLists", "host": [ "{{url}}" ], "path": [ "inventoryLists" ] } }, "response": [] }, { "name": "Create Inventory Lists", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('inventoryListId', pm.response.json().results[0].inventoryListId);", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"productsLocationIdentifier\": \"{{incomingIdentifier}}\",\n \"type\": \"EXCLUDE\",\n \"status\": \"ACTIVE\",\n \"name\": \"FooBar\",\n \"description\": \"BazBat\",\n \"collections\": [\n {\n \"locations\": {\n \"excluded\": {\n \"locationIdentifiers\": [],\n \"locationTags\": []\n }\n },\n \"products\": {\n \"allRequired\": false,\n \"excluded\": {\n \"groups\": {\n \"{{locationIdentifier}}\": [\n \"12\"\n ]\n },\n \"tags\": [],\n \"items\": [\n \"245881\",\n \"245884\"\n ]\n }\n }\n }\n ],\n \"prerequisites\": {\n \"campaigns\": {\n \"campaignTypes\": [\n \"DISCOUNT_PRODUCTS\"\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/inventoryLists", "host": [ "{{url}}" ], "path": [ "inventoryLists" ] } }, "response": [] }, { "name": "Get Single Inventory List", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/inventoryLists/{{inventoryListId}}", "host": [ "{{url}}" ], "path": [ "inventoryLists", "{{inventoryListId}}" ] } }, "response": [] }, { "name": "Create an Inventory List", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\r\n \"productsLocationIdentifier\": \"{{incomingIdentifier}}\",\r\n \"type\": \"EXCLUDE\",\r\n \"status\": \"ACTIVE\",\r\n \"name\": \"FooBar\",\r\n \"description\": \"BazBat\",\r\n \"collections\": [\r\n {\r\n \"locations\": {\r\n \"excluded\": {\r\n \"locationIdentifiers\": [],\r\n \"locationTags\": []\r\n }\r\n },\r\n \"products\": {\r\n \"allRequired\": false,\r\n \"excluded\": {\r\n \"groups\": {\r\n \"{{locationIdentifier}}\": [\r\n \"12\"\r\n ]\r\n },\r\n \"tags\": [],\r\n \"items\": [\r\n \"245881\",\r\n \"245884\"\r\n ]\r\n }\r\n }\r\n }\r\n ],\r\n \"prerequisites\": {\r\n \"campaigns\": {\r\n \"campaignTypes\": [\r\n \"DISCOUNT_PRODUCTS\"\r\n ]\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/inventoryLists/{{inventoryListId}}", "host": [ "{{url}}" ], "path": [ "inventoryLists", "{{inventoryListId}}" ] } }, "response": [] }, { "name": "Delete an Inventory List", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 204\", function () {", " pm.response.to.have.status(204);", "});", "", "if (pm.response.code === 204) {", " pm.environment.unset('inventoryListId');", "}" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "DELETE", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/inventoryLists/{{inventoryListId}}", "host": [ "{{url}}" ], "path": [ "inventoryLists", "{{inventoryListId}}" ] } }, "response": [] } ] }, { "name": "Product Inventory", "item": [ { "name": "Get Product Group by Partner Identifier", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/inventory?groupReference={{groupReference}}&parentIncomingIdentifier={{parentIncomingIdentifier}}", "host": [ "{{url}}" ], "path": [ "inventory" ], "query": [ { "key": "groupReference", "value": "{{groupReference}}" }, { "key": "parentIncomingIdentifier", "value": "{{parentIncomingIdentifier}}" } ] }, "description": "Campaigns" }, "response": [] }, { "name": "Get Product by UPC", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/inventory?upc={{upc}}&parentIncomingIdentifier={{parentIncomingIdentifier}}", "host": [ "{{url}}" ], "path": [ "inventory" ], "query": [ { "key": "upc", "value": "{{upc}}" }, { "key": "parentIncomingIdentifier", "value": "{{parentIncomingIdentifier}}" } ] }, "description": "Campaigns" }, "response": [] }, { "name": "Get Products by Product Tag", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/inventory?parentIncomingIdentifier={{parentIncomingIdentifier}}&tag[]={{productTag}}&matchAll=true", "host": [ "{{url}}" ], "path": [ "inventory" ], "query": [ { "key": "parentIncomingIdentifier", "value": "{{parentIncomingIdentifier}}" }, { "key": "tag[]", "value": "{{productTag}}" }, { "key": "matchAll", "value": "true" } ] }, "description": "Campaigns" }, "response": [] }, { "name": "Search for Product by Name", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/inventory?parentIncomingIdentifier={{parentIncomingIdentifier}}&name={{name}}", "host": [ "{{url}}" ], "path": [ "inventory" ], "query": [ { "key": "parentIncomingIdentifier", "value": "{{parentIncomingIdentifier}}" }, { "key": "name", "value": "{{name}}" } ] }, "description": "Campaigns" }, "response": [] } ] }, { "name": "Token Formats", "item": [ { "name": "Get Token Formats", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('tokenFormatId', pm.response.json().results[0].id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/tokenFormats", "host": [ "{{url}}" ], "path": [ "tokenFormats" ] } }, "response": [] }, { "name": "Get Single Token Format", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('tokenFormatId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/tokenFormats/{{tokenFormatId}}", "host": [ "{{url}}" ], "path": [ "tokenFormats", "{{tokenFormatId}}" ] } }, "response": [] }, { "name": "Create Token Format", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " pm.environment.set('tokenFormatId', pm.response.json().results[0].id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"10 digit numeric\",\n \"details\": {\n \"checksum\": false,\n \"format\": \"##########\",\n \"length\": \"10\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/tokenFormats", "host": [ "{{url}}" ], "path": [ "tokenFormats" ] } }, "response": [] } ] }, { "name": "Units", "item": [ { "name": "Wallet Config", "item": [ { "name": "Create Identity Type", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " pm.environment.set('identityTypeId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"name\": \"APPID\",\n\t\"configuration\": {\n\t\t\"defaultState\": {\n\t\t\t\"value\": \"EARNONLY\"\n\t\t},\n\t\t\"defaultStatus\": {\n\t\t\t\"value\": \"ACTIVE\"\n\t\t}\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/units/{{unitId}}/walletConfig/identityTypes", "host": [ "{{url}}" ], "path": [ "units", "{{unitId}}", "walletConfig", "identityTypes" ] }, "description": "Create a new wallet identity type" }, "response": [] }, { "name": "Replace Identity Type", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('identityTypeId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"name\": \"APPID\",\n\t\"configuration\": {\n\t\t\"defaultState\": {\n\t\t\t\"value\": \"EARNONLY\"\n\t\t},\n\t\t\"defaultStatus\": {\n\t\t\t\"value\": \"ACTIVE\"\n\t\t}\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/units/{{unitId}}/walletConfig/identityTypes/{{identityTypeId}}", "host": [ "{{url}}" ], "path": [ "units", "{{unitId}}", "walletConfig", "identityTypes", "{{identityTypeId}}" ] }, "description": "Replace an existing identity type" }, "response": [] }, { "name": "Create Wallet Type", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " pm.environment.set('walletTypeId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"HOUSEHOLD\",\n \"configuration\": {\n \"allowMerge\": {\n \"value\": false\n },\n \"defaultAccountState\": {\n \"value\": \"LOADED\"\n },\n \"defaultConsumerType\": {\n \"value\": \"INDIVIDUAL\"\n },\n \"defaultState\": {\n \"value\": \"DEFAULT\"\n },\n \"defaultStatus\": {\n \"value\": \"ACTIVE\"\n },\n \"maxChild\": {\n \"value\": 0\n },\n \"maxParent\": {\n \"value\": 5\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/units/{{unitId}}/walletConfig/walletTypes", "host": [ "{{url}}" ], "path": [ "units", "{{unitId}}", "walletConfig", "walletTypes" ] }, "description": "Create a new wallet type" }, "response": [] }, { "name": "Replace Wallet Type", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('walletTypeId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"HOUSEHOLD\",\n \"configuration\": {\n \"allowMerge\": {\n \"value\": false\n },\n \"defaultAccountState\": {\n \"value\": \"LOADED\"\n },\n \"defaultConsumerType\": {\n \"value\": \"INDIVIDUAL\"\n },\n \"defaultState\": {\n \"value\": \"DEFAULT\"\n },\n \"defaultStatus\": {\n \"value\": \"ACTIVE\"\n },\n \"maxChild\": {\n \"value\": 0\n },\n \"maxParent\": {\n \"value\": 3\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/units/{{unitId}}/walletConfig/walletTypes/{{walletTypeId}}", "host": [ "{{url}}" ], "path": [ "units", "{{unitId}}", "walletConfig", "walletTypes", "{{walletTypeId}}" ] }, "description": "Replace a new wallet type" }, "response": [] } ] }, { "name": "Get Units", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('unitId', pm.response.json().results[0].id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/units", "host": [ "{{url}}" ], "path": [ "units" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Get Single Unit", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('unitId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/units/{{unitId}}", "host": [ "{{url}}" ], "path": [ "units", "{{unitId}}" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Create Company or Outlet Unit", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " pm.environment.set('unitId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Company Name\",\n \"parentUnitId\": \"{{unitId}}\",\n \"incomingIdentifier\": \"companyIncomingIdentifier\",\n \"type\": \"COMPANY\",\n \"status\": \"ACTIVE\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/units", "host": [ "{{url}}" ], "path": [ "units" ] }, "description": "Search campaigns" }, "response": [] }, { "name": "Create and Configure a Parent Unit", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " pm.environment.set('unitId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n\t\"name\": \"Company Name\",\n\t\"incomingIdentifier\": \"companyIncomingIdentifier\",\n\t\"tags\": [],\n\t\"timezones\": {\n\t\t\"default\": \"Europe/London\"\n\t},\n\t\"options\": {\n\t\t\"posConnect\": {\n\t\t\t\"mode\": \"CUSTOMERWINS\"\n\t\t},\n\t\t\"walletConfig\": {\n\t\t\t\"mode\": [\n\t\t\t\t\"CONSUMER\"\n\t\t\t]\n\t\t},\n\t\t\"tiers\": {\n\t\t\t\"enabled\": true,\n\t\t\t\"mode\": \"INDIVIDUAL\",\n\t\t\t\"baseEarn\": true\n\t\t}\n\t}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/services/units", "host": [ "{{url}}" ], "path": [ "services", "units" ] }, "description": "Create a new parent company tenant unit" }, "response": [] } ] }, { "name": "Tiers", "item": [ { "name": "Get Tiers", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('tierId', pm.response.json().results[0].id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/tiers", "host": [ "{{url}}" ], "path": [ "tiers" ] } }, "response": [] }, { "name": "Get Single Tier", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "", "// Set up any environment variables", "ee.setUrl('resourcesApi');", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('tierId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/tiers/{{tierId}}", "host": [ "{{url}}" ], "path": [ "tiers", "{{tierId}}" ] } }, "response": [] }, { "name": "Create Tier", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {", " pm.response.to.have.status(201);", "});", "", "if (pm.response.code === 201) {", " pm.environment.set('tierId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"STANDARD\",\n \"status\": \"ACTIVE\",\n \"reference\": \"BRONZE\",\n \"details\": {\n \"name\": \"Bronze\",\n \"schemeId\": \"{{schemeId}}\",\n \"isDefault\": true\n },\n \"settings\": {\n \"schemeOverrides\": null,\n \"promotion\": {\n \"promotionTierId\": \"{{promotionTierId}}\",\n \"ruleSets\": [\n {\n \"rules\": [\n {\n \"amount\": 3000,\n \"balanceType\": \"POINTS\"\n }\n ]\n }\n ]\n },\n \"demotion\": {\n \"demotionTierId\": null,\n \"balanceResetPeriod\": {\n \"periodOffset\": {\n \"periodType\": \"MONTH\",\n \"periods\": 6\n },\n \"roundingRule\": \"endOfMonth\"\n },\n \"membershipExpiryPeriod\": {\n \"periodOffset\": {\n \"periodType\": \"MONTH\",\n \"periods\": 6\n },\n \"roundingRule\": \"endOfMonth\"\n }\n }\n }\n} ", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/tiers", "host": [ "{{url}}" ], "path": [ "tiers" ] } }, "response": [] }, { "name": "Update Tier", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "if (pm.response.code === 200) {", " pm.environment.set('tierId', pm.response.json().id);", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "PUT", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"STANDARD\",\n \"status\": \"ACTIVE\",\n \"reference\": \"BRONZE\",\n \"details\": {\n \"name\": \"Bronze\",\n \"schemeId\": \"{{schemeId}}\",\n \"isDefault\": true\n },\n \"settings\": {\n \"schemeOverrides\": null,\n \"promotion\": {\n \"promotionTierId\": \"{{promotionTierId}}\",\n \"ruleSets\": [\n {\n \"rules\": [\n {\n \"amount\": 3000,\n \"balanceType\": \"POINTS\"\n }\n ]\n }\n ]\n },\n \"demotion\": {\n \"demotionTierId\": null,\n \"balanceResetPeriod\": {\n \"periodOffset\": {\n \"periodType\": \"MONTH\",\n \"periods\": 6\n },\n \"roundingRule\": \"endOfMonth\"\n },\n \"membershipExpiryPeriod\": {\n \"periodOffset\": {\n \"periodType\": \"MONTH\",\n \"periods\": 6\n },\n \"roundingRule\": \"endOfMonth\"\n }\n }\n }\n} ", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/tier/{{tierId}}", "host": [ "{{url}}" ], "path": [ "tier", "{{tierId}}" ] } }, "response": [] }, { "name": "Delete Tier", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 204\", function () {", " pm.response.to.have.status(204);", "});", "", "if (pm.response.code === 204) {", " pm.environment.unset('tierId');", "}", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "auth": { "type": "noauth" }, "method": "DELETE", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/tier/{{tierId}}", "host": [ "{{url}}" ], "path": [ "tier", "{{tierId}}" ] } }, "response": [] } ] }, { "name": "/health/status", "event": [ { "listen": "prerequest", "script": { "exec": [ "// Load global pre-request script object", "var ee = eval(pm.globals.get('ees'));", "ee.setUrl('resourcesApi');", "", "// Set up any environment variables", "", "// Call the global authentication function", "ee.auth();" ], "type": "text/javascript", "packages": {} } }, { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {", " pm.response.to.have.status(200);", "});", "", "pm.test(\"Status is Green\", function () {", " pm.expect(pm.response.json().summary.status).to.eql(\"GREEN\");", "});", "" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "GET", "header": [ { "key": "X-EES-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-EES-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "X-AUTH-HASH", "value": "{{xAuthHash}}" }, { "key": "X-AUTH-CLIENT-ID", "value": "{{xAuthClientId}}" }, { "key": "X-TRANSACTION-ID", "value": "{{xTransactionId}}" }, { "key": "X-RETRY", "value": "1" }, { "key": "X-EES-OPERATOR", "value": "1" }, { "key": "X-EES-CALLER", "value": "POSTMAN" }, { "key": "X-EES-CALLER-VERSION", "value": "0" }, { "key": "X-EES-MESSAGEID", "value": "03d476861afd384510f2cb80ccfa8511" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{url}}/health/status", "host": [ "{{url}}" ], "path": [ "health", "status" ] }, "description": "Get Wallet Accounts by Wallet ID" }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "requests": {}, "exec": [ "let CryptoJS = require('crypto-js');", "", "pm.globals.set('ees', function ees() {", " let ee = {};", " ee.url = function() {", " let url = pm.request.url.toString();", " return url.slice(url.indexOf('/')).replace(/{{(\\w*)}}/g, function(str, key) {", " return pm.variables.get(key);", " }).replace(/!/g, '%21');", " };", " ee.payload = function() {", " let payload = '';", " if ('undefined' !== typeof pm.request.body && 'undefined' !== typeof pm.request.body.raw) {", " payload = pm.request.body.raw;", " }", "", " if ('' === payload) {", " return '';", " }", " return payload.replace(/{{(\\w*)}}/g, function(str, key) {", " return pm.variables.get(key);", " });", " };", " ee.hash = function() {", " return CryptoJS.SHA256(", " ee.url() + ee.payload() + pm.variables.get('password')", " ).toString();", " };", " ee.transaction = function() {", " return CryptoJS.MD5(new Date().getTime().toString()).toString();", " };", " ee.setUrl = function(key) {", " if (pm.variables.has(key)) {", " pm.environment.set('url', pm.variables.get(key));", " }", " };", " ee.auth = function() {", " pm.variables.set('xAuthHash', ee.hash());", " pm.variables.set('xAuthClientId', pm.variables.get('username'));", " pm.variables.set('xTransactionId', ee.transaction());", " };", " ee.pad = function(str, len) {", " str.toString().padStart(len, '0');", " };", " ee.getCurrentAtomDateTime = function() {", " let now = new Date();", " return now.getUTCFullYear() +", " '-' + ee.pad((now.getUTCMonth() + 1), 2) +", " '-' + ee.pad(now.getUTCDate(), 2) +", " 'T' + ee.pad(now.getUTCHours(), 2) +", " ':' + ee.pad(now.getUTCMinutes(), 2) +", " ':' + ee.pad(now.getUTCSeconds(), 2) +", " '+' + ee.pad((now.getTimezoneOffset() / -60), 2) + ':00';", " };", " return ee;", "} + '; ees();');", "", "let ee = eval(pm.globals.get('ees'));", "ee.setUrl('walletApi');", "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } } ] }