{"info":{"_postman_id":"f342ddae-8c11-4466-a30f-9a2d888d95e5","name":"API Starter Pack","description":"

SessionM integrates marketing automation and data management capabilities with loyalty marketing to drive personalized customer relationships through the mobile device and across channels.

\n

Central to the SessionM Platform is its collection of REST APIs. Powered by JSON data over HTTP, the APIs support both server-to-server and client-to-server transactions. For the most part, the SessionM APIs are designed to submit customer-related data to the platform, performing a set of transactions on the data for a specific customer and returning the related results. The operations, or methods, available in each API utilize JSON requests to call a resource's URI and elicit a JSON response.

\n

These responses may confirm that some alteration has been made to the stored resource, and they may provide hypertext links to other related resources or collections of resources. Using HTTP, the kind of operations available include those predefined by the HTTP verbs GET, POST, PUT, DELETE.

\n

The platform is driven by rules that define customer actions and trigger outcomes for those actions; many are simple in nature, while others are more subtle and complex. A simple case would be a customer clicking an icon in an application and triggering the display of a message. A more complex case would be performing logical operations to express more complex rules, related to digital engagement, purchase or location data.

\n

These rule sets can be configured within the SessionM Platform via the web-based administrative tool or through a managed service by which SessionM staff handle all configuration work based on client requests.

\n

Prior to implementing any platform APIs, it is important to work with your account representatives to fully understand your desired workflow and outcomes, as these impact the data that is returned in the API responses.

\n

If you want to utilize an API for managing the transactions that occur via a Point of Sale system, see our POS API. Note that this API is not designed to be used in conjunction with the SessionM Platform APIs detailed on this site.

\n

For more information, see the other sections of this overview including:

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"39830773","collectionId":"f342ddae-8c11-4466-a30f-9a2d888d95e5","publishedId":"2sB2cbZdq1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-04-15T18:07:15.000Z"},"item":[{"name":"A Postman Journey: The Tale of Marcus Mastercardson","item":[],"id":"76045ba1-d629-4991-a68c-21a9f5e9c2a5","description":"

Throughout this documentation for the SessionM Postman Collection, you'll have the chance to understand our APIs in the context of how they deliver an online experience for a loyalty program member (customer/user). As the member acts and reacts within the program, a variety of SessionM APIs are invoked to ensure that the loyalty member's experience is rich and seamless. These interactions - including those that occur between APIs on the backend - are called out in the sections below as part of a narrative that describes how each stage of a journey for a loyalty program member occurs.

\n

With that in mind, meet Marcus Mastercardson...

\n\n\n

Marcus really enjoys Brand X. He spends a fair amount of money at X and would like to be rewarded for his spending by joining the loyalty program.

\n","_postman_id":"76045ba1-d629-4991-a68c-21a9f5e9c2a5"},{"name":"1. Loyalty Members","item":[{"name":"1.1 Customer Profile APIs","item":[{"name":"1.1.1 Create Standard Profile","event":[{"listen":"test","script":{"id":"8786f1a9-02b5-49f1-8af9-7814d589b516","exec":["var jsonData = JSON.parse(responseBody)","postman.setGlobalVariable(\"user_id\", jsonData.user.id);","postman.setGlobalVariable(\"external_id\", jsonData.user.external_id);","postman.setGlobalVariable(\"email\", jsonData.user.email);","postman.setGlobalVariable(\"dob\", jsonData.user.dob);","postman.setGlobalVariable(\"first_name\", jsonData.user.first_name);","postman.setGlobalVariable(\"last_name\", jsonData.user.last_name);","postman.setGlobalVariable(\"version\", 1);"],"type":"text/javascript","packages":{}}}],"id":"d761345c-5538-42ca-bce1-7bb11dd4f64b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\":\n {\n \"external_id\":\"MC-SESS-2025-XYZ\",\n \"opted_in\":\"true\",\n \"external_id_type\": \"merchant_identifier\",\n \"email\":\"mmastercarson@sessionm.com\",\n \"first_name\":\"Marcus\",\n \"last_name\":\"Mastercardson\",\n \"gender\":\"m\",\n \"dob\":\"1991-01-01\",\n \"address\":\"123 Fake St.\",\n \"city\":\"Anytown\",\n \"state\":\"MA\",\n \"zip\":\"02120\",\n \"country\":\"USA\",\n \"phone_numbers\":\n [{\n \"phone_number\": \"1112223333\",\n \"phone_type\": \"mobile\",\n \"preference_flags\": [\"primary\"]\n }],\n \"user_profile\": {\n \"partner\": [\n \"root\"\n ]\n }\n }\n}\n"},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users","description":"

Builds a new standard profile for a member. Provides the primary operation for adding a standard profile to the platform and specifying that member's characteristics.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"956804ba-53e5-486d-be09-d3814a81d786","name":"1.1.1 Create Standard Profile","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\":\n {\n \"external_id\":\"MC-SESS-2025-XYZ\",\n \"opted_in\":\"true\",\n \"external_id_type\": \"merchant_identifier\",\n \"email\":\"mmastercarson@sessionm.com\",\n \"first_name\":\"Marcus\",\n \"last_name\":\"Mastercardson\",\n \"gender\":\"m\",\n \"dob\":\"1991-01-01\",\n \"address\":\"123 Fake St.\",\n \"city\":\"Anytown\",\n \"state\":\"MA\",\n \"zip\":\"02120\",\n \"country\":\"USA\",\n \"phone_numbers\":\n [{\n \"phone_number\": \"1112223333\",\n \"phone_type\": \"mobile\",\n \"preference_flags\": [\"primary\"]\n }],\n \"user_profile\": {\n \"partner\": [\n \"root\"\n ]\n }\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Apr 2025 13:56:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1136"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"9f9e6f088f883aaf84483d68a150b08e\""},{"key":"X-Request-Id","value":"2118d0df-0474-4a86-99b7-430161c9ba00"},{"key":"X-Runtime","value":"0.470938"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"user\": {\n \"id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"external_id\": \"MC-SESS-2025-XYZ\",\n \"opted_in\": true,\n \"activated\": false,\n \"proxy_ids\": [],\n \"identifiers\": [\n {\n \"external_id\": \"MC-SESS-2025-XYZ\",\n \"external_id_type\": \"merchant_identifier\"\n }\n ],\n \"available_points\": 0,\n \"test_points\": 0,\n \"unclaimed_achievement_count\": 0,\n \"email\": \"mmastercarson@sessionm.com\",\n \"gender\": \"m\",\n \"dob\": \"1991-01-01\",\n \"created_at\": \"2025-04-08 13:56:39\",\n \"updated_at\": \"2025-04-08 13:56:39\",\n \"address\": \"123 Fake St.\",\n \"city\": \"Anytown\",\n \"zip\": \"02120\",\n \"dma\": \"506\",\n \"state\": \"MA\",\n \"country\": \"USA\",\n \"suspended\": false,\n \"last_name\": \"Mastercardson\",\n \"first_name\": \"Marcus\",\n \"registered_at\": \"2025-04-08 13:56:39\",\n \"profile_photo_url\": \"/images/account-neutral.png\",\n \"test_account\": false,\n \"account_status\": \"good\",\n \"referrer_code\": \"MARCUSM-FB1782-5C5EF9\",\n \"user_profile\": {\n \"_version\": 1,\n \"org\": [],\n \"favorite_activities\": [],\n \"interests\": [],\n \"preferred_channel\": [],\n \"cpg_brand_of_interest\": [],\n \"partner_type\": [],\n \"languages\": [],\n \"socioeconomic_status\": [],\n \"mcc\": [],\n \"partner\": [\n \"root\"\n ]\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"1112223333\",\n \"phone_type\": \"mobile\",\n \"preference_flags\": [\n \"primary\"\n ],\n \"verified_ownership\": false\n }\n ]\n }\n}"}],"_postman_id":"d761345c-5538-42ca-bce1-7bb11dd4f64b"},{"name":"1.1.2 Search for Customer Profile by Email","id":"0dd1e61a-0fd4-4893-a799-4fc43e06ee51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/search?email={{email}}","description":"

Searches for an existing standard customer profile by email address. Returns the specified profile with all of its associated attributes.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","search"],"host":["{{endpoint}}"],"query":[{"key":"email","value":"{{email}}"},{"disabled":true,"key":"user[user_profile]","value":"true"},{"disabled":true,"key":"expand_incentives","value":"true"},{"disabled":true,"key":"show_identifiers","value":"true"}],"variable":[]}},"response":[{"id":"5bf4d4d8-063f-4ed2-bfe1-584b1722fd77","name":"1.1.3 Search for Customer Profile by Email","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/search?email={{email}}","host":["{{endpoint}}"],"path":["priv","v1","apps","{{appkey}}","users","search"],"query":[{"key":"email","value":"{{email}}"},{"key":"user[user_profile]","value":"true","disabled":true},{"key":"expand_incentives","value":"true","disabled":true},{"key":"show_identifiers","value":"true","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Apr 2025 13:58:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"828"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"97c8198a48b134d6b1579f9b3c3ecaa9\""},{"key":"X-Request-Id","value":"08eb8d6c-b98a-4af8-a228-3188a4bb3016"},{"key":"X-Runtime","value":"0.121557"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"user\": {\n \"id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"external_id\": \"MC-SESS-2025-XYZ\",\n \"opted_in\": true,\n \"activated\": false,\n \"proxy_ids\": [],\n \"available_points\": 0,\n \"test_points\": 0,\n \"unclaimed_achievement_count\": 0,\n \"email\": \"mmastercarson@sessionm.com\",\n \"gender\": \"m\",\n \"dob\": \"1991-01-01\",\n \"created_at\": \"2025-04-08 13:56:39\",\n \"updated_at\": \"2025-04-08 13:57:25\",\n \"address\": \"123 Fake St.\",\n \"city\": \"Anytown\",\n \"zip\": \"02120\",\n \"dma\": \"506\",\n \"state\": \"MA\",\n \"country\": \"USA\",\n \"suspended\": false,\n \"last_name\": \"Mastercardson\",\n \"first_name\": \"Marcus\",\n \"registered_at\": \"2025-04-08 13:56:39\",\n \"profile_photo_url\": \"/images/account-neutral.png\",\n \"test_account\": false,\n \"account_status\": \"good\",\n \"referrer_code\": \"MARCUSM-FB1782-5C5EF9\",\n \"phone_numbers\": [\n {\n \"phone_number\": \"1112223333\",\n \"phone_type\": \"mobile\",\n \"preference_flags\": [\n \"primary\"\n ],\n \"verified_ownership\": false\n }\n ]\n }\n}"}],"_postman_id":"0dd1e61a-0fd4-4893-a799-4fc43e06ee51"},{"name":"1.1.3 Retrieve Full Customer Profile by User ID","id":"3cbc2714-7a91-4e95-8219-a29bffddf2ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}?show_identifiers=true&user[user_profile]=true&expand_incentives=true","description":"

Gets member's customer by SessionM internal user ID.

\n

For more information, this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}"],"host":["{{endpoint}}"],"query":[{"key":"show_identifiers","value":"true"},{"key":"user[user_profile]","value":"true"},{"key":"expand_incentives","value":"true"}],"variable":[]}},"response":[{"id":"3f04ee94-ecbe-4980-8b9a-9869ef52a88b","name":"1.1.4 Retrieve Full Customer Profile by User ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}?show_identifiers=true&user[user_profile]=true&expand_incentives=true","host":["{{endpoint}}"],"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}"],"query":[{"key":"show_identifiers","value":"true"},{"key":"user[user_profile]","value":"true"},{"key":"expand_incentives","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Apr 2025 13:59:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3170"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"18c70b83d46ab487fec210db4597f79f\""},{"key":"X-Request-Id","value":"61abb9ae-094b-4d36-9ceb-0372c1e6ac9b"},{"key":"X-Runtime","value":"0.148858"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"user\": {\n \"id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"external_id\": \"MC-SESS-2025-XYZ\",\n \"opted_in\": true,\n \"activated\": false,\n \"proxy_ids\": [],\n \"identifiers\": [\n {\n \"external_id\": \"MC-SESS-2025-XYZ\",\n \"external_id_type\": \"merchant_identifier\"\n }\n ],\n \"available_points\": 0,\n \"test_points\": 0,\n \"unclaimed_achievement_count\": 0,\n \"email\": \"mmastercarson@sessionm.com\",\n \"gender\": \"m\",\n \"dob\": \"1991-01-01\",\n \"created_at\": \"2025-04-08 13:56:39\",\n \"updated_at\": \"2025-04-08 13:57:25\",\n \"address\": \"123 Fake St.\",\n \"city\": \"Anytown\",\n \"zip\": \"02120\",\n \"dma\": \"506\",\n \"state\": \"MA\",\n \"country\": \"USA\",\n \"suspended\": false,\n \"last_name\": \"Mastercardson\",\n \"first_name\": \"Marcus\",\n \"registered_at\": \"2025-04-08 13:56:39\",\n \"profile_photo_url\": \"/images/account-neutral.png\",\n \"test_account\": false,\n \"account_status\": \"good\",\n \"tier_details\": {\n \"tier_levels\": [],\n \"point_account_balances\": {\n \"retailer_id\": \"e59fdc7e-2413-442e-8e38-077a2d150a5e\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"summary\": {\n \"total_points\": 0,\n \"life_time_points\": 0\n },\n \"details\": [\n {\n \"account_name\": \"[LSBX] BlueJay Miles - Spendable Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"42b3a88a-c116-40ed-b453-009336082b71\",\n \"grouping_label\": \"bluejay_miles_spend\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Partner Bank Spendable Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"72c4d0ce-d170-4357-afd4-046f4fc2564d\",\n \"grouping_label\": \"partner_bank\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"TQ Points\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"76df898a-b375-4d61-adeb-3594bac95f51\",\n \"grouping_label\": \"Tier\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Raffle Entry\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"b2deac4c-07f0-4719-b956-42aa9f476dec\",\n \"grouping_label\": \"\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"[LSBX] BlueJay Miles - Tier Points\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"1ea9866e-e794-4b4f-8950-4db2e184eda7\",\n \"grouping_label\": \"bluejay_miles_tier\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"[Gamification] Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"747a570f-1bd0-4860-9f55-540ba8f804a0\",\n \"grouping_label\": \"\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Spendable Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"f4d91345-bbe8-4ca7-864d-771761be873e\",\n \"grouping_label\": \"spendable_account\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"e-bidding Tickets\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"cb8a3ded-a0aa-4bba-b891-8706eb14560b\",\n \"grouping_label\": \"\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Tier Points\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"3d1c4e93-8b93-432f-a9c9-ab6854b57b7f\",\n \"grouping_label\": \"Tier\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n }\n ]\n }\n },\n \"referrer_code\": \"MARCUSM-FB1782-5C5EF9\",\n \"user_profile\": {\n \"_version\": 1,\n \"org\": [],\n \"favorite_activities\": [],\n \"interests\": [],\n \"preferred_channel\": [],\n \"cpg_brand_of_interest\": [],\n \"partner_type\": [],\n \"languages\": [],\n \"socioeconomic_status\": [],\n \"mcc\": [],\n \"partner\": [\n \"root\"\n ]\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"1112223333\",\n \"phone_type\": \"mobile\",\n \"preference_flags\": [\n \"primary\"\n ],\n \"verified_ownership\": false\n }\n ]\n }\n}"}],"_postman_id":"3cbc2714-7a91-4e95-8219-a29bffddf2ff"},{"name":"1.1.4 Update a Combined Standard/Custom Profile (User ID)","event":[{"listen":"test","script":{"id":"f826abba-dc7d-47f7-9b0e-3a17453a9862","exec":["var jsonData = JSON.parse(responseBody)","postman.setGlobalVariable(\"user_id\", jsonData.user.id);","postman.setGlobalVariable(\"external_id\", jsonData.user.external_id);","postman.setGlobalVariable(\"email\", jsonData.user.email);","postman.setGlobalVariable(\"dob\", jsonData.user.dob);","postman.setGlobalVariable(\"first_name\", jsonData.user.first_name);","postman.setGlobalVariable(\"last_name\", jsonData.user.last_name);",""],"type":"text/javascript"}}],"id":"97703237-4966-46c4-b3ea-90ffd3f74358","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\":{\n \"user_profile\":{\n \"allergens\":[\"nuts\", \"shellfish\"],\n \"preferred_language\":\"english\",\n \"clothes_size\": \"large\",\n \"home_store\": \"Boston-Seaport\",\n \"email_optin\": true\n }\n }\n}"},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}","description":"

Updates a member's customer profile with new standard and custom attributes. This method returns any unchanged existing standard data along with any changed data for both standard and custom attributes.

\n

For more information, this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"d28415e8-8f42-4ce7-945a-41398dd58bb4","name":"1.1.5 Update a Combined Standard/Custom Profile (User ID)","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user\":{\n \"user_profile\":{\n \"allergens\":[\"nuts\", \"shellfish\"],\n \"preferred_language\":\"english\",\n \"clothes_size\": \"large\",\n \"home_store\": \"Boston-Seaport\",\n \"email_optin\": true\n }\n }\n}"},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 08 Apr 2025 14:23:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1180"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"9e0f443e7d3fe59fb723ff8e824407e6\""},{"key":"X-Request-Id","value":"4620d9e8-1d4b-430f-b3b6-52dec33b6401"},{"key":"X-Runtime","value":"0.972171"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"user\": {\n \"id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"external_id\": \"MC-SESS-2025-XYZ\",\n \"opted_in\": true,\n \"activated\": false,\n \"proxy_ids\": [],\n \"available_points\": 0,\n \"test_points\": 0,\n \"unclaimed_achievement_count\": 0,\n \"email\": \"mmastercarson@sessionm.com\",\n \"gender\": \"m\",\n \"dob\": \"1991-01-01\",\n \"created_at\": \"2025-04-08 13:56:39\",\n \"updated_at\": \"2025-04-08 13:57:25\",\n \"address\": \"123 Fake St.\",\n \"city\": \"Anytown\",\n \"zip\": \"02120\",\n \"dma\": \"506\",\n \"state\": \"MA\",\n \"country\": \"USA\",\n \"suspended\": false,\n \"last_name\": \"Mastercardson\",\n \"first_name\": \"Marcus\",\n \"registered_at\": \"2025-04-08 13:56:39\",\n \"profile_photo_url\": \"/images/account-neutral.png\",\n \"test_account\": false,\n \"account_status\": \"good\",\n \"referrer_code\": \"MARCUSM-FB1782-5C5EF9\",\n \"user_profile\": {\n \"_version\": 2,\n \"org\": [],\n \"favorite_activities\": [],\n \"interests\": [],\n \"clothes_size\": \"large\",\n \"preferred_channel\": [],\n \"cpg_brand_of_interest\": [],\n \"partner_type\": [],\n \"languages\": [],\n \"socioeconomic_status\": [],\n \"mcc\": [],\n \"partner\": [\n \"root\"\n ],\n \"allergens\": [\n \"nuts\",\n \"shellfish\"\n ],\n \"preferred_language\": \"english\",\n \"home_store\": \"Boston-Seaport\",\n \"email_optin\": true\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"1112223333\",\n \"phone_type\": \"mobile\",\n \"preference_flags\": [\n \"primary\"\n ],\n \"verified_ownership\": false\n }\n ]\n }\n}"}],"_postman_id":"97703237-4966-46c4-b3ea-90ffd3f74358"}],"id":"7c93381f-6670-420a-9452-cb200c145b1b","description":"

The SessionM Platform represents loyalty member (customer) data with profile objects. A profile is a template for creating members in the system. Each instance of a profile expresses data defined for a specific member.

\n

Profile services provide a variety of methods for managing both standard and custom profiles for members. Standard profiles contain basic demographic data about the member that is pre-configured in the platform. For example, the member's name and gender. Custom profiles, however, contain custom attributes that reflect the unique characteristics of an organization's members. Often these attributes express information that can be leveraged for promotional campaign targeting. For example, while an adult member's date of birth (dob) is a standard profile attribute that can be used to sell merchandise to the member, it isn't very useful to a promotion (campaign) targeting ice cream lovers. Such a promotion would benefit instead from a member profile attribute that captures the member's favorite ice cream flavor (chocolate_lover).

\n

Note: In most cases, these APIs are not intended for integrations with point-of-sale systems. For specific point-of-sale APIs that are designed for the management of member profiles, please see the SessionM POS API documentation.

\n

For more information, see this overview.

\n

Postman Journey: Marcus Becomes a Member and Brand X Wants Personalize His Experience

\n

After Marcus provides his personal information, Brand X's website sends a request to the SessionM profile creation API to store Marcus's information and enroll him into the loyalty program.

\n

Once Signed up, on the new member page, Brand X wants to know a bit more about Marcus to correctly target him for new promotions. After capturing additional information about his preferences and personal information, Brand X's website sends an update profile request to SessionM to update Marcus's user profile with the additional information for targeting and segmentation purposes.

\n

Postman Journey: Searching for and Retrieving Marcus

\n

Brand X recently released a mobile application. After downloading it, Marcus goes to log in and realizes he has forgotten his login credentials. Happens to the best of us.

\n

Marcus is instructed to specify the information required to locate his credentials, entering his email address to find his profile. The application backend sends a search request to SessionM with the email address to see if Marcus has an existing loyalty profile.

\n

Marcus logs into the Brand X and triggers the application to present him with the relevant personal data and preferences. The application backend calls the SessionM API that retrieves a combined standard and custom profile using Marcus's user identifier, which gets his full profile along with loyalty details and status.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b38bada8-1ca8-4b47-8ff7-7d93e07cec7e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d4ca54f6-0619-4841-a282-7b7a998cdd2b"}}],"_postman_id":"7c93381f-6670-420a-9452-cb200c145b1b"},{"name":"1.2 Customer Accounts Merge APIs","item":[{"name":"1.2.1 Merge Customer Accounts","id":"797bbe45-e594-4a1a-aa99-ada539348303","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"merge_account\":\n {\n \"external_id\": \"{{victim_external_id}}\"\n }\n}"},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/external/users/{{survivor_external_id}}/merge_accounts","description":"

Merges one customer account into another customer account. Bear in mind that the ability to undo a merge is currently NOT supported.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","external","users","{{survivor_external_id}}","merge_accounts"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"797bbe45-e594-4a1a-aa99-ada539348303"},{"name":"1.2.2 Retrieve Merge Information","id":"091110ca-4d7d-42a9-a36d-c45af40f677f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/external/users/{{survivor_external_id}}/merge_accounts/{{merge_account_id}}","description":"

Fetches the merge entry, with its information, for the customer accounts merge.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","external","users","{{survivor_external_id}}","merge_accounts","{{merge_account_id}}"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"091110ca-4d7d-42a9-a36d-c45af40f677f"}],"id":"17a2162c-bc8f-45b3-9a41-a206d1b3db86","description":"

This API allows you to merge member accounts as well as retrieve merge entry information after the merge. Often necessary when external users being added to the SessionM Platform have existing profile data that must be merged with the newly created, internal profile on the platform. Merging profiles presumes two types of customer profiles exist: the survivor, or primary, profile and the victim, or merged, profile. When the merge completes successfully, the victim profile is considered deleted. The profile is not returned by any queries, although it does technically still exist in the database.

\n

Strategies for what profile content is actually merged can be determined by each organization. By default, point balances, tier points (not incentive tiers), transfer transactions, external IDs, and re-process events are all merged data. However, there are other options, including event stream events for transfers.

\n

For more information, see this discussion.

\n

Postman Journey: One Profile is More than Enough

\n

Due to an outdated email address given during signup, Marcus ended up with two loyalty profiles. He has transacted under both profiles and wants to combine them into a single profile so he can consolidate his rewards and continue transacting with Brand X. To facilitate this, the Brand X system calls the SessionM API that merges both profile identifiers associated with Marcus. Once complete, his transaction history - along with any current offers and profile data - are combined and stored under a single profile.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"d2678bfd-b064-4eff-963d-faab648fc11d"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1f7bbea9-f20e-4121-991a-9cd44057609d"}}],"_postman_id":"17a2162c-bc8f-45b3-9a41-a206d1b3db86"},{"name":"1.3 Events APIs","item":[{"name":"1.3.1 Create Event for Customer by User ID (Simple)","id":"a083c409-d10e-457f-8f3e-b52a78170f09","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"events\": {\n \"name\": \"survey_completed\",\n \"by\": \"1\",\n \"user_id\": \"{{user_id}}\",\n \"context\": {\n \"survey_name\": \"April2025_loyalty_survey\",\n \"positive_experience\": true,\n \"use_daily\": true,\n \"recommend_to_friend\": true,\n \"star_rating\": 5\n }\n }\n}"},"url":"{{endpoint}}/priv/v2/apps/{{appkey}}/events","description":"

Offers several types of request data for creating an event for a customer.

\n

Event types fall into three basic categories:

\n\n

Ultimately, the response data for these events can be presented or utilized in what a customer experiences in an application or on a web site. For example, displaying to the customer the status of a campaign they've accessed or the progress they've made within it.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v2","apps","{{appkey}}","events"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"b59015e1-fd56-4099-aaa7-dac6c8ecb69a","name":"1.3.1 Create Event for Customer by User ID (Simple)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"events\": {\n \"name\": \"app_downloaded\",\n \"by\": \"1\",\n \"user_id\": \"{{user_id}}\",\n \"context\": {\n \"app_name\": \"BrandX_experience\",\n \"version\": \"1.0\",\n \"downloaded_at\": \"2025-04-11T10:00:00Z\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/priv/v2/apps/{{appkey}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Apr 2025 16:03:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"a29ee2b15c494311c52521766e44af56\""},{"key":"X-Request-Id","value":"4e052489-87c2-4e89-8707-d647067381a2"},{"key":"X-Runtime","value":"0.017292"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"},{"id":"f9511323-7017-45d9-b5e6-aaa458ad6268","name":"1.3.1 Create Event for Customer by User ID (Simple)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"events\": {\n \"name\": \"survey_completed\",\n \"by\": \"1\",\n \"user_id\": \"{{user_id}}\",\n \"context\": {\n \"survey_name\": \"April2025_loyalty_survey\",\n \"positive_experience\": true,\n \"use_daily\": true,\n \"recommend_to_friend\": true,\n \"star_rating\": 5\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/priv/v2/apps/{{appkey}}/events"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Apr 2025 17:23:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"a29ee2b15c494311c52521766e44af56\""},{"key":"X-Request-Id","value":"6b5684f7-ea53-4216-8766-87d4238a8014"},{"key":"X-Runtime","value":"0.054359"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"a083c409-d10e-457f-8f3e-b52a78170f09"},{"name":"1.3.2 Create Event for Campaign by User ID (Multiple Stores Specified)","id":"e7a8b16e-8eee-4709-b315-3eca5decf640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\"event_name\":\n [\n {\"qty\": 1, \"store\": \"A1B2\"},\n {\"qty\": 1, \"store\": \"C3D4\"}\n ]\n}"},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/campaigns/{{ad_campaign_id}}/events","description":"

Creates one or multiple events for a specified campaign (via :ad_campaign_id).

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","campaigns","{{ad_campaign_id}}","events"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7a8b16e-8eee-4709-b315-3eca5decf640"}],"id":"0f25f4f4-503e-4536-8eb0-3b50fe8e3a86","description":"

Events objects allow a third party to submit data representing specific actions taken by a customer. These actions are evaluated and acted upon based on the rules engine configuration for a specific campaign or outcome configured in the platform.

\n

Some examples of customer-triggered events could include opening an application or moving to paperless billing. Event request objects provide the appropriate attributes for expressing these events.

\n

Responses contain state data related to any completed actions defined by a specific event and its associated outcomes. Actions are defined in the SessionM Platform using the events they stream and any affiliated attributes.

\n

Actions might include:

\n\n

For more information, see this discussion.

\n

Postman Journey: Time to Connect with Marcus via Non-transactional Activities

\n

When Marcus downloads and signs in to the Brand X application for the first time, the backend of the application logs this non-transactional activity and then triggers sending a custom event to SessionM. This event now lets marketers know that Marcus is an application user and can be targeted more effectively for promotions, challenge activities, or push notifications.

\n

After being a loyalty member for some time, Marcus should probably be sent a survey from whatever survey tool Brand X is using. As a reward for completing the survey, Brand X would like to issue Marcus an offer for 5% off his next purchase. Brand X’s survey tool then sends SessionM a custom event stating that Marcus has completed the survey and can be awarded, or sent, the offer.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"3a239358-5485-42ca-b6e4-c233939ac428"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"55e7fd54-364e-46bb-b290-60a6411d6da5"}}],"_postman_id":"0f25f4f4-503e-4536-8eb0-3b50fe8e3a86"},{"name":"1.4 Timeline APIs","item":[{"name":"1.4.1 Retrieve Events for Single View by User ID","id":"b7893395-8f4e-4363-85ec-b0103652a144","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/timelines/END_USER_MEMBER_STATEMENT","description":"

Retrieves an array of events in a timeline view that reflects a specific user or type of user.

\n

The event data returned represents a wide range of event activity, which can vary depending upon what type of user is performing the events. For example, the events in a view associated with an enduser, or customer, making a purchase differs a great deal from an administrator creating new event types.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","timelines","END_USER_MEMBER_STATEMENT"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"02558ccc-8c64-45c2-b7e7-4344260dd1dd","name":"1.4.1 Retrieve Events for Single View by User ID","originalRequest":{"method":"GET","header":[],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/timelines/END_USER_MEMBER_STATEMENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Apr 2025 17:53:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"10397"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"0be4f95b3af28756a4155ce5f716816a\""},{"key":"X-Request-Id","value":"7b796392-c96d-4489-9148-74baa2b04f50"},{"key":"X-Runtime","value":"0.087624"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"result\": [\n {\n \"event_stream_stream_id\": \"84f473e9-0e96-5040-8376-44f4d7376dc8\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_event_type_id\": 191,\n \"target_id\": 582447,\n \"timestamp\": 1744122197000,\n \"created_at\": 1744122223,\n \"event_stream_payload\": {\n \"account_full_name\": \"QA Integration Test\",\n \"account_id\": null,\n \"changes\": [],\n \"created_at\": 1744122197,\n \"event_category_name\": \"USER_PROFILE\",\n \"event_category_slug\": \"USER_PROFILE\",\n \"event_type_name\": \"Profile Attribute Update Manual\",\n \"event_type_slug\": \"PROFILE_ATTRIBUTE_UPDATE_MANUAL\",\n \"request_id\": \"03e371c6-1485-11f0-8fb4-203eac110002\",\n \"rewards_system_id\": 264,\n \"updated_attrs\": [],\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_name\": \"Marcus Mastercardson\"\n },\n \"contexts\": [\n {}\n ]\n },\n {\n \"event_stream_stream_id\": \"1446ef31-b1a5-5f24-9d30-7a7e5a71bd8f\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_event_type_id\": 177,\n \"target_id\": 582447,\n \"timestamp\": 1744120599000,\n \"created_at\": 1744120623,\n \"event_stream_payload\": {\n \"created_at\": 1744120599,\n \"event_category_name\": \"LOYALTY\",\n \"event_category_slug\": \"LOYALTY\",\n \"event_type_name\": \"Signed Up without Referral\",\n \"event_type_slug\": \"SIGNED_UP_WITHOUT_REFERRAL\",\n \"player_id\": 582447,\n \"request_id\": \"4b58a958-1481-11f0-82b7-3740ac110002\",\n \"rewards_system_id\": 264,\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_name\": \"Marcus Mastercardson\"\n },\n \"contexts\": [\n {}\n ]\n }\n ],\n \"grouping_field\": null,\n \"count\": 2,\n \"event_types\": [\n {\n \"id\": 138,\n \"name\": \"Points Comped\",\n \"slug\": \"POINTS_COMPED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 139,\n \"name\": \"Points Expired\",\n \"slug\": \"POINTS_EXPIRED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 140,\n \"name\": \"Points Earned\",\n \"slug\": \"POINTS_EARNED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 141,\n \"name\": \"Points Used\",\n \"slug\": \"POINTS_USED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 142,\n \"name\": \"Points Awarded\",\n \"slug\": \"POINTS_AWARDED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 143,\n \"name\": \"Incentives Point Spend\",\n \"slug\": \"INCENTIVES_POINT_SPEND\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 144,\n \"name\": \"Incentives Point Deposit\",\n \"slug\": \"INCENTIVES_POINT_DEPOSIT\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 145,\n \"name\": \"Incentives Point Expiration\",\n \"slug\": \"INCENTIVES_POINT_EXPIRATION\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 146,\n \"name\": \"Manual Incentives Point Spend\",\n \"slug\": \"MANUAL_INCENTIVES_POINT_SPEND\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 147,\n \"name\": \"Manual Incentives Point Deposit\",\n \"slug\": \"MANUAL_INCENTIVES_POINT_DEPOSIT\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 148,\n \"name\": \"Purchase Transaction\",\n \"slug\": \"PURCHASE_TRANSACTION\",\n \"event_stream_event_category_id\": 29,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 149,\n \"name\": \"Note Added\",\n \"slug\": \"NOTE_ADDED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 150,\n \"name\": \"Offer Redeemed\",\n \"slug\": \"OFFER_REDEEMED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 151,\n \"name\": \"Offer Claimed\",\n \"slug\": \"OFFER_CLAIMED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 152,\n \"name\": \"Tier Advanced\",\n \"slug\": \"TIER_ADVANCED\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 153,\n \"name\": \"Tier Reset\",\n \"slug\": \"TIER_RESET\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 154,\n \"name\": \"Tier Transit\",\n \"slug\": \"TIER_TRANSIT\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 155,\n \"name\": \"Change Tier Manual\",\n \"slug\": \"CHANGE_TIER_MANUAL\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 156,\n \"name\": \"Change Tier Promotion\",\n \"slug\": \"CHANGE_TIER_PROMOTION\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 157,\n \"name\": \"Email Opened\",\n \"slug\": \"EMAIL_OPENED\",\n \"event_stream_event_category_id\": 34,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 158,\n \"name\": \"Push Message Opened\",\n \"slug\": \"PUSH_MESSAGE_OPENED\",\n \"event_stream_event_category_id\": 34,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 159,\n \"name\": \"Video Watched\",\n \"slug\": \"VIDEO_WATCHED\",\n \"event_stream_event_category_id\": 34,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 160,\n \"name\": \"Loyalty Card Linked\",\n \"slug\": \"LOYALTY_CARD_LINKED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 161,\n \"name\": \"Loyalty Rule Achieved\",\n \"slug\": \"LOYALTY_RULE_ACHIEVED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 162,\n \"name\": \"Registration\",\n \"slug\": \"REGISTRATION\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 163,\n \"name\": \"Promo Code Received\",\n \"slug\": \"PROMO_CODE_RECEIVED\",\n \"event_stream_event_category_id\": 36,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 164,\n \"name\": \"Promo Code Used\",\n \"slug\": \"PROMO_CODE_USED\",\n \"event_stream_event_category_id\": 36,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 165,\n \"name\": \"Purchase\",\n \"slug\": \"PURCHASE\",\n \"event_stream_event_category_id\": 30,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 166,\n \"name\": \"Keyword Entered\",\n \"slug\": \"KEYWORD_ENTERED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 167,\n \"name\": \"Gift Redeemed\",\n \"slug\": \"GIFT_REDEEMED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 168,\n \"name\": \"User Tag Dropped\",\n \"slug\": \"USER_TAG_DROPPED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 169,\n \"name\": \"Issued Offer\",\n \"slug\": \"ISSUED_OFFER\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 170,\n \"name\": \"Redeemed Offer\",\n \"slug\": \"REDEEMED_OFFER\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 171,\n \"name\": \"Revoked Offer\",\n \"slug\": \"REVOKED_OFFER\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 172,\n \"name\": \"Offer Expires\",\n \"slug\": \"OFFER_EXPIRES\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 173,\n \"name\": \"Offer Modified\",\n \"slug\": \"OFFER_MODIFIED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 174,\n \"name\": \"Offer Purchased\",\n \"slug\": \"OFFER_PURCHASED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 175,\n \"name\": \"Account Merged\",\n \"slug\": \"ACCOUNT_MERGED\",\n \"event_stream_event_category_id\": 37,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 176,\n \"name\": \"Signed up with Referral\",\n \"slug\": \"SIGNED_UP_WITH_REFERRAL\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 177,\n \"name\": \"Signed Up without Referral\",\n \"slug\": \"SIGNED_UP_WITHOUT_REFERRAL\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 178,\n \"name\": \"First Transaction with Referral\",\n \"slug\": \"FIRST_TRANSACTION_WITH_REFERRAL\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 179,\n \"name\": \"Referred a User to Sign Up\",\n \"slug\": \"REFERRED_A_USER_TO_SIGN_UP\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 180,\n \"name\": \"Referred a User to Sign Up - Over Limit\",\n \"slug\": \"REFERRED_A_USER_TO_SIGN_UP_-_OVER_LIMIT\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 181,\n \"name\": \"Referred a User to First Transaction\",\n \"slug\": \"REFERRED_A_USER_TO_FIRST_TRANSACTION\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 182,\n \"name\": \"User Profile Edited\",\n \"slug\": \"USER_PROFILE_EDITED\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 183,\n \"name\": \"User Notes Created\",\n \"slug\": \"USER_NOTES_CREATED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 184,\n \"name\": \"User Notes Edited\",\n \"slug\": \"USER_NOTES_EDITED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 185,\n \"name\": \"User Notes Deleted\",\n \"slug\": \"USER_NOTES_DELETED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 186,\n \"name\": \"Customer Data Exported\",\n \"slug\": \"CUSTOMER_DATA_EXPORTED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 187,\n \"name\": \"Data Processing Restricted\",\n \"slug\": \"DATA_PROCESSING_RESTRICTED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 188,\n \"name\": \"Data Processing Reinstated\",\n \"slug\": \"DATA_PROCESSING_REINSTATED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 189,\n \"name\": \"Customer Data Downloaded\",\n \"slug\": \"CUSTOMER_DATA_DOWNLOADED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 190,\n \"name\": \"Profile Update\",\n \"slug\": \"PROFILE_UPDATE\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 191,\n \"name\": \"Profile Attribute Update Manual\",\n \"slug\": \"PROFILE_ATTRIBUTE_UPDATE_MANUAL\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 192,\n \"name\": \"SVC Card Imported\",\n \"slug\": \"SVC_CARD_IMPORTED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 193,\n \"name\": \"SVC Card Activated\",\n \"slug\": \"SVC_CARD_ACTIVATED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 194,\n \"name\": \"SVC Bulk Activated\",\n \"slug\": \"SVC_BULK_ACTIVATED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 195,\n \"name\": \"SVC Card Reload\",\n \"slug\": \"SVC_CARD_RELOAD\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 196,\n \"name\": \"SVC Bulk Reload\",\n \"slug\": \"SVC_BULK_RELOAD\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 197,\n \"name\": \"SVC Card Expired\",\n \"slug\": \"SVC_CARD_EXPIRED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 198,\n \"name\": \"SVC Bulk Expired\",\n \"slug\": \"SVC_BULK_EXPIRED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 199,\n \"name\": \"SVC Card Added\",\n \"slug\": \"SVC_CARD_ADDED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 200,\n \"name\": \"SVC Card Balance Transfered\",\n \"slug\": \"SVC_CARD_BALANCE_TRANSFERED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 201,\n \"name\": \"SVC Card Stolen\",\n \"slug\": \"SVC_CARD_STOLEN\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 202,\n \"name\": \"SVC Card Lost\",\n \"slug\": \"SVC_CARD_LOST\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 203,\n \"name\": \"SVC Card Found\",\n \"slug\": \"SVC_CARD_FOUND\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 204,\n \"name\": \"SVC Card Balance Adjusted\",\n \"slug\": \"SVC_CARD_BALANCE_ADJUSTED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 205,\n \"name\": \"SVC Card Deactivated\",\n \"slug\": \"SVC_CARD_DEACTIVATED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 964,\n \"name\": \"LOYALTY_GOAL_ACHIEVED\",\n \"slug\": \"LOYALTY_GOAL_ACHIEVED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n }\n ]\n}"},{"id":"ec890f87-6788-4b36-85ad-ea420cc58966","name":"1.4.1 Retrieve Events for Single View by User ID","originalRequest":{"method":"GET","header":[],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/timelines/END_USER_MEMBER_STATEMENT"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 15:07:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"12834"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"762367552c6a25012bb15953921d6822\""},{"key":"X-Request-Id","value":"e4d4aac2-30a3-4772-9f10-2d0bc0d7a76c"},{"key":"X-Runtime","value":"0.073343"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"result\": [\n {\n \"event_stream_stream_id\": \"8cb4ff48-4739-573c-ae00-a7851edd6dd2\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_event_type_id\": 169,\n \"target_id\": 582447,\n \"timestamp\": 1744656712000,\n \"created_at\": 1744656743,\n \"event_stream_payload\": {\n \"OfferAcquireDate\": \"2025-04-14T18:51:51.8840335Z\",\n \"OfferID\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"OfferName\": \"5% Off Your Entire Purchase\",\n \"OfferRedeemDate\": null,\n \"RedemptionEndDate\": null,\n \"RedemptionStartDate\": \"2025-04-14T00:00:00Z\",\n \"RetailerID\": \"e59fdc7e-2413-442e-8e38-077a2d150a5e\",\n \"RootOfferID\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"UserID\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"created_at\": 1744656712,\n \"event_category_name\": \"OFFERS\",\n \"event_category_slug\": \"OFFERS\",\n \"event_type_name\": \"Issued Offer\",\n \"event_type_slug\": \"ISSUED_OFFER\",\n \"request_id\": \"87784f3a-1961-11f0-82a2-342aac110002\",\n \"rewards_system_id\": 264,\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\"\n },\n \"contexts\": [\n {}\n ]\n },\n {\n \"event_stream_stream_id\": \"6fac3aa4-c11c-574e-8d8c-d49d85a542b0\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_event_type_id\": 169,\n \"target_id\": 582447,\n \"timestamp\": 1744655008000,\n \"created_at\": 1744655033,\n \"event_stream_payload\": {\n \"OfferAcquireDate\": \"2025-04-14T18:23:27.6725247Z\",\n \"OfferID\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"OfferName\": \"$5 Reward\",\n \"OfferRedeemDate\": null,\n \"RedemptionEndDate\": \"\",\n \"RedemptionStartDate\": \"2020-08-21T18:19:00Z\",\n \"RetailerID\": \"e59fdc7e-2413-442e-8e38-077a2d150a5e\",\n \"RootOfferID\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"UserID\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"created_at\": 1744655008,\n \"event_category_name\": \"OFFERS\",\n \"event_category_slug\": \"OFFERS\",\n \"event_type_name\": \"Issued Offer\",\n \"event_type_slug\": \"ISSUED_OFFER\",\n \"request_id\": \"8f9d6fb4-195d-11f0-96ab-5ee0ac110004\",\n \"rewards_system_id\": 264,\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\"\n },\n \"contexts\": [\n {}\n ]\n },\n {\n \"event_stream_stream_id\": \"b94fac6e-dddd-59c1-90cd-8c2135eef286\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_event_type_id\": 168,\n \"target_id\": 582447,\n \"timestamp\": 1744653263000,\n \"created_at\": 1744653293,\n \"event_stream_payload\": {\n \"created_at\": 1744653263,\n \"event_category_name\": \"LOYALTY\",\n \"event_category_slug\": \"LOYALTY\",\n \"event_type_name\": \"User Tag Dropped\",\n \"event_type_slug\": \"USER_TAG_DROPPED\",\n \"request_id\": \"7fc0c838-1959-11f0-940d-2a15ac110002\",\n \"rewards_system_id\": 264,\n \"tag\": \"app_opened\",\n \"tag_count\": 1,\n \"tag_date\": \"2025-04-14T17:54:23+00:00\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_name\": \"Marcus Mastercardson\"\n },\n \"contexts\": [\n {}\n ]\n },\n {\n \"event_stream_stream_id\": \"84f473e9-0e96-5040-8376-44f4d7376dc8\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_event_type_id\": 191,\n \"target_id\": 582447,\n \"timestamp\": 1744122197000,\n \"created_at\": 1744122223,\n \"event_stream_payload\": {\n \"account_full_name\": \"QA Integration Test\",\n \"account_id\": null,\n \"changes\": [],\n \"created_at\": 1744122197,\n \"event_category_name\": \"USER_PROFILE\",\n \"event_category_slug\": \"USER_PROFILE\",\n \"event_type_name\": \"Profile Attribute Update Manual\",\n \"event_type_slug\": \"PROFILE_ATTRIBUTE_UPDATE_MANUAL\",\n \"request_id\": \"03e371c6-1485-11f0-8fb4-203eac110002\",\n \"rewards_system_id\": 264,\n \"updated_attrs\": [],\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_name\": \"Marcus Mastercardson\"\n },\n \"contexts\": [\n {}\n ]\n },\n {\n \"event_stream_stream_id\": \"1446ef31-b1a5-5f24-9d30-7a7e5a71bd8f\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_event_type_id\": 177,\n \"target_id\": 582447,\n \"timestamp\": 1744120599000,\n \"created_at\": 1744120623,\n \"event_stream_payload\": {\n \"created_at\": 1744120599,\n \"event_category_name\": \"LOYALTY\",\n \"event_category_slug\": \"LOYALTY\",\n \"event_type_name\": \"Signed Up without Referral\",\n \"event_type_slug\": \"SIGNED_UP_WITHOUT_REFERRAL\",\n \"player_id\": 582447,\n \"request_id\": \"4b58a958-1481-11f0-82b7-3740ac110002\",\n \"rewards_system_id\": 264,\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_name\": \"Marcus Mastercardson\"\n },\n \"contexts\": [\n {}\n ]\n }\n ],\n \"grouping_field\": null,\n \"count\": 5,\n \"event_types\": [\n {\n \"id\": 138,\n \"name\": \"Points Comped\",\n \"slug\": \"POINTS_COMPED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 139,\n \"name\": \"Points Expired\",\n \"slug\": \"POINTS_EXPIRED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 140,\n \"name\": \"Points Earned\",\n \"slug\": \"POINTS_EARNED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 141,\n \"name\": \"Points Used\",\n \"slug\": \"POINTS_USED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 142,\n \"name\": \"Points Awarded\",\n \"slug\": \"POINTS_AWARDED\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 143,\n \"name\": \"Incentives Point Spend\",\n \"slug\": \"INCENTIVES_POINT_SPEND\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 144,\n \"name\": \"Incentives Point Deposit\",\n \"slug\": \"INCENTIVES_POINT_DEPOSIT\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 145,\n \"name\": \"Incentives Point Expiration\",\n \"slug\": \"INCENTIVES_POINT_EXPIRATION\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 146,\n \"name\": \"Manual Incentives Point Spend\",\n \"slug\": \"MANUAL_INCENTIVES_POINT_SPEND\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 147,\n \"name\": \"Manual Incentives Point Deposit\",\n \"slug\": \"MANUAL_INCENTIVES_POINT_DEPOSIT\",\n \"event_stream_event_category_id\": 28,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 148,\n \"name\": \"Purchase Transaction\",\n \"slug\": \"PURCHASE_TRANSACTION\",\n \"event_stream_event_category_id\": 29,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 149,\n \"name\": \"Note Added\",\n \"slug\": \"NOTE_ADDED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 150,\n \"name\": \"Offer Redeemed\",\n \"slug\": \"OFFER_REDEEMED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 151,\n \"name\": \"Offer Claimed\",\n \"slug\": \"OFFER_CLAIMED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 152,\n \"name\": \"Tier Advanced\",\n \"slug\": \"TIER_ADVANCED\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 153,\n \"name\": \"Tier Reset\",\n \"slug\": \"TIER_RESET\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 154,\n \"name\": \"Tier Transit\",\n \"slug\": \"TIER_TRANSIT\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 155,\n \"name\": \"Change Tier Manual\",\n \"slug\": \"CHANGE_TIER_MANUAL\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 156,\n \"name\": \"Change Tier Promotion\",\n \"slug\": \"CHANGE_TIER_PROMOTION\",\n \"event_stream_event_category_id\": 33,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 157,\n \"name\": \"Email Opened\",\n \"slug\": \"EMAIL_OPENED\",\n \"event_stream_event_category_id\": 34,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 158,\n \"name\": \"Push Message Opened\",\n \"slug\": \"PUSH_MESSAGE_OPENED\",\n \"event_stream_event_category_id\": 34,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 159,\n \"name\": \"Video Watched\",\n \"slug\": \"VIDEO_WATCHED\",\n \"event_stream_event_category_id\": 34,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 160,\n \"name\": \"Loyalty Card Linked\",\n \"slug\": \"LOYALTY_CARD_LINKED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 161,\n \"name\": \"Loyalty Rule Achieved\",\n \"slug\": \"LOYALTY_RULE_ACHIEVED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 162,\n \"name\": \"Registration\",\n \"slug\": \"REGISTRATION\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 163,\n \"name\": \"Promo Code Received\",\n \"slug\": \"PROMO_CODE_RECEIVED\",\n \"event_stream_event_category_id\": 36,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 164,\n \"name\": \"Promo Code Used\",\n \"slug\": \"PROMO_CODE_USED\",\n \"event_stream_event_category_id\": 36,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 165,\n \"name\": \"Purchase\",\n \"slug\": \"PURCHASE\",\n \"event_stream_event_category_id\": 30,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 166,\n \"name\": \"Keyword Entered\",\n \"slug\": \"KEYWORD_ENTERED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 167,\n \"name\": \"Gift Redeemed\",\n \"slug\": \"GIFT_REDEEMED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 168,\n \"name\": \"User Tag Dropped\",\n \"slug\": \"USER_TAG_DROPPED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 169,\n \"name\": \"Issued Offer\",\n \"slug\": \"ISSUED_OFFER\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 170,\n \"name\": \"Redeemed Offer\",\n \"slug\": \"REDEEMED_OFFER\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 171,\n \"name\": \"Revoked Offer\",\n \"slug\": \"REVOKED_OFFER\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 172,\n \"name\": \"Offer Expires\",\n \"slug\": \"OFFER_EXPIRES\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 173,\n \"name\": \"Offer Modified\",\n \"slug\": \"OFFER_MODIFIED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 174,\n \"name\": \"Offer Purchased\",\n \"slug\": \"OFFER_PURCHASED\",\n \"event_stream_event_category_id\": 32,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 175,\n \"name\": \"Account Merged\",\n \"slug\": \"ACCOUNT_MERGED\",\n \"event_stream_event_category_id\": 37,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 176,\n \"name\": \"Signed up with Referral\",\n \"slug\": \"SIGNED_UP_WITH_REFERRAL\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 177,\n \"name\": \"Signed Up without Referral\",\n \"slug\": \"SIGNED_UP_WITHOUT_REFERRAL\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 178,\n \"name\": \"First Transaction with Referral\",\n \"slug\": \"FIRST_TRANSACTION_WITH_REFERRAL\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 179,\n \"name\": \"Referred a User to Sign Up\",\n \"slug\": \"REFERRED_A_USER_TO_SIGN_UP\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 180,\n \"name\": \"Referred a User to Sign Up - Over Limit\",\n \"slug\": \"REFERRED_A_USER_TO_SIGN_UP_-_OVER_LIMIT\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 181,\n \"name\": \"Referred a User to First Transaction\",\n \"slug\": \"REFERRED_A_USER_TO_FIRST_TRANSACTION\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 182,\n \"name\": \"User Profile Edited\",\n \"slug\": \"USER_PROFILE_EDITED\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 183,\n \"name\": \"User Notes Created\",\n \"slug\": \"USER_NOTES_CREATED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 184,\n \"name\": \"User Notes Edited\",\n \"slug\": \"USER_NOTES_EDITED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 185,\n \"name\": \"User Notes Deleted\",\n \"slug\": \"USER_NOTES_DELETED\",\n \"event_stream_event_category_id\": 31,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 186,\n \"name\": \"Customer Data Exported\",\n \"slug\": \"CUSTOMER_DATA_EXPORTED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 187,\n \"name\": \"Data Processing Restricted\",\n \"slug\": \"DATA_PROCESSING_RESTRICTED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 188,\n \"name\": \"Data Processing Reinstated\",\n \"slug\": \"DATA_PROCESSING_REINSTATED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 189,\n \"name\": \"Customer Data Downloaded\",\n \"slug\": \"CUSTOMER_DATA_DOWNLOADED\",\n \"event_stream_event_category_id\": 39,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 190,\n \"name\": \"Profile Update\",\n \"slug\": \"PROFILE_UPDATE\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 191,\n \"name\": \"Profile Attribute Update Manual\",\n \"slug\": \"PROFILE_ATTRIBUTE_UPDATE_MANUAL\",\n \"event_stream_event_category_id\": 38,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 192,\n \"name\": \"SVC Card Imported\",\n \"slug\": \"SVC_CARD_IMPORTED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 193,\n \"name\": \"SVC Card Activated\",\n \"slug\": \"SVC_CARD_ACTIVATED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 194,\n \"name\": \"SVC Bulk Activated\",\n \"slug\": \"SVC_BULK_ACTIVATED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 195,\n \"name\": \"SVC Card Reload\",\n \"slug\": \"SVC_CARD_RELOAD\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 196,\n \"name\": \"SVC Bulk Reload\",\n \"slug\": \"SVC_BULK_RELOAD\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 197,\n \"name\": \"SVC Card Expired\",\n \"slug\": \"SVC_CARD_EXPIRED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 198,\n \"name\": \"SVC Bulk Expired\",\n \"slug\": \"SVC_BULK_EXPIRED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 199,\n \"name\": \"SVC Card Added\",\n \"slug\": \"SVC_CARD_ADDED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 200,\n \"name\": \"SVC Card Balance Transfered\",\n \"slug\": \"SVC_CARD_BALANCE_TRANSFERED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 201,\n \"name\": \"SVC Card Stolen\",\n \"slug\": \"SVC_CARD_STOLEN\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 202,\n \"name\": \"SVC Card Lost\",\n \"slug\": \"SVC_CARD_LOST\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 203,\n \"name\": \"SVC Card Found\",\n \"slug\": \"SVC_CARD_FOUND\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 204,\n \"name\": \"SVC Card Balance Adjusted\",\n \"slug\": \"SVC_CARD_BALANCE_ADJUSTED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 205,\n \"name\": \"SVC Card Deactivated\",\n \"slug\": \"SVC_CARD_DEACTIVATED\",\n \"event_stream_event_category_id\": 40,\n \"event_stream_stream_id\": 4\n },\n {\n \"id\": 964,\n \"name\": \"LOYALTY_GOAL_ACHIEVED\",\n \"slug\": \"LOYALTY_GOAL_ACHIEVED\",\n \"event_stream_event_category_id\": 35,\n \"event_stream_stream_id\": 4\n }\n ]\n}"}],"_postman_id":"b7893395-8f4e-4363-85ec-b0103652a144"}],"id":"fe08f900-e850-4023-bbd3-a4cf933f6036","description":"

This API features the ability to retrieve a loyalty member activity history for a particular timeline view.

\n

These histories, or timelines, can contain customer activity, campaign activity, end-user communication and Point of Sale (POS) activity. They can record types of temporal events with varying sets of data attributes per event type. Doing so generates a timeline of events in reverse chronological order that can be accessed in a paged manner.

\n

While an activity history can be of infinite size, views allow for paging through a timeline, either rendered literally as pages of events or shown with an “infinite scroll” mechanism. They can reflect different levels of granularity, and individual events within them can appear in multiple views. For example, the same event can be included in the view for a particular customer’s events, and also show up in a view tied to a particular campaign.

\n

If you want more information on working with a member activity history, see the following documentation:

\n\n

Postman Journey: Presenting Members with their Activity History

\n

As part of the application integration, Brand X wants to show Marcus a view of all of his previous transactions and point awards. When Marcus logs into his application, the backend calls the SessionM timeline API to retrieve his historical activity.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"dbc78c24-798e-4cdd-a582-b6e16ea4d2ac"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6d81187e-8fe2-4cbc-a2a5-e024fa8fe778"}}],"_postman_id":"fe08f900-e850-4023-bbd3-a4cf933f6036"},{"name":"1.5 Data Privacy APIs","item":[{"name":"1.5.1 Retrieve All Privacy Requests by User ID","id":"0286b87b-ee2d-44a5-960d-5e412392b3bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/privacy","description":"

Gets all data privacy requests initiated by all platform users on behalf of customers.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","privacy"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"382163cd-bd40-4385-aa8d-b7529313e1f4","name":"1.5.1 Retrieve All Privacy Requests by User ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/privacy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Apr 2025 18:04:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"37"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"b99063ca2394c3921f985afe5f0dd1bd\""},{"key":"X-Request-Id","value":"77b04779-3569-41ae-9696-3c131b30779b"},{"key":"X-Runtime","value":"0.037426"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"privacy_requests\": []\n}"}],"_postman_id":"0286b87b-ee2d-44a5-960d-5e412392b3bc"},{"name":"1.5.2 Request to Forget Customer Data by User ID","id":"6ed7fa95-bf8d-45a3-a9e8-98700085a36d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/privacy/forget","description":"

Creates request to forget any customer information, such as an email address or a physical address as well as any loyalty data about available offers and earned achievements. Once implemented, the customer account and all associated data is removed from any loyalty or marketing programs.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","privacy","forget"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"df5dbb27-ce59-46f6-9cdd-eaf635fbf947","name":"1.5.2 Request to Forget Customer Data by User ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/b8813f3c-1a1b-11f0-803b-a50cac110002/privacy/forget"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Apr 2025 17:05:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"312"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"90bc73a9f6733ba4a7ac9d5dce3c8df7\""},{"key":"X-Request-Id","value":"606a2d9d-8a76-4e36-9cb3-478c3ebbf0d0"},{"key":"X-Runtime","value":"0.096045"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"privacy_request\": {\n \"id\": 58,\n \"privacy_request_part_ids\": {\n \"291\": \"forget\",\n \"292\": \"timeline_forget_stream\",\n \"293\": \"offers_domain_forget_organization\",\n \"294\": \"txn_domain_forget_organization\",\n \"295\": \"messaging_platform_forget\",\n \"296\": \"data_team_forget\",\n \"297\": \"external_dbs_forget\",\n \"298\": \"incentives_forget\"\n }\n }\n}"}],"_postman_id":"6ed7fa95-bf8d-45a3-a9e8-98700085a36d"},{"name":"1.5.3 Retrieve All Requests to Export Customer Data by User ID","id":"22abac4d-e522-410a-ba53-33233ebdd2a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/privacy/export","description":"

Gets all data requests initiated by all platform users to export privacy data.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","privacy","export"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"49efe222-3608-4020-8aa5-a1a5821157b7","name":"1.5.3 Retrieve All Requests to Export Customer Data by User ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/privacy/export"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Apr 2025 17:05:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"35"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"faddca0033581de53030d8cd36ce293f\""},{"key":"X-Request-Id","value":"43f7368d-2eed-42ee-990d-442f08541e6e"},{"key":"X-Runtime","value":"0.018627"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"gdpr_user_data\": []\n}"}],"_postman_id":"22abac4d-e522-410a-ba53-33233ebdd2a3"},{"name":"1.5.4 Request to Restrict/Reinstate Customer by User ID","id":"dbd359fe-5b1c-453e-b966-602ed427b419","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/privacy/restrict","description":"

Creates a request that toggles a user between a status of \"Restrict\" and \"Reinstate\". Restricting a customer removes their ability to participate in marketing campaigns and audience inclusion. Doing so also removes their ability to log into an app or web portal experience, if SessionM identity services product is used.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","privacy","restrict"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"75392d4b-dee3-4693-9926-3b7dc95a3341","name":"1.5.4 Request to Restrict/Reinstate Customer by User ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/b8813f3c-1a1b-11f0-803b-a50cac110002/privacy/restrict"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Apr 2025 17:05:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"a29ee2b15c494311c52521766e44af56\""},{"key":"X-Request-Id","value":"773a1eb8-1350-45d2-a8fd-7e499c542e31"},{"key":"X-Runtime","value":"0.097603"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"dbd359fe-5b1c-453e-b966-602ed427b419"}],"id":"5689858b-080c-4cce-ad4a-f125562cc2bb","description":"

The Data Privacy API provides functions for creating and maintaining requests on behalf of customers to forget or export privacy data. In addition, the API can be used to create requests that restrict or reinstate a customer's access to loyalty or marketing programs. These data privacy features are available to all clients committed to fulfilling customer requests seeking to safeguard or review their own personal data.

\n

For more information, see this discussion.

\n

Postman Journey: Marcus Needs a Break

\n

For reasons we may not fully understand, Marcus has decided he no longer wants to be part of the loyalty program. He requests that his account to be deleted and all of his information removed from Brand X for privacy purposes.

\n

When the requests to delete is made, the backend of the application or website sends a request to the SessionM GDPR API that forgets a customer's data. Doing so removes Marcus’s profile information and anonymizes any and all data associated with him, including transactional, point, tier, offer and promotional.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"40c763e3-f3f7-43f7-8b18-66bdb34b334e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"d90b4320-2c3e-4f6c-a5c3-62ffffd6ad29"}}],"_postman_id":"5689858b-080c-4cce-ad4a-f125562cc2bb"},{"name":"1.6 Customer Tag APIs","item":[{"name":"1.6.1 Get Customer Tags by User ID","id":"b00639ab-887f-45ba-bd54-5fc2776f975c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/tags","description":"

Retrieves all the tags associated with a customer, along with their counts.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","tags"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"07c7ee32-1175-41a1-bf58-8b56b0a9ea45","name":"1.6.1 Get Customer Tags by User ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Apr 2025 17:54:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"39"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"2a728b11421ae130eb5ff4c4eb9e8502\""},{"key":"X-Request-Id","value":"bab5fd59-fa19-4fda-b5ba-2a182738be7a"},{"key":"X-Runtime","value":"0.017596"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"tags\": {\n \"app_opened\": 1\n }\n}"}],"_postman_id":"b00639ab-887f-45ba-bd54-5fc2776f975c"},{"name":"1.6.2 Create Expiring Customer Tags by User ID","id":"42be14b5-1a2b-4aae-8fea-2ef205487ef9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apikey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tags\":[\n \"app_opened\"\n ],\n \"ttl\":20000\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/tags","description":"

Specifies a counter tag if it does not exist and sets its count to 1. If the counter tag already exists, its count is incremented by one.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","tags"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"082d0ddc-f8d7-47cf-a690-bb59d8ded953","name":"1.6.2 Create Expiring Customer Tags by User ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tags\":[\n \"app_opened\"\n ],\n \"ttl\":20000\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 14 Apr 2025 17:54:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"39"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"2a728b11421ae130eb5ff4c4eb9e8502\""},{"key":"X-Request-Id","value":"cb4a4c70-81a0-477f-88bd-c9fa8676a414"},{"key":"X-Runtime","value":"0.105865"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"tags\": {\n \"app_opened\": 1\n }\n}"}],"_postman_id":"42be14b5-1a2b-4aae-8fea-2ef205487ef9"}],"id":"d693ba29-f2af-4687-a2fe-9059ce68a503","description":"

This API features Tag objects, which manage arbitrary strings that can be attached to a customer profile. They act as keyword classifiers and are associated with a counter to indicate the number of times a tag has been assigned.

\n

Tags allow you to define segments of customers, each of which can be associated with targeting rules. Typically, the rules are designed to test for the presence of tags or their values and then take conditional steps based on them. For example, they can track simple customer actions such as abandoning an online shopping cart. With knowledge of the customer's decision to abandon a cart, you can retarget the customer to a new campaign or outcome.

\n

In addition, tags may also have a TTL (Time to Live) associated with them. These tags expire and disappear after the TTL expires. Note that a tag may have either a count (counter tag) or a TTL (expiring tag), but not both.

\n

For more information, see this discussion.

\n","_postman_id":"d693ba29-f2af-4687-a2fe-9059ce68a503"},{"name":"1.7 Advanced Customer Search APIs","item":[{"name":"1.7.1 Search for Customer Profiles by First and Last Name with Sorting Options","id":"8e8ba543-29ba-4fff-a180-10fe13d894b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/search_users?first_name={{firstname}}&last_name={{lastname}}&sort=user_id&limit=2&advanced_search_params[user_profile]=true","description":"

Searches for an existing standard customer profile based on attributes such as email address, external ID, and mobile phone number. Returns the specified customer profile with all of its associated attributes.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","search_users"],"host":["{{endpoint}}"],"query":[{"key":"first_name","value":"{{firstname}}"},{"key":"last_name","value":"{{lastname}}"},{"key":"sort","value":"user_id"},{"key":"limit","value":"2"},{"key":"advanced_search_params[user_profile]","value":"true"}],"variable":[]}},"response":[{"id":"8aea1e50-6f4a-4736-b86e-505047b4f28f","name":"1.7.1 Search for Customer Profiles by First and Last Name with Sorting Options","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/search_users?first_name=Marcus&last_name=Mastercardson&sort=user_id&limit=2&advanced_search_params[user_profile]=true","host":["{{endpoint}}"],"path":["priv","v1","apps","{{appkey}}","users","search_users"],"query":[{"key":"first_name","value":"Marcus"},{"key":"last_name","value":"Mastercardson"},{"key":"sort","value":"user_id"},{"key":"limit","value":"2"},{"key":"advanced_search_params[user_profile]","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:05:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1325"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"0011638e1d49433e08f00af61edd335a\""},{"key":"X-Request-Id","value":"6ff7c5b1-f336-457d-a392-856487fe8754"},{"key":"X-Runtime","value":"0.474504"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"total_count\": 2,\n \"players\": [\n {\n \"id\": 602136,\n \"user_id\": \"0f58fb38-1a1c-11f0-9791-b515ac110002\",\n \"first_name\": \"Marcus\",\n \"last_name\": \"Mastercardson\",\n \"dob\": \"1991-01-01\",\n \"yob\": 1991,\n \"email\": \"mmastercardson+1@sessionm.com\",\n \"home_state\": \"MA\",\n \"masked_phone_numbers\": [\n \"XXX-XXX-3333\"\n ],\n \"user_profile\": {\n \"_version\": 1,\n \"allergens\": [],\n \"cpg_brand_of_interest\": [],\n \"favorite_activities\": [],\n \"interests\": [],\n \"languages\": [],\n \"mcc\": [],\n \"org\": [],\n \"partner\": [\n \"root\"\n ],\n \"partner_type\": [],\n \"preferred_channel\": [],\n \"socioeconomic_status\": []\n },\n \"affiliate_type\": null,\n \"external_ids\": [\n \"MC-SESS-2025-XYZ-A\"\n ],\n \"home_address\": \"123 Fake St.\",\n \"home_address2\": null\n },\n {\n \"id\": 582447,\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"first_name\": \"Marcus\",\n \"last_name\": \"Mastercardson\",\n \"dob\": \"1991-01-01\",\n \"yob\": 1991,\n \"email\": \"mmastercarson@sessionm.com\",\n \"home_state\": \"MA\",\n \"masked_phone_numbers\": [\n \"XXX-XXX-3333\"\n ],\n \"user_profile\": {\n \"_version\": 2,\n \"allergens\": [\n \"nuts\",\n \"shellfish\"\n ],\n \"clothes_size\": \"large\",\n \"cpg_brand_of_interest\": [],\n \"email_optin\": true,\n \"favorite_activities\": [],\n \"home_store\": \"Boston-Seaport\",\n \"interests\": [],\n \"languages\": [],\n \"mcc\": [],\n \"org\": [],\n \"partner\": [\n \"root\"\n ],\n \"partner_type\": [],\n \"preferred_channel\": [],\n \"preferred_language\": \"english\",\n \"socioeconomic_status\": []\n },\n \"affiliate_type\": null,\n \"external_ids\": [\n \"MC-SESS-2025-XYZ\"\n ],\n \"home_address\": \"123 Fake St.\",\n \"home_address2\": null\n }\n ]\n}"}],"_postman_id":"8e8ba543-29ba-4fff-a180-10fe13d894b2"}],"id":"33d79dd0-d8da-4819-8325-b613ad45bf35","description":"

This API searches for existing customer profile based on a variety of attributes.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0aa22e57-997b-4046-9f57-074c16245b46"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"848da477-1d21-40b4-9565-f7b453a56bb3"}}],"_postman_id":"33d79dd0-d8da-4819-8325-b613ad45bf35"}],"id":"6aa4ec1c-db63-42da-8dd1-dac5419b1792","description":"

The APIs featured in this grouping support foundational types of members (often called “user” and \"customer\" in platform code) data with operations for the following:

\n
    \n
  • Profiles
    • \n
  • Accounts Merge
    • \n
  • Non-transactional Activities (Events)
    • \n
  • Timelines (Event streams)
    • \n
  • Data Privacy
    • \n
  • Tags
    • \n
  • Search
    • \n
\n

For more information, see this overview.

\n

Postman Journey: Marcus Gets Busy

\n

Marcus uses his phone to navigate to Brand X's website and clicks the \"Join Loyalty\" program link to signup for rewards on his purchases.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"198f6ee4-9cac-4a65-9edf-3175ce05cd4c"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"257eab97-f61c-4c74-b02a-1c995c32655f"}}],"_postman_id":"6aa4ec1c-db63-42da-8dd1-dac5419b1792"},{"name":"2. Promotions","item":[{"name":"2.1 Retrieve All Campaigns for Customer by User ID","id":"1f66a6d2-6542-4c65-a47f-0a20496ed3a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/campaigns","description":"

Fetches all of the campaigns associated with a specified or authorization token.

\n

For more information, see this API endpoint documentation

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","campaigns"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"6f074aa9-d5af-4265-a7ac-131b12e14d9a","name":"2.1 Retrieve All Campaigns for Customer by User ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/campaigns"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Apr 2025 17:39:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4029"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"4349584b136c077c7dc4c7f52c56ea2a\""},{"key":"X-Request-Id","value":"bf201c34-5289-4bc9-a98e-a376e19d707f"},{"key":"X-Runtime","value":"0.229180"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"campaigns\": {\n \"promotions\": [\n {\n \"campaign_id\": 288,\n \"name\": \"FaB - SU_Promotion2_500p\",\n \"group_id\": 634,\n \"creative_id\": 633,\n \"start_date\": \"2024-07-08 00:00:00\",\n \"end_date\": \"2124-07-08 14:30:46\",\n \"permalink\": \"mmc_rules_promotion_6\",\n \"template\": {\n \"type\": \"internal_behavior\"\n },\n \"progress\": {\n \"state\": \"qualified\",\n \"behaviors\": [\n {\n \"behavior_id\": 570,\n \"external_behavior_id\": \"08fa41fd-017d-4174-8204-25ad4de79ba5\",\n \"event_name\": \"b86e3639-5f51-4ac3-9c81-95401f090840\",\n \"name\": \"promotion_6_achievement\",\n \"progress\": 0,\n \"goal\": 1,\n \"active\": true\n }\n ]\n },\n \"behaviors\": {\n \"promotion_6_achievement\": {\n \"external_behavior_id\": \"08fa41fd-017d-4174-8204-25ad4de79ba5\",\n \"type\": \"composite\",\n \"points\": 0,\n \"achieved\": 0,\n \"can_skip\": true,\n \"skipped\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 86400,\n \"min_time_between_events\": null,\n \"consecutive\": false,\n \"goals\": {\n \"promotion_6_code_claimed\": {\n \"type\": \"goal\",\n \"points\": 0,\n \"completed\": false,\n \"required\": true,\n \"earn_count\": 1,\n \"group_id\": \"0\",\n \"skus\": null,\n \"progress\": {\n \"event_name\": \"promotion_6_code_claimed\",\n \"type\": \"count\",\n \"points\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 315360000,\n \"min_time_between_events\": null,\n \"min_time_between_events_count\": 1,\n \"consecutive\": false,\n \"achieved\": 0,\n \"current_count\": 0,\n \"total_count\": 1\n }\n }\n },\n \"groups\": {\n \"0\": {\n \"type\": \"group\",\n \"current_count\": 0,\n \"total_count\": 1,\n \"num_goals\": 1,\n \"completed\": false\n }\n }\n }\n }\n },\n {\n \"campaign_id\": 324,\n \"name\": \"[MM] $5 vouchers\",\n \"group_id\": 681,\n \"creative_id\": 680,\n \"start_date\": \"2024-07-29 00:00:00\",\n \"end_date\": \"2124-07-29 07:41:40\",\n \"permalink\": \"mmc_rules_promotion_7\",\n \"template\": {\n \"type\": \"internal_behavior\"\n },\n \"progress\": {\n \"state\": \"qualified\",\n \"behaviors\": [\n {\n \"behavior_id\": 706,\n \"external_behavior_id\": \"1a00fdd9-09cf-46c7-a54b-38ec1aeb2f82\",\n \"event_name\": \"2255345a-7cfd-41da-adf1-5b4be8c5eedb\",\n \"name\": \"promotion_7_achievement\",\n \"progress\": 0,\n \"goal\": 1,\n \"active\": true\n }\n ]\n },\n \"behaviors\": {\n \"promotion_7_achievement\": {\n \"external_behavior_id\": \"1a00fdd9-09cf-46c7-a54b-38ec1aeb2f82\",\n \"type\": \"composite\",\n \"points\": 0,\n \"achieved\": 0,\n \"can_skip\": true,\n \"skipped\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 86400,\n \"min_time_between_events\": null,\n \"consecutive\": false,\n \"goals\": {\n \"promotion_7_code_claimed\": {\n \"type\": \"goal\",\n \"points\": 0,\n \"completed\": false,\n \"required\": true,\n \"earn_count\": 1,\n \"group_id\": \"0\",\n \"skus\": null,\n \"progress\": {\n \"event_name\": \"promotion_7_code_claimed\",\n \"type\": \"count\",\n \"points\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 315360000,\n \"min_time_between_events\": null,\n \"min_time_between_events_count\": 1,\n \"consecutive\": false,\n \"achieved\": 0,\n \"current_count\": 0,\n \"total_count\": 1\n }\n }\n },\n \"groups\": {\n \"0\": {\n \"type\": \"group\",\n \"current_count\": 0,\n \"total_count\": 1,\n \"num_goals\": 1,\n \"completed\": false\n }\n }\n }\n }\n },\n {\n \"campaign_id\": 607,\n \"name\": \"Test_Multi_Codes\",\n \"group_id\": 1300,\n \"creative_id\": 1299,\n \"start_date\": \"2025-01-15 00:00:00\",\n \"end_date\": \"2125-01-15 10:24:25\",\n \"permalink\": \"mmc_rules_promotion_25\",\n \"template\": {\n \"type\": \"internal_behavior\"\n },\n \"progress\": {\n \"state\": \"qualified\",\n \"behaviors\": [\n {\n \"behavior_id\": 2071,\n \"external_behavior_id\": \"bb2155cc-6ec7-41a1-9c45-5fa83de5f85a\",\n \"event_name\": \"01421b63-2400-4558-b076-3e82972ce042\",\n \"name\": \"promotion_25_achievement\",\n \"progress\": 0,\n \"goal\": 1,\n \"active\": true\n }\n ]\n },\n \"behaviors\": {\n \"promotion_25_achievement\": {\n \"external_behavior_id\": \"bb2155cc-6ec7-41a1-9c45-5fa83de5f85a\",\n \"type\": \"composite\",\n \"points\": 0,\n \"achieved\": 0,\n \"can_skip\": true,\n \"skipped\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 86400,\n \"min_time_between_events\": null,\n \"consecutive\": false,\n \"goals\": {\n \"promotion_25_code_claimed\": {\n \"type\": \"goal\",\n \"points\": 0,\n \"completed\": false,\n \"required\": true,\n \"earn_count\": 1,\n \"group_id\": \"0\",\n \"skus\": null,\n \"progress\": {\n \"event_name\": \"promotion_25_code_claimed\",\n \"type\": \"count\",\n \"points\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 315360000,\n \"min_time_between_events\": null,\n \"min_time_between_events_count\": 1,\n \"consecutive\": false,\n \"achieved\": 0,\n \"current_count\": 0,\n \"total_count\": 1\n }\n }\n },\n \"groups\": {\n \"0\": {\n \"type\": \"group\",\n \"current_count\": 0,\n \"total_count\": 1,\n \"num_goals\": 1,\n \"completed\": false\n }\n }\n }\n },\n \"division_id\": \"root\"\n }\n ]\n }\n}"}],"_postman_id":"1f66a6d2-6542-4c65-a47f-0a20496ed3a3"},{"name":"2.2 Opt Customer in Campaign by User ID","id":"0b8712f3-4c5c-4785-ac40-d6ee07c1b68a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Basic NGY2M2UwZGU3YWFiNTY1YmM0ZTUyY2E3N2VkZGFlODJiNGUwOGRjNjowOTk0MWI4NjdhODRhMWQ4ZjM4YzVkODg0MTg3NmJhNDY4MWQ2ODUx"}],"url":"{{endpoint}}/priv/v1/apps/{{appkey}}/users/{{user_id}}/campaigns/:campaign_id/opt_in","description":"

Opts a customer into a campaign for which they are eligible. This transaction updates their status and make them able to earn the incentive associated with this campaign.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v1","apps","{{appkey}}","users","{{user_id}}","campaigns",":campaign_id","opt_in"],"host":["{{endpoint}}"],"query":[],"variable":[{"id":"06b58f9e-e230-4c94-9a4e-4b91bcd42eac","type":"any","value":"{{campaign_id}}","key":"campaign_id"}]}},"response":[],"_postman_id":"0b8712f3-4c5c-4785-ac40-d6ee07c1b68a"},{"name":"2.3 Retrieve Campaigns for External ID, Filtered to Show Progress/Behaviors V2","id":"dba6e34b-44d5-4317-bbde-80ae4ef75509","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/priv/v2/apps/{{appkey}}/external/users/{{external_id}}/campaigns/?sections=behaviors,progress","description":"

Fetches a campaign that a user is eligible for by ID (internal or external) and campaign (permalink or ID).

\n

Note that these are V2 endpoints. You can consult Implementation Notes for Retrieving Campaigns Using V2 APIs for additional implementation details.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v2","apps","{{appkey}}","external","users","{{external_id}}","campaigns",""],"host":["{{endpoint}}"],"query":[{"key":"sections","value":"behaviors,progress"}],"variable":[]}},"response":[{"id":"01ad262e-b338-436a-9a7a-36395acac2ba","name":"2.3 Retrieve Campaigns for External ID, Filtered to Show Progress/Behaviors V2","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{endpoint}}/priv/v2/apps/{{appkey}}/external/users/{{external_id}}/campaigns/?sections=behaviors,progress","host":["{{endpoint}}"],"path":["priv","v2","apps","{{appkey}}","external","users","{{external_id}}","campaigns",""],"query":[{"key":"sections","value":"behaviors,progress"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 15 Apr 2025 17:39:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4002"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"f650eee3f5cb771f34cb133d513df238\""},{"key":"X-Request-Id","value":"6a040b37-8152-4259-8779-665605a2bcb7"},{"key":"X-Runtime","value":"0.149069"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"page_size\": 20,\n \"number_of_pages\": 1,\n \"status\": \"ok\",\n \"campaigns\": [\n {\n \"campaign_id\": 607,\n \"campaign_permalink\": \"mmc_rules_promotion_25\",\n \"name\": \"Test_Multi_Codes\",\n \"status\": \"qualified\",\n \"starts_at\": \"2025-01-15 00:00:00\",\n \"qualified\": true,\n \"progress\": {\n \"state\": \"qualified\",\n \"behaviors\": [\n {\n \"behavior_id\": 2071,\n \"event_name\": \"01421b63-2400-4558-b076-3e82972ce042\",\n \"name\": \"promotion_25_achievement\",\n \"progress\": 0,\n \"goal\": 1\n }\n ]\n },\n \"behaviors\": {\n \"promotion_25_achievement\": {\n \"external_behavior_id\": \"bb2155cc-6ec7-41a1-9c45-5fa83de5f85a\",\n \"type\": \"composite\",\n \"points\": 0,\n \"achieved\": 0,\n \"can_skip\": true,\n \"skipped\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 86400,\n \"min_time_between_events\": null,\n \"consecutive\": false,\n \"goals\": {\n \"promotion_25_code_claimed\": {\n \"type\": \"goal\",\n \"points\": 0,\n \"completed\": false,\n \"required\": true,\n \"earn_count\": 1,\n \"group_id\": \"0\",\n \"skus\": null,\n \"progress\": {\n \"event_name\": \"promotion_25_code_claimed\",\n \"type\": \"count\",\n \"points\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 315360000,\n \"min_time_between_events\": null,\n \"min_time_between_events_count\": 1,\n \"consecutive\": false,\n \"achieved\": 0,\n \"current_count\": 0,\n \"total_count\": 1\n }\n }\n },\n \"groups\": {\n \"0\": {\n \"type\": \"group\",\n \"current_count\": 0,\n \"total_count\": 1,\n \"num_goals\": 1,\n \"completed\": false\n }\n }\n }\n },\n \"creative_ids\": [],\n \"division_id\": \"root\"\n },\n {\n \"campaign_id\": 324,\n \"campaign_permalink\": \"mmc_rules_promotion_7\",\n \"name\": \"[MM] $5 vouchers\",\n \"status\": \"qualified\",\n \"starts_at\": \"2024-07-29 00:00:00\",\n \"qualified\": true,\n \"progress\": {\n \"state\": \"qualified\",\n \"behaviors\": [\n {\n \"behavior_id\": 706,\n \"event_name\": \"2255345a-7cfd-41da-adf1-5b4be8c5eedb\",\n \"name\": \"promotion_7_achievement\",\n \"progress\": 0,\n \"goal\": 1\n }\n ]\n },\n \"behaviors\": {\n \"promotion_7_achievement\": {\n \"external_behavior_id\": \"1a00fdd9-09cf-46c7-a54b-38ec1aeb2f82\",\n \"type\": \"composite\",\n \"points\": 0,\n \"achieved\": 0,\n \"can_skip\": true,\n \"skipped\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 86400,\n \"min_time_between_events\": null,\n \"consecutive\": false,\n \"goals\": {\n \"promotion_7_code_claimed\": {\n \"type\": \"goal\",\n \"points\": 0,\n \"completed\": false,\n \"required\": true,\n \"earn_count\": 1,\n \"group_id\": \"0\",\n \"skus\": null,\n \"progress\": {\n \"event_name\": \"promotion_7_code_claimed\",\n \"type\": \"count\",\n \"points\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 315360000,\n \"min_time_between_events\": null,\n \"min_time_between_events_count\": 1,\n \"consecutive\": false,\n \"achieved\": 0,\n \"current_count\": 0,\n \"total_count\": 1\n }\n }\n },\n \"groups\": {\n \"0\": {\n \"type\": \"group\",\n \"current_count\": 0,\n \"total_count\": 1,\n \"num_goals\": 1,\n \"completed\": false\n }\n }\n }\n },\n \"creative_ids\": []\n },\n {\n \"campaign_id\": 288,\n \"campaign_permalink\": \"mmc_rules_promotion_6\",\n \"name\": \"FaB - SU_Promotion2_500p\",\n \"status\": \"qualified\",\n \"starts_at\": \"2024-07-08 00:00:00\",\n \"qualified\": true,\n \"progress\": {\n \"state\": \"qualified\",\n \"behaviors\": [\n {\n \"behavior_id\": 570,\n \"event_name\": \"b86e3639-5f51-4ac3-9c81-95401f090840\",\n \"name\": \"promotion_6_achievement\",\n \"progress\": 0,\n \"goal\": 1\n }\n ]\n },\n \"behaviors\": {\n \"promotion_6_achievement\": {\n \"external_behavior_id\": \"08fa41fd-017d-4174-8204-25ad4de79ba5\",\n \"type\": \"composite\",\n \"points\": 0,\n \"achieved\": 0,\n \"can_skip\": true,\n \"skipped\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 86400,\n \"min_time_between_events\": null,\n \"consecutive\": false,\n \"goals\": {\n \"promotion_6_code_claimed\": {\n \"type\": \"goal\",\n \"points\": 0,\n \"completed\": false,\n \"required\": true,\n \"earn_count\": 1,\n \"group_id\": \"0\",\n \"skus\": null,\n \"progress\": {\n \"event_name\": \"promotion_6_code_claimed\",\n \"type\": \"count\",\n \"points\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 315360000,\n \"min_time_between_events\": null,\n \"min_time_between_events_count\": 1,\n \"consecutive\": false,\n \"achieved\": 0,\n \"current_count\": 0,\n \"total_count\": 1\n }\n }\n },\n \"groups\": {\n \"0\": {\n \"type\": \"group\",\n \"current_count\": 0,\n \"total_count\": 1,\n \"num_goals\": 1,\n \"completed\": false\n }\n }\n }\n },\n \"creative_ids\": []\n },\n {\n \"campaign_id\": 26,\n \"campaign_permalink\": \"bdc1e572-171e-11ec-826d-5cf22efd8fbb\",\n \"name\": \"Eligible Offers\",\n \"status\": \"qualified\",\n \"starts_at\": \"2021-09-16 18:48:54\",\n \"ends_at\": \"2041-09-16 18:48:54\",\n \"qualified\": true,\n \"progress\": {\n \"state\": \"qualified\"\n },\n \"behaviors\": {},\n \"creative_ids\": [\n 34\n ],\n \"division_id\": \"partner\"\n }\n ]\n}"}],"_postman_id":"dba6e34b-44d5-4317-bbde-80ae4ef75509"},{"name":"2.4 Retrieve Specific Campaign for External ID, Filtered to Show Progress/Behaviors V2","id":"0a46c60a-b859-4dc2-851a-7e4d5e47441f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey}}"},{"key":"password","value":"{{secret}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{endpoint}}/priv/v2/apps/{{appkey}}/external/users/{{external_id}}/campaigns/{{campaign_id}}/?sections=behaviors,progress","description":"

Fetches a campaign that a user is eligible for by ID (internal or external) and campaign (permalink or ID).

\n

Note that these are V2 endpoints. You can consult Implementation Notes for Retrieving Campaigns Using V2 APIs for additional implementation details.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["priv","v2","apps","{{appkey}}","external","users","{{external_id}}","campaigns","{{campaign_id}}",""],"host":["{{endpoint}}"],"query":[{"key":"sections","value":"behaviors,progress"}],"variable":[]}},"response":[{"id":"946ff18b-edb0-4f33-8aa5-871c2beb92f6","name":"2.4 Retrieve Specific Campaign for External ID, Filtered to Show Progress/Behaviors V2","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{endpoint}}/priv/v2/apps/{{appkey}}/external/users/{{external_id}}/campaigns/607/?sections=behaviors,progress","host":["{{endpoint}}"],"path":["priv","v2","apps","{{appkey}}","external","users","{{external_id}}","campaigns","607",""],"query":[{"key":"sections","value":"behaviors,progress"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 15:09:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1251"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Mon, 01 Jan 1990 00:00:00 GMT"},{"key":"ETag","value":"W/\"0b1732d625f6efec1489cdf18fd034c5\""},{"key":"X-Request-Id","value":"2f16119c-acb9-4fe3-ad77-c3725b37f173"},{"key":"X-Runtime","value":"0.140848"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"campaign\": {\n \"campaign_id\": 607,\n \"campaign_permalink\": \"mmc_rules_promotion_25\",\n \"name\": \"Test_Multi_Codes\",\n \"status\": \"qualified\",\n \"starts_at\": \"2025-01-15 00:00:00\",\n \"qualified\": true,\n \"progress\": {\n \"state\": \"qualified\",\n \"behaviors\": [\n {\n \"behavior_id\": 2071,\n \"event_name\": \"01421b63-2400-4558-b076-3e82972ce042\",\n \"name\": \"promotion_25_achievement\",\n \"progress\": 0,\n \"goal\": 1\n }\n ]\n },\n \"behaviors\": {\n \"promotion_25_achievement\": {\n \"external_behavior_id\": \"bb2155cc-6ec7-41a1-9c45-5fa83de5f85a\",\n \"type\": \"composite\",\n \"points\": 0,\n \"achieved\": 0,\n \"can_skip\": true,\n \"skipped\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 86400,\n \"min_time_between_events\": null,\n \"consecutive\": false,\n \"goals\": {\n \"promotion_25_code_claimed\": {\n \"type\": \"goal\",\n \"points\": 0,\n \"completed\": false,\n \"required\": true,\n \"earn_count\": 1,\n \"group_id\": \"0\",\n \"skus\": null,\n \"progress\": {\n \"event_name\": \"promotion_25_code_claimed\",\n \"type\": \"count\",\n \"points\": 0,\n \"max_times_repeatable\": null,\n \"max_times_repeatable_per_period\": null,\n \"period\": 315360000,\n \"min_time_between_events\": null,\n \"min_time_between_events_count\": 1,\n \"consecutive\": false,\n \"achieved\": 0,\n \"current_count\": 0,\n \"total_count\": 1\n }\n }\n },\n \"groups\": {\n \"0\": {\n \"type\": \"group\",\n \"current_count\": 0,\n \"total_count\": 1,\n \"num_goals\": 1,\n \"completed\": false\n }\n }\n }\n },\n \"creative_ids\": [],\n \"division_id\": \"root\"\n }\n}"}],"_postman_id":"0a46c60a-b859-4dc2-851a-7e4d5e47441f"}],"id":"76896eb1-4a21-42c6-b493-f49812d6806e","description":"

Promotions, also called campaigns, are scheduled and targeted member engagement of any kind, including promotions, display advertising, personalized push notifications or in-app messaging. Most of the APIs featured in this grouping support the retrieval of the following:

\n
    \n
  • Promotions
    • \n
  • Promotion information
    • \n
  • Promotion progress for members
    • \n
\n

In addition, the grouping contains an endpoint for opting members into a promotion.

\n

Postman Journey: Promotions Worthy of a Look

\n

Since Marcus downloaded the application, he should be shown the promotions (campaigns) he is currently eligible to complete. As part of his application experience, the backend calls the SessionM API for getting promotions whenever Marcus opens the application. This call retrieves the current list of campaigns for which Marcus is eligible as well as those that are in progress. Part of this presentation includes rendering progress bars and promotional details in the SessionM UI.

\n","_postman_id":"76896eb1-4a21-42c6-b493-f49812d6806e"},{"name":"3. Offers","item":[{"name":"3.1 Acquisition APIs","item":[{"name":"3.1.1 Issue Offer to Single User","event":[{"listen":"prerequest","script":{"id":"8acc4947-30a0-4571-9544-c48c182f3e5a","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"97e80beb-58f7-4972-801d-58e9a73f5066","exec":["var jsonData = JSON.parse(responseBody)","postman.setGlobalVariable(\"user_offer_id\", jsonData.payload.status_list[0].user_offer_id);"],"type":"text/javascript"}}],"id":"273b30cc-9f07-4a85-83a2-a6f4df828452","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"offer_id\": \"{{offer_id}}\",\n \"quantity\": 1,\n \"issue_exact_version\": false,\n \"rollback_option\": 0,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/acquisition/issue","description":"

Issues an existing offer to a single user.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","acquisition","issue"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"d96f95f5-e528-4acb-9c36-98ad2b28dc6a","name":"3.1.1 Issue Offer to Single User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"offer_id\": \"{{offer_id}}\",\n \"quantity\": 1,\n \"issue_exact_version\": false,\n \"rollback_option\": 0,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/acquisition/issue"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:25:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"554"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"0432495e-198c-46a6-a74f-5373818516e0"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"f67786548be5fa485f63d2d17b97f332"},{"key":"Server-Timing","value":"traceparent;desc=\"00-f67786548be5fa485f63d2d17b97f332-2920ca36abd27e86-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"root_offer_id\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"division_id\": \"root\",\n \"status_summary\": \"Issuance to all (1) users was successful.\",\n \"acquire_date\": \"2025-04-16T17:25:05.7206039Z\",\n \"status_list\": [\n {\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_offer_id\": \"2840f11b-3d10-496c-914d-e5658642c63e\",\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"root_offer_id\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"division_id\": \"root\",\n \"pending_extended_data\": false,\n \"fail_reason\": 0\n }\n ]\n }\n}"}],"_postman_id":"273b30cc-9f07-4a85-83a2-a6f4df828452"},{"name":"3.1.2 Revoke Issued User Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"d6afd813-5e9b-4e9e-b431-273252058f18"}}],"id":"8bea1783-d2a8-4b8f-88c9-096f0fde8d8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/acquisition/revoke","description":"

Revokes an issued user offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","acquisition","revoke"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"2ea51065-d697-484a-88e8-6c3d9ef59ead","name":"3.1.2 Revoke Issued User Offer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/acquisition/revoke"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:25:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"261"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"911b18e4-f195-4689-9f1b-e8e5e1ae219e"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"d1da7038d7e97cb5254390f2955c7d1a"},{"key":"Server-Timing","value":"traceparent;desc=\"00-d1da7038d7e97cb5254390f2955c7d1a-c19308a17ba8257f-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_offer_id\": \"f318ad10-8d5f-4a7f-83c4-06d2db1aa907\",\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"root_offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"pos_discount_id\": \"1111\"\n }\n}"}],"_postman_id":"8bea1783-d2a8-4b8f-88c9-096f0fde8d8f"},{"name":"3.1.3 Update Issued User Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"b56f02fe-e7df-4daf-87ca-f1a889ac78ac"}}],"id":"15eda702-a534-4b2d-9624-2afa5d741a20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"custom_data\": \"{\\\"ReservationConfirmationCode\\\":\\\"TEST099\\\",\\\"ReservationCheckInDate\\\":\\\"2019-01-10\\\",\\\"ReservationCheckOutDate\\\":\\\"2019-01-12\\\",\\\"SoftRedeemed\\\":\\\"true\\\",\\\"OfferUseStartItem\\\":\\\"2019-01-10 08:00:01\\\",\\\"OfferUseEndItem\\\":\\\"2019-01-13 07:59:00\\\"}\",\n \"remain_pending_extended_data\": false,\n \"update_redemption_dates\": true,\n \"redemption_start_date\": \"2019-12-10T08:00:01\",\n \"redemption_end_date\": \"2019-12-13T07:59:00\",\n \"update_remaining_uses\": false,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/acquisition/update","description":"

Updates an issued user offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","acquisition","update"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"456a75e2-7218-430c-8e24-e7b170417f9c","name":"3.1.3 Update Issued User Offer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"custom_data\": \"{\\\"ReservationConfirmationCode\\\":\\\"TEST099\\\",\\\"ReservationCheckInDate\\\":\\\"2019-01-10\\\",\\\"ReservationCheckOutDate\\\":\\\"2019-01-12\\\",\\\"SoftRedeemed\\\":\\\"true\\\",\\\"OfferUseStartItem\\\":\\\"2019-01-10 08:00:01\\\",\\\"OfferUseEndItem\\\":\\\"2019-01-13 07:59:00\\\"}\",\n \"remain_pending_extended_data\": false,\n \"update_redemption_dates\": true,\n \"redemption_start_date\": \"2019-12-10T08:00:01\",\n \"redemption_end_date\": \"2019-12-13T07:59:00\",\n \"update_remaining_uses\": false,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/acquisition/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:25:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1062"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"c464582b-2c9b-4307-92f8-954cc5943397"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"562f3e1bbd9d6d0edc84c334b1546cf4"},{"key":"Server-Timing","value":"traceparent;desc=\"00-562f3e1bbd9d6d0edc84c334b1546cf4-04fb305ac3479fc4-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_offer_id\": \"f318ad10-8d5f-4a7f-83c4-06d2db1aa907\",\n \"user_offer\": {\n \"id\": \"f318ad10-8d5f-4a7f-83c4-06d2db1aa907\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"retailer_id\": \"e59fdc7e-2413-442e-8e38-077a2d150a5e\",\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"root_offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"status\": 1,\n \"acquire_date\": \"2025-04-14T18:51:51.8840335Z\",\n \"redemption_start_date\": \"2019-12-10T08:00:01Z\",\n \"redemption_end_date\": \"2019-12-13T07:59:00Z\",\n \"redeemed_by_store_id\": \"\",\n \"immediate_issue_and_redeem\": false,\n \"is_redeemable\": true,\n \"quantity\": 1,\n \"pending_extended_data\": false,\n \"custom_data\": \"{\\\"ReservationConfirmationCode\\\":\\\"TEST099\\\",\\\"ReservationCheckInDate\\\":\\\"2019-01-10\\\",\\\"ReservationCheckOutDate\\\":\\\"2019-01-12\\\",\\\"SoftRedeemed\\\":\\\"true\\\",\\\"OfferUseStartItem\\\":\\\"2019-01-10 08:00:01\\\",\\\"OfferUseEndItem\\\":\\\"2019-01-13 07:59:00\\\"}\",\n \"facebook_shared\": false,\n \"twitter_shared\": false,\n \"pos_offer_id\": 0,\n \"redeemed_store_id\": \"\",\n \"expiration_date\": \"2019-12-13T07:59:00Z\"\n }\n }\n}"}],"_postman_id":"15eda702-a534-4b2d-9624-2afa5d741a20"},{"name":"3.1.4 Move User Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"1219ec69-724e-4232-9dbe-a73847d311e9"}}],"id":"b364160e-23c1-4453-8cf3-494e9b0dd6ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"source_user_id\": \"{{user_id}}\",\n \"destination_user_id\": \"8e588453-1693-11ea-94c7-0242ac11000b\",\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_offers_id_list\": [\n \"{{user_offer_id}}\",\n \"4dec7399-29ec-42a4-b837-5a5ba6c3a87d\"\n ],\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/acquisition/move_user_offers","description":"

Transfers ownership of user offers from one user to another.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","acquisition","move_user_offers"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b364160e-23c1-4453-8cf3-494e9b0dd6ed"}],"id":"c0b74ad1-d930-47ab-8e36-279b1c0e9a4d","description":"

Attracting a steady stream of new prospects to your brand that you can grow and nurture into tomorrow’s loyal customers is vital for the success of a loyalty program. One of the best ways to attract more customers to participate in your loyalty program is to offer them an incentive when they enroll.

\n

Most of the endpoints in this API manages the issuance of user offers through purchases made in a mobile app, campaign pushes, or user activities. In addition, the API allows you to move, update or revoke an issued offer.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"f0dce1e8-91cd-4f9a-8c5d-04408bb20675"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"71256b76-d3c4-4e45-aaa8-4276d69c4283"}}],"_postman_id":"c0b74ad1-d930-47ab-8e36-279b1c0e9a4d"},{"name":"3.2 Info APIs","item":[{"name":"3.2.1 Fetch Offers Overveiw","event":[{"listen":"prerequest","script":{"id":"92ee6b31-5202-49cf-a782-bbfa35470b1b","exec":[""],"type":"text/javascript"}}],"id":"3704851b-8e5a-4fc8-8ddc-41dbd521093e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"search\": \"\",\n \"status_flags\": 1,\n \"offer_ids\": [\n \"{{offer_id}}\"\n ],\n \"sort_column\": 2,\n \"direction\": 0,\n \"skip\": 0,\n \"take\": 2,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/fetch_offers_overview","description":"

Fetches a collection of offer overviews.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","fetch_offers_overview"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"f151721f-0c12-4477-9c5a-c2f8fb359eb3","name":"3.2.1 Fetch Offers Overveiw","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"search\": \"\",\n \"status_flags\": 1,\n \"offer_ids\": [\n \"{{offer_id}}\"\n ],\n \"sort_column\": 2,\n \"direction\": 0,\n \"skip\": 0,\n \"take\": 2,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/fetch_offers_overview"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:24:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"626"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"419c9830-7c96-4af5-bf33-f2e9e5b371ce"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"397d480d5e5f799183bb0697be4ada9d"},{"key":"Server-Timing","value":"traceparent;desc=\"00-397d480d5e5f799183bb0697be4ada9d-b5bf1bbf7292b02d-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"total_records\": 1,\n \"results\": [\n {\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"root_offer_id\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"offer_type\": \"fixed_amount_discount\",\n \"check_level\": true,\n \"status\": 1,\n \"internal_title\": \"$5 Reward\",\n \"title\": \"$5 Reward\",\n \"description\": \"$5 Reward\",\n \"culture\": \"EN\",\n \"division_id\": \"root\",\n \"acquisition_start_date\": \"2020-08-21T18:19:00Z\",\n \"does_not_expire\": true,\n \"points\": 100,\n \"monetary_value\": 5,\n \"requires_extended_data\": false,\n \"purchase_count\": 149059,\n \"redemption_count\": 130,\n \"published_parent_offer_ids\": [],\n \"start_date\": \"2020-08-21T18:19:00Z\",\n \"valid_after_end_date\": false\n }\n ]\n }\n}"}],"_postman_id":"3704851b-8e5a-4fc8-8ddc-41dbd521093e"},{"name":"3.2.2 Fetch Single Offer","event":[{"listen":"prerequest","script":{"id":"f6e9256a-1d26-4550-bea6-96ced63eb431","exec":[""],"type":"text/javascript"}}],"id":"787f23cf-1487-4130-90f0-f891411badef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"offer_id\": \"{{offer_id}}\",\n \"culture\": \"en-US\",\n \"include_purchase_restrictions\": true,\n \"include_redemption_restrictions\": true,\n \"include_location_restrictions\": true,\n \"include_catalog_restrictions\": true,\n \"include_catalog_display_names\": true,\n \"get_active_version\": true\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/fetch_offer","description":"

Fetches a single offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","fetch_offer"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"2dd515e8-bbfe-49b4-a148-f2df61c8c138","name":"3.2.2 Fetch Single Offer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"offer_id\": \"{{offer_id}}\",\n \"culture\": \"en-US\",\n \"include_purchase_restrictions\": true,\n \"include_redemption_restrictions\": true,\n \"include_location_restrictions\": true,\n \"include_catalog_restrictions\": true,\n \"include_catalog_display_names\": true,\n \"get_active_version\": true\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/fetch_offer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:24:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1210"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"911b18e4-f195-4689-9f1b-e8e5e1ae219e"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"18ad91cba9e329b217ba2ed1be7e6720"},{"key":"Server-Timing","value":"traceparent;desc=\"00-18ad91cba9e329b217ba2ed1be7e6720-139759aae103736b-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"offer\": {\n \"offer_type_id\": \"fixed_amount_discount\",\n \"amount\": 5,\n \"allow_overage\": false,\n \"buy_count\": 0,\n \"max_recurrence\": 1,\n \"item_price_affinity\": 0,\n \"id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"root_offer_id\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"retailer_id\": \"e59fdc7e-2413-442e-8e38-077a2d150a5e\",\n \"title\": \"$5 Reward\",\n \"status\": 1,\n \"acquisition_start_date\": \"2020-08-21T18:19:00Z\",\n \"time_zone_settings\": \"{\\\"AcquisitionTimeZone\\\":\\\"Etc/UTC\\\",\\\"RedemptionTimeZone\\\":\\\"Etc/UTC\\\"}\",\n \"division_id\": \"root\",\n \"points\": 100,\n \"monetary_value\": 5,\n \"reward_store\": false,\n \"requires_extended_data\": false,\n \"all_items_eligible\": true,\n \"parent_offer_ids\": [\n \"f4260378-b85b-411a-a4e3-4a0fa200150f\",\n \"fd72e463-4ca3-4e4b-a382-7d50a4dab7d4\"\n ],\n \"check_level\": true,\n \"offer_catalog_restrictions\": [],\n \"offer_purchase_restrictions\": [],\n \"offer_redemption_restrictions\": [],\n \"offer_location_restrictions\": [],\n \"offer_location_catalog_restrictions\": [],\n \"offer_text\": [\n {\n \"id\": \"22c6f2e3-d9e5-49f4-9775-c77b0ca1c345\",\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"culture\": \"EN\",\n \"title\": \"$5 Reward\",\n \"description\": \"$5 Reward\",\n \"terms\": \"Terms and Conditions\"\n }\n ],\n \"offer_media\": [],\n \"start_date\": \"2020-08-21T18:19:00Z\",\n \"valid_after_end_date\": true\n }\n }\n}"}],"_postman_id":"787f23cf-1487-4130-90f0-f891411badef"},{"name":"3.2.3 Get Customer Profile and Offers for User","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"c21a613c-14b6-407a-be04-91dd0457758e"}}],"id":"ebb47547-cae4-4aba-944d-35a7b002ceb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"values\": {\n \"member_id\": \"{{user_id}}\"\n },\n \"include_offers\": true,\n \"skip\": 0,\n \"take\": 10,\n \"include_pending_extended_data\": true,\n \"culture\": \"en\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/get_user","description":"

Gets user offers and discounts applicable to a given transaction.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","get_user"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"ebc745e2-923c-4442-a21e-390d5da76dd9","name":"3.2.3 Get Customer Profile and Offers for User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"values\": {\n \"member_id\": \"{{user_id}}\"\n },\n \"include_offers\": true,\n \"skip\": 0,\n \"take\": 10,\n \"include_pending_extended_data\": true,\n \"culture\": \"en\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/get_user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:22:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4167"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"0432495e-198c-46a6-a74f-5373818516e0"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"4ebabe174463e9d48cd8ba630ae4ce56"},{"key":"Server-Timing","value":"traceparent;desc=\"00-4ebabe174463e9d48cd8ba630ae4ce56-a59e3576c0e5e064-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"user\": {\n \"id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"external_id\": \"MC-SESS-2025-XYZ\",\n \"opted_in\": true,\n \"activated\": false,\n \"proxy_ids\": [],\n \"identifiers\": [\n {}\n ],\n \"available_points\": 0,\n \"test_points\": 0,\n \"unclaimed_achievement_count\": 0,\n \"email\": \"mmastercarson@sessionm.com\",\n \"gender\": \"m\",\n \"dob\": \"1991-01-01\",\n \"created_at\": \"2025-04-08T13:56:39\",\n \"updated_at\": \"2025-04-08T14:24:00\",\n \"address\": \"123 Fake St.\",\n \"suspended\": false,\n \"last_name\": \"Mastercardson\",\n \"first_name\": \"Marcus\",\n \"registered_at\": \"2025-04-08T13:56:39\",\n \"profile_photo_url\": \"/images/account-neutral.png\",\n \"test_account\": false,\n \"account_status\": \"good\",\n \"referrer_code\": \"MARCUSM-FB1782-5C5EF9\",\n \"user_profile\": {\n \"_version\": 2,\n \"org\": [],\n \"favorite_activities\": [],\n \"interests\": [],\n \"clothes_size\": \"large\",\n \"preferred_channel\": [],\n \"cpg_brand_of_interest\": [],\n \"partner_type\": [],\n \"languages\": [],\n \"socioeconomic_status\": [],\n \"mcc\": [],\n \"partner\": [\n \"root\"\n ],\n \"allergens\": [\n \"nuts\",\n \"shellfish\"\n ],\n \"preferred_language\": \"english\",\n \"home_store\": \"Boston-Seaport\",\n \"email_optin\": true\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"1112223333\",\n \"phone_type\": \"mobile\",\n \"preference_flags\": [\n \"primary\"\n ]\n }\n ],\n \"user_custom_profile\": {\n \"_version\": 2,\n \"org\": [],\n \"favorite_activities\": [],\n \"interests\": [],\n \"clothes_size\": \"large\",\n \"preferred_channel\": [],\n \"cpg_brand_of_interest\": [],\n \"partner_type\": [],\n \"languages\": [],\n \"socioeconomic_status\": [],\n \"mcc\": [],\n \"partner\": [\n \"root\"\n ],\n \"allergens\": [\n \"nuts\",\n \"shellfish\"\n ],\n \"preferred_language\": \"english\",\n \"home_store\": \"Boston-Seaport\",\n \"email_optin\": true\n }\n },\n \"available_offers\": [\n {\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"offer_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"offer_type\": \"fixed_amount_discount\",\n \"redemption_start_date\": \"2020-08-21T18:19:00Z\",\n \"acquire_date\": \"2025-04-14T18:23:27.6725247Z\",\n \"is_redeemable\": true,\n \"check_level\": true,\n \"pending_extended_data\": false,\n \"division_id\": \"root\",\n \"start_date\": \"2020-08-21T18:19:00Z\",\n \"id\": \"c60e876d-bcfe-402b-90a0-d681cca9afec\",\n \"root_offer_id\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"name\": \"$5 Reward\",\n \"description\": \"$5 Reward\",\n \"terms\": \"Terms and Conditions\",\n \"culture\": \"EN\",\n \"media\": [\n {\n \"id\": \"ec83324b-8c3c-44df-82e1-71b7b78313a7\",\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"category_id\": \"00000000-0000-0000-0000-000000000000\",\n \"category_name\": \"OffersStore\",\n \"content_type\": 1,\n \"culture\": \"en-US\"\n }\n ]\n },\n {\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"offer_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"offer_type\": \"percent_discount\",\n \"redemption_start_date\": \"2025-04-14T00:00:00Z\",\n \"acquire_date\": \"2025-04-14T18:51:51.8840335Z\",\n \"is_redeemable\": true,\n \"check_level\": true,\n \"pending_extended_data\": false,\n \"division_id\": \"root\",\n \"start_date\": \"2025-04-14T00:00:00Z\",\n \"id\": \"f318ad10-8d5f-4a7f-83c4-06d2db1aa907\",\n \"root_offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"pos_discount_id\": \"1111\",\n \"name\": \"5% Off Your Entire Purchase\",\n \"description\": \"< Place Offer Description Here >\",\n \"terms\": \"< Place Terms and Conditions Here >\",\n \"culture\": \"en\",\n \"media\": [\n {\n \"id\": \"ec83324b-8c3c-44df-82e1-71b7b78313a7\",\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"category_id\": \"00000000-0000-0000-0000-000000000000\",\n \"category_name\": \"OffersStore\",\n \"content_type\": 1,\n \"culture\": \"en-US\"\n }\n ]\n },\n {\n \"offer_id\": \"d2a1e416-ffe6-42a3-90dd-1ed2dfe568d9\",\n \"offer_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"offer_type\": \"fixed_amount_discount\",\n \"is_redeemable\": true,\n \"check_level\": true,\n \"pending_extended_data\": false,\n \"division_id\": \"root\",\n \"id\": \"RSO:0c2ee80a-fa6a-49c8-9469-201e20b7d987\",\n \"root_offer_id\": \"d2a1e416-ffe6-42a3-90dd-1ed2dfe568d9\",\n \"pos_discount_id\": \"1234\",\n \"name\": \"Koalla Point Exchange\",\n \"description\": \"Pay with Points\",\n \"terms\": \"None\",\n \"culture\": \"en\",\n \"media\": [\n {\n \"id\": \"ec83324b-8c3c-44df-82e1-71b7b78313a7\",\n \"offer_id\": \"d2a1e416-ffe6-42a3-90dd-1ed2dfe568d9\",\n \"uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"category_id\": \"00000000-0000-0000-0000-000000000000\",\n \"category_name\": \"OffersStore\",\n \"content_type\": 1,\n \"culture\": \"en-US\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"ebb47547-cae4-4aba-944d-35a7b002ceb4"},{"name":"3.2.4 Get User Offers","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"a9d77d29-488f-4906-9500-354d8947ebe0"}}],"id":"3f71f8fb-837a-459b-bb98-a4990b29ce44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"skip\": 0,\n \"take\": 1000,\n \"include_pending_extended_data\": false,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/get_user_offers","description":"

Gets all user offers acquired by or issued to a given user.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","get_user_offers"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"89780b1b-815f-4410-9830-58d1783eaf64","name":"3.2.4 Get User Offers","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"skip\": 0,\n \"take\": 1000,\n \"include_pending_extended_data\": false,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/get_user_offers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:21:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2925"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"911b18e4-f195-4689-9f1b-e8e5e1ae219e"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"04c14268e1936543ba12cb7bf5101c8b"},{"key":"Server-Timing","value":"traceparent;desc=\"00-04c14268e1936543ba12cb7bf5101c8b-e57ffd8602cde62a-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_offers\": [\n {\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"offer_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"offer_type\": \"fixed_amount_discount\",\n \"redemption_start_date\": \"2020-08-21T18:19:00Z\",\n \"acquire_date\": \"2025-04-14T18:23:27.6725247Z\",\n \"is_redeemable\": true,\n \"check_level\": true,\n \"pending_extended_data\": false,\n \"division_id\": \"root\",\n \"start_date\": \"2020-08-21T18:19:00Z\",\n \"id\": \"c60e876d-bcfe-402b-90a0-d681cca9afec\",\n \"root_offer_id\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"name\": \"$5 Reward\",\n \"description\": \"$5 Reward\",\n \"terms\": \"Terms and Conditions\",\n \"culture\": \"EN\",\n \"media\": [\n {\n \"id\": \"ec83324b-8c3c-44df-82e1-71b7b78313a7\",\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"category_id\": \"00000000-0000-0000-0000-000000000000\",\n \"category_name\": \"OffersStore\",\n \"content_type\": 1,\n \"culture\": \"en-US\"\n }\n ]\n },\n {\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"offer_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"offer_type\": \"percent_discount\",\n \"redemption_start_date\": \"2025-04-14T00:00:00Z\",\n \"acquire_date\": \"2025-04-14T18:51:51.8840335Z\",\n \"is_redeemable\": true,\n \"check_level\": true,\n \"pending_extended_data\": false,\n \"division_id\": \"root\",\n \"start_date\": \"2025-04-14T00:00:00Z\",\n \"id\": \"f318ad10-8d5f-4a7f-83c4-06d2db1aa907\",\n \"root_offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"pos_discount_id\": \"1111\",\n \"name\": \"5% Off Your Entire Purchase\",\n \"description\": \"< Place Offer Description Here >\",\n \"terms\": \"< Place Terms and Conditions Here >\",\n \"culture\": \"en\",\n \"media\": [\n {\n \"id\": \"ec83324b-8c3c-44df-82e1-71b7b78313a7\",\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"category_id\": \"00000000-0000-0000-0000-000000000000\",\n \"category_name\": \"OffersStore\",\n \"content_type\": 1,\n \"culture\": \"en-US\"\n }\n ]\n },\n {\n \"offer_id\": \"d2a1e416-ffe6-42a3-90dd-1ed2dfe568d9\",\n \"offer_group_id\": \"00000000-0000-0000-0000-000000000000\",\n \"offer_type\": \"fixed_amount_discount\",\n \"is_redeemable\": true,\n \"check_level\": true,\n \"pending_extended_data\": false,\n \"division_id\": \"root\",\n \"id\": \"RSO:0c2ee80a-fa6a-49c8-9469-201e20b7d987\",\n \"root_offer_id\": \"d2a1e416-ffe6-42a3-90dd-1ed2dfe568d9\",\n \"pos_discount_id\": \"1234\",\n \"name\": \"Koalla Point Exchange\",\n \"description\": \"Pay with Points\",\n \"terms\": \"None\",\n \"culture\": \"en\",\n \"media\": [\n {\n \"id\": \"ec83324b-8c3c-44df-82e1-71b7b78313a7\",\n \"offer_id\": \"d2a1e416-ffe6-42a3-90dd-1ed2dfe568d9\",\n \"uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"category_id\": \"00000000-0000-0000-0000-000000000000\",\n \"category_name\": \"OffersStore\",\n \"content_type\": 1,\n \"culture\": \"en-US\"\n }\n ]\n }\n ],\n \"total_records\": 3,\n \"offer_groups\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"All Offers\",\n \"sort_order\": 0\n }\n ],\n \"total_points\": 0,\n \"available_points\": 0\n }\n}"}],"_postman_id":"3f71f8fb-837a-459b-bb98-a4990b29ce44"},{"name":"3.2.5 Get User Offers Details","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"893d8baa-b408-461c-8b5e-6cdc10d865e1"}}],"id":"0fac2f11-3fe0-462b-8679-da369706c0d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/get_user_offer_details","description":"

Gets user offer details implemented for selected offers.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","get_user_offer_details"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"0bb40b59-9b0e-4c55-b4bc-bc2be4f3dff6","name":"3.2.5 Get User Offers Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/get_user_offer_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:22:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1181"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"c464582b-2c9b-4307-92f8-954cc5943397"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"ac04ab6767beed823e63a2238a284dc7"},{"key":"Server-Timing","value":"traceparent;desc=\"00-ac04ab6767beed823e63a2238a284dc7-6ccd52977d92d856-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"name\": \"5% Off Your Entire Purchase\",\n \"description\": \"Check Discount\",\n \"media\": [\n {\n \"id\": \"ec83324b-8c3c-44df-82e1-71b7b78313a7\",\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"category_id\": \"00000000-0000-0000-0000-000000000000\",\n \"category_name\": \"OffersStore\",\n \"content_type\": 1,\n \"culture\": \"en-US\"\n }\n ],\n \"offer_type\": \"percent_discount\",\n \"division_id\": \"root\",\n \"check_level\": true,\n \"user_offer\": {\n \"id\": \"f318ad10-8d5f-4a7f-83c4-06d2db1aa907\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"retailer_id\": \"e59fdc7e-2413-442e-8e38-077a2d150a5e\",\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"root_offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"status\": 1,\n \"acquire_date\": \"2025-04-14T18:51:51.8840335Z\",\n \"redemption_start_date\": \"2025-04-14T00:00:00Z\",\n \"redeemed_by_store_id\": \"\",\n \"immediate_issue_and_redeem\": false,\n \"is_redeemable\": true,\n \"quantity\": 1,\n \"pending_extended_data\": false,\n \"facebook_shared\": false,\n \"twitter_shared\": false,\n \"pos_offer_id\": 0,\n \"redeemed_store_id\": \"\"\n },\n \"child_offers\": [],\n \"selected_offers\": []\n }\n}"}],"_postman_id":"0fac2f11-3fe0-462b-8679-da369706c0d6"},{"name":"3.2.6 User Offer History","event":[{"listen":"prerequest","script":{"id":"93b1491c-13d9-4a37-bb5e-9224cd4275d4","exec":[""],"type":"text/javascript"}}],"id":"750d86ee-b2bc-4f0e-a7e7-96883e9eceef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_ids\": [\n \"{{user_id}}\"\n ],\n \"sort_column\": 3,\n \"direction\": 1,\n \"skip\": 0,\n \"take\": 10,\n //\"status\": 1,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/user_offer_history","description":"

Retrieves user offer history.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","user_offer_history"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"0a0633a7-8b0c-408f-a584-4a25ed01f749","name":"3.2.6 User Offer History","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_ids\": [\n \"{{user_id}}\"\n ],\n \"sort_column\": 3,\n \"direction\": 1,\n \"skip\": 0,\n \"take\": 10,\n //\"status\": 1,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/user_offer_history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:23:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1329"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"419c9830-7c96-4af5-bf33-f2e9e5b371ce"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"10beb0ddf5df5f84c835239f798e11f9"},{"key":"Server-Timing","value":"traceparent;desc=\"00-10beb0ddf5df5f84c835239f798e11f9-3bcda71255c513cb-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"total_records\": 2,\n \"results\": [\n {\n \"title\": \"5% Off Your Entire Purchase\",\n \"description\": \"< Place Description of Offer Here >\",\n \"terms\": \"< Place Terms and Conditions Here >\",\n \"user_offer_id\": \"f318ad10-8d5f-4a7f-83c4-06d2db1aa907\",\n \"offer_id\": \"37b46497-44b4-4459-857a-5d03035af56a\",\n \"division_id\": \"root\",\n \"offer_type\": \"percent_discount\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"acquire_date\": \"2025-04-14T18:51:51.8840335Z\",\n \"redemption_start_date\": \"2025-04-14T00:00:00Z\",\n \"status\": 1,\n \"status_description\": \"Issued\",\n \"culture\": \"en\",\n \"media_uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"media_culture\": \"en-US\",\n \"skip\": 0,\n \"take\": 10\n },\n {\n \"title\": \"$5 Reward\",\n \"description\": \"$5 Reward\",\n \"terms\": \"Terms and Conditions\",\n \"user_offer_id\": \"c60e876d-bcfe-402b-90a0-d681cca9afec\",\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"division_id\": \"root\",\n \"offer_type\": \"fixed_amount_discount\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"acquire_date\": \"2025-04-14T18:23:27.6725247Z\",\n \"redemption_start_date\": \"2020-08-21T18:19:00Z\",\n \"status\": 1,\n \"status_description\": \"Issued\",\n \"culture\": \"EN\",\n \"media_uri\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"media_culture\": \"en-US\",\n \"skip\": 0,\n \"take\": 10\n }\n ]\n }\n}"}],"_postman_id":"750d86ee-b2bc-4f0e-a7e7-96883e9eceef"},{"name":"3.2.7 Fetch Offers Details","id":"547f1478-1957-42bb-81c6-65d522acfed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"culture\": \"en-US\",\n \"search\": \"\",\n \"status_flags\": 8,\n \"offer_ids\": [\n \"{{offer_id}}\"\n ],\n \"offer_type_ids\": [],\n //\"acquisition_start_date\": \"2017-08-01T00:00:00+00:00\",\n //\"acquisition_end_date\": \"2017-09-02T00:00:00+00:00\",\n \"sort_column\": 3,\n \"direction\": 1,\n \"skip\": 0,\n \"take\": 100\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/fetch_offers_details","description":"

Fetch details for multiple offers.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","fetch_offers_details"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"2b7bae19-5f85-4467-b991-bf03115b060f","name":"3.2.7 Fetch Offers Details","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"culture\": \"en-US\",\n \"search\": \"\",\n \"status_flags\": 8,\n \"offer_ids\": [\n \"{{offer_id}}\"\n ],\n \"offer_type_ids\": [],\n //\"acquisition_start_date\": \"2017-08-01T00:00:00+00:00\",\n //\"acquisition_end_date\": \"2017-09-02T00:00:00+00:00\",\n \"sort_column\": 3,\n \"direction\": 1,\n \"skip\": 0,\n \"take\": 100\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/fetch_offers_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:23:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"737"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"0432495e-198c-46a6-a74f-5373818516e0"},{"key":"App-Build-Info","value":"LocalBuild"},{"key":"Trace-Id","value":"72a57f870342f8e4bd89990671847bc1"},{"key":"Server-Timing","value":"traceparent;desc=\"00-72a57f870342f8e4bd89990671847bc1-c95be1c8968d9e16-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"total_records\": 1,\n \"results\": [\n {\n \"offer_id\": \"99da80b1-26eb-4f9d-bb81-c5d586d0c539\",\n \"root_offer_id\": \"54aa8d62-3713-489b-b38d-df696cd611b9\",\n \"offer_type\": \"fixed_amount_discount\",\n \"status\": 1,\n \"check_level\": true,\n \"time_zone_settings\": \"{\\\"AcquisitionTimeZone\\\":\\\"Etc/UTC\\\",\\\"RedemptionTimeZone\\\":\\\"Etc/UTC\\\"}\",\n \"internal_title\": \"$5 Reward\",\n \"title\": \"$5 Reward\",\n \"description\": \"$5 Reward\",\n \"culture\": \"EN\",\n \"acquisition_start_date\": \"2020-08-21T18:19:00Z\",\n \"points\": 100,\n \"monetary_value\": 5,\n \"division_id\": \"root\",\n \"acquisition_count\": 149059,\n \"redemption_count\": 130,\n \"discount_amount\": 5,\n \"discount_type\": \"$\",\n \"configured_restrictions\": 0,\n \"parents_count\": 2,\n \"children_count\": 0,\n \"requires_extended_data\": false,\n \"purchase_count\": 149059\n }\n ]\n }\n}"}],"_postman_id":"547f1478-1957-42bb-81c6-65d522acfed9"}],"id":"00269d0f-d89f-480e-b1b7-a0a963fa5e36","description":"

Once offers exist they require endpoints to get or fetch them and their details. Often they are offers associated with a specific customer, but the API can also fetch bulk offers.

\n","_postman_id":"00269d0f-d89f-480e-b1b7-a0a963fa5e36"},{"name":"3.3 Redemption APIs","item":[{"name":"3.3.1 Redeem Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"d5368b61-78ec-474d-bb5f-f161f7ef0f62"}}],"id":"e10b6383-eee7-40dd-a77f-a6c5fad742ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"transaction\": {\n \"retailer_id\": \"{{retailer_id}}\",\n \"store_id\": \"{{reward_store_id}}\",\n \"pos_transaction_key\": \"5528b048-33bf-4d6b-8b23-e4b5b9a8bb60\",\n \"guest_count\": 0,\n \"check_amount\": 11,\n \"check_discount\": 0,\n \"check_open_date\": \"2019-12-16T11:44:19.6246281Z\",\n \"status\": 0,\n \"items\": [\n {\n \"pos_item_key\": \"1\",\n \"pos_cat_key\": \"ALL\",\n \"quantity\": 1,\n \"item_amount\": 10,\n \"modifier_amount\": 0,\n \"discount_amount\": 0,\n \"tax_included_amount\": 0.7,\n \"order_date\": \"2019-12-16T11:44:19.6246281Z\",\n \"is_void\": false,\n \"is_bx_gy_consumed\": false,\n \"sub_total\": 10,\n \"external_line_item_id\": \"0\"\n },\n {\n \"pos_item_key\": \"2\",\n \"pos_cat_key\": \"ALL\",\n \"quantity\": 1,\n \"item_amount\": 1,\n \"modifier_amount\": 0,\n \"discount_amount\": 0,\n \"tax_included_amount\": 0.07,\n \"order_date\": \"2019-12-16T11:44:19.6246281Z\",\n \"is_void\": false,\n \"is_bx_gy_consumed\": false,\n \"sub_total\": 1,\n \"external_line_item_id\": \"1\"\n }\n ]\n },\n \"apply_lock_only\": false,\n \"force_redeem\": false,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/redemption/redeem","description":"

Redeems a user offer at the point of sale.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","redemption","redeem"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e10b6383-eee7-40dd-a77f-a6c5fad742ee"},{"name":"3.3.2 Reinstate Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"455cde90-fbb1-44a1-ad0e-22e9506a01d6"}}],"id":"3460a3dd-47ad-4921-b5a5-1c9f092f39ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"store_id\": \"{{store_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/redemption/reinstate","description":"

Reinstates a user offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","redemption","reinstate"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3460a3dd-47ad-4921-b5a5-1c9f092f39ab"},{"name":"3.3.3 Lock Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"a5881b23-bdea-40ea-a296-ef7042754a05"}}],"id":"2f43bc70-ae30-44f5-b80d-729fdb00299d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"store_id\": \"{{store_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"pos_transaction_key\": \"TestPOSTransactionKey\",\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/redemption/lock","description":"

Locks a user offer using a POS transaction key; offer determined by user offer ID or a redeem code. If both are included in request, only user offer ID is used to determine user offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","redemption","lock"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f43bc70-ae30-44f5-b80d-729fdb00299d"},{"name":"3.3.4 Unlock Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"53a34b66-c668-4f3f-b668-8a468fbd18d5"}}],"id":"0483a1cb-2712-4545-8d57-4dd5905c7e8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"store_id\": \"{{store_id}}\",\n \"user_offer_id\": \"{{user_offer_id}}\",\n \"force_unlock\": true,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/redemption/unlock","description":"

Unlocks user offer(s) locked with a POS transaction key; offer(s) determine user offer ID or POS transaction key. If both are included in a request, only user offer ID is used to determine user offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","redemption","unlock"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0483a1cb-2712-4545-8d57-4dd5905c7e8c"}],"id":"fd2a5a7f-a3f8-4e7d-aa15-225bde58aca3","description":"

This API handles redemptions for offers, supporting the generation of user offer codes as well as activities initiated by point of sale systems during the redemption process. Endpoints available from this API can provide the means for redeeming, locking, unlocking, and reinstating offers.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"0ad2afef-7ee9-4a91-9396-2aa80cbf4ee1"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"277032e1-e479-4f9f-bb9a-e968dca9a77b"}}],"_postman_id":"fd2a5a7f-a3f8-4e7d-aa15-225bde58aca3"},{"name":"3.4 Rewards Store APIs","item":[{"name":"3.4.1 Get Reward Stores","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"65e8c740-d7a2-419d-bdbd-883a88dfe4af"}}],"id":"4b61f304-e682-4518-9688-8bade9835a18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"search_name\": \"\",\n \"search_eligibility\": [],\n \"search_active_date\": \"2020-03-19\",\n \"filters\": [],\n \"search_reward_store_ids\": [\n ],\n \"sort_column\": \"\",\n \"sort_direction\": \"asc\",\n \"skip\": 0,\n \"take\": 10,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/rewardstores/get_reward_stores","description":"

Returns rewards stores with filtering and sorting capabilities.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","rewardstores","get_reward_stores"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b61f304-e682-4518-9688-8bade9835a18"},{"name":"3.4.2 Get Reward Store Offers","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"0b987d6a-2fbc-42f6-944f-ae944fd45866"}}],"id":"e9547ab7-d2bb-410a-9450-04b3a79328d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"reward_store_ids\": [\n \"{{store_id}}\"\n ],\n \"limit_to_only_active\": false,\n \"exclude_free_offers\": false,\n \"include_expired\": true,\n \"skip\": 0,\n \"take\": 10,\n \"sort_column\": \"\",\n \"sort_direction\": \"asc\",\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/rewardstores/get_reward_store_offers","description":"

Returns the offers in a reward store.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","rewardstores","get_reward_store_offers"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9547ab7-d2bb-410a-9450-04b3a79328d1"},{"name":"3.4.3 Get Reward Store Containing Offer","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"c6efd9e4-f5bf-41f5-8b76-29fe3afbee55"}}],"id":"acebf7d7-56a5-4887-ad21-23b26cd2666d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"offer_id\": \"{{offer_id}}\",\n \"sort_column\": \"internal_name\",\n \"sort_direction\": \"asc\",\n \"skip\": 0,\n \"take\": 10,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/rewardstores/get_reward_stores_containing_offer","description":"

Returns reward stores that contain a particular offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","rewardstores","get_reward_stores_containing_offer"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"acebf7d7-56a5-4887-ad21-23b26cd2666d"},{"name":"3.4.4 Purchase Offer from Reward Store","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"feb1f453-5191-4ef6-a342-125567cbbd32"}}],"id":"3d25fc60-e691-45f0-b06b-8385b4f46877","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"reward_store_id\": \"{{store_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"reward_store_offer_id\": \"{{store_offer_id}}\",\n \"quantity\": 1,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/rewardstores/purchase_offer","description":"

Purchases a reward store offer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","rewardstores","purchase_offer"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3d25fc60-e691-45f0-b06b-8385b4f46877"},{"name":"3.4.5 Get User Reward Stores","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"dd8b6d9d-36f4-43d2-adf9-427c497c9e73"}}],"id":"89626934-156b-4b66-b9cf-43d712a15aa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"sort_column\": \"start_date\",\n \"sort_direction\": \"asc\",\n \"skip\": 0,\n \"take\": 10,\n \"include_point_balances\": true,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/offers/api/2.0/offers/rewardstores/get_user_reward_stores","description":"

Returns the reward stores a user is eligible for.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["offers","api","2.0","offers","rewardstores","get_user_reward_stores"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"89626934-156b-4b66-b9cf-43d712a15aa3"}],"id":"239b56d1-cda9-4372-bf6b-7e95e5f8118e","description":"

Offers are can be obtained from online reward stores. The endpoints in this API can be used to get reward stores and the offers they contain. Additionally, there is an endpoint for purchasing an offer from a reward store.

\n

Postman Journey: Reward Store Shopping

\n

Brand X’s loyalty program operates a reward store where members can exchange their points for various discounts and offers. Marcus has been a loyalty member of Brand X for a while now and has been saving his points up for the largest discount Brand X provides, a discount that takes $50 off the entire.

\n

Today Marcus has enough points and opens his application to finally purchase the offer he has been saving for. When he opens his application and navigates to the reward store page, the application calls the SessionM API to get the user reward stores that Marcus is eligible for. Upon retrieving the reward store IDs, the application makes a second call to the SessionM API that gets the reward store offers and corresponding points-based cost that Marcus is eligible for. This list is then returned and displayed to Marcus in the UI.

\n

Upon seeing all of the rewards available, Marcus selects the $50 check discount. The application makes a call to the SessionM API that purchases offers, exchanging points for the offer. SessionM spends the points out of Marcus’s account and issues him the offer to his wallet. Marcus is now able to use this discount for a future purchase.

\n","_postman_id":"239b56d1-cda9-4372-bf6b-7e95e5f8118e"}],"id":"e325db0b-3077-46a2-87e7-857b482435bd","description":"

An offer is an item of value given to the customer as a reward - something that a member can earn, redeem or be presented. Offers reward members for completing a certain behavior or series of behaviors, incentivize the purchase of new items, drive more frequent purchases and build brand loyalty.

\n

Offers can be used to reward or incentivize a user with various outcome types, including closed loop discounts when integrated with a point of sale system. Additionally, they provide fulfillment capabilities, which can support various workflows for delivering an outcome to a user via manual, digital, and physical means as well as packages.

\n

The Offers domain supports the workflow in which a defined offer is issued to a user and then used to track the user offer's status through the life of the user offer. Restrictions can be placed on offers to control acquisition as well as redemption.

\n

Finally, the domain includes APIs that support integrations with external systems for a variety of workflows. For more information, consult your SesssionM team member.

\n

The APIs featured in this grouping support the management of offers in the following respects:

\n
    \n
  • Offer acquisition as applied to offer issuance
    • \n
  • Offer information
    • \n
  • Offer redemption
    • \n
  • Offer reward stores
    • \n
\n

For more information, see this workflow.

\n

Postman Journey: Best Offer He's Had All Day

\n

As part of the application integration, Brand X wants to show Marcus all of the offers he has earned and are currently available to him for future purchases. When Marcus logs into his application, the backend calls the SessionM API for getting user offers, returning a list of offers and their details that can be rendered in the UI.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6a3195d4-0daf-4a7a-abdb-ac4ffca582e9"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"50ffbaf8-8a17-46a6-adeb-a7aa244c8bb2"}}],"_postman_id":"e325db0b-3077-46a2-87e7-857b482435bd"},{"name":"4. Loyalty Rules","item":[{"name":"4.1 Tiers APIs","item":[{"name":"4.1.1 Fetches User Tier Status","id":"fa940b44-327b-44d6-b164-fd492ac9184e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"cache-control","type":"text","value":"no-cache"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"include_progress\": true,\n \"include_tier_overview\": true,\n \"include_point_account_balances\": true,\n \"culture\": \"en-US\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint_connect}}/incentives/api/1.0/user_tiers/tier_status","description":"

Retrieves the user's progress towards the next highest ranked tier level in all of a retailer's tier systems. Request may contain properties for including more detailed information on progress and tier details. Endpoint is recommended for gathering current information about a user's status within all tier systems to which they are registered for the given retailer.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","1.0","user_tiers","tier_status"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"e746b831-5295-4540-8bee-4da283a1a349","name":"4.1.1 Fetches User Tier Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"cache-control","type":"text","value":"no-cache"},{"key":"Postman-Token:","type":"text","value":"437d4272-4181-4766-99e2-f935b199f789,c8e890ab-08a9-4764-b2f1-b5cf5c8156ac","warning":"Key contains invalid whitespace characters.","disabled":true},{"key":"Postman-Token","value":": 437d4272-4181-4766-99e2-f935b199f789,c8e890ab-08a9-4764-b2f1-b5cf5c8156ac","disabled":true}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"include_progress\": true,\n \"include_tier_overview\": true,\n \"include_point_account_balances\": true,\n \"culture\": \"en-US\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint_connect}}/incentives/api/1.0/user_tiers/tier_status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:36:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2044"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"877038c5-ee6f-478a-a1eb-2ced783f34bd"},{"key":"App-Build-Info","value":"SM"},{"key":"Trace-Id","value":"08651c7b6f45d4bd1cb3225005282a6a"},{"key":"Server-Timing","value":"traceparent;desc=\"00-08651c7b6f45d4bd1cb3225005282a6a-b92b0cf5d845ea2e-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"tier_levels\": [],\n \"point_account_balances\": {\n \"retailer_id\": \"e59fdc7e-2413-442e-8e38-077a2d150a5e\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"summary\": {\n \"total_points\": 0,\n \"life_time_points\": 0\n },\n \"details\": [\n {\n \"account_name\": \"[LSBX] BlueJay Miles - Spendable Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"42b3a88a-c116-40ed-b453-009336082b71\",\n \"grouping_label\": \"bluejay_miles_spend\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Partner Bank Spendable Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"72c4d0ce-d170-4357-afd4-046f4fc2564d\",\n \"grouping_label\": \"partner_bank\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"TQ Points\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"76df898a-b375-4d61-adeb-3594bac95f51\",\n \"grouping_label\": \"Tier\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Raffle Entry\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"b2deac4c-07f0-4719-b956-42aa9f476dec\",\n \"grouping_label\": \"\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"[LSBX] BlueJay Miles - Tier Points\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"1ea9866e-e794-4b4f-8950-4db2e184eda7\",\n \"grouping_label\": \"bluejay_miles_tier\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"[Gamification] Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"747a570f-1bd0-4860-9f55-540ba8f804a0\",\n \"grouping_label\": \"\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Spendable Account\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"f4d91345-bbe8-4ca7-864d-771761be873e\",\n \"grouping_label\": \"spendable_account\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"e-bidding Tickets\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"cb8a3ded-a0aa-4bba-b891-8706eb14560b\",\n \"grouping_label\": \"\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n },\n {\n \"account_name\": \"Tier Points\",\n \"user_point_account_id\": \"\",\n \"point_account_id\": \"3d1c4e93-8b93-432f-a9c9-ab6854b57b7f\",\n \"grouping_label\": \"Tier\",\n \"available_balance\": 0,\n \"life_time_value\": 0\n }\n ]\n }\n }\n}"}],"_postman_id":"fa940b44-327b-44d6-b164-fd492ac9184e"},{"name":"4.1.2 Qualify User in Tier System","id":"01e547bd-d581-4a7b-aab8-e3a4f7998a42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"cache-control","type":"text","value":"no-cache"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"culture\": \"en-US\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint_connect}}/incentives/api/1.0/movement/qualifying","description":"

Runs qualifying criteria for a user in a tier system.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","1.0","movement","qualifying"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"01e547bd-d581-4a7b-aab8-e3a4f7998a42"},{"name":"4.1.3 Move User in Specific Tier Level","id":"d53e6ee2-90a7-4723-819e-d5c2a7312d3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"cache-control","type":"text","value":"no-cache"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"tier_system_id\": \"{{tier_system_id}}\",\n \"tier_level_id\": \"335b5466-08b2-42d3-928b-3358469b6301\",\n \"user_id\": \"{{user_id}}\",\n \"process_intermediate_levels\": true,\n \"evaluate_qualifying_rules\": true,\n \"culture\": \"en-US\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint_connect}}/incentives/api/1.0/movement/move_user","description":"

Moves a user to a specific tier level in a tier system, with configurable options.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","1.0","movement","move_user"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d53e6ee2-90a7-4723-819e-d5c2a7312d3d"},{"name":"4.1.4 Manually Trigger Tier Maintenance for Users","id":"37867dd5-0f05-4931-8f9a-46658ca11e6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"retailer_id\": \"{{retailer_id}}\",\r\n \"tier_system_id\": \"{{tier_system_id}}\",\r\n \"user_ids\":\r\n [\r\n \"efca3ed4-4bf5-11ea-9509-088340ac5d53\",\r\n \"efca3ed4-4bf5-11ea-9509-088340ac533r\"\r\n ] \r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint_connect}}/incentives/api/1.0/movement/qualifying","description":"

Runs qualifying criteria for a loyalty member in a tier system.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","1.0","movement","qualifying"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"37867dd5-0f05-4931-8f9a-46658ca11e6f"}],"id":"0aa46c3f-ec26-465d-98d7-00c14b89b5be","description":"

APIs that control a robust points system and loyalty rules engine to create custom loyalty programs. One of the key aspects of working within a tier system within a loyalty program is the use of rules, which are triggered by actions taken by loyalty members. Engagement with rules can deliver awards that allow customers to move between tiers.

\n

Postman Journey: New Tiers for Better Stuff

\n

As part of the application integration, Brand X wants to be able to show Marcus his loyalty status and his progress to the next level up. When Marcus logs into his application, the backend calls the SessionM API for tier status to return the current tiers/levels Marcus is currently in and the progress toward the next level, all of which is rendered in the SessionM UI.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"e4d88178-753c-411c-ac77-707987080065"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"669c3312-9bd6-426e-870b-22c61c809747"}}],"_postman_id":"0aa46c3f-ec26-465d-98d7-00c14b89b5be"},{"name":"4.2 Points APIs","item":[{"name":"4.2.1 Deposit User Points","event":[{"listen":"prerequest","script":{"id":"efbfc07f-68d3-4f15-946f-e951f4498338","exec":[""],"type":"text/javascript"}}],"id":"68a9dd26-2acb-475a-8497-a612233e70bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"deposit_details\": [\n {\n \"point_source_id\": \"425836cd-58e6-41b9-9816-22b987ea392f\",\n \"amount\": 100,\n \"point_account_id\": \"{{award_points_id}}\",\n \"reference_id\": \"REF-1234\",\n \"reference_type\": \"API-TEST\",\n \"rank\": 0\n }\n ],\n \"allow_partial_success\": false,\n \"disable_event_publishing\": false,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/incentives/api/2.0/user_points/deposit","description":"

Deposits points to a user's specific point accounts.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","2.0","user_points","deposit"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"68a9dd26-2acb-475a-8497-a612233e70bd"},{"name":"4.2.2 Fetch User Point Audit Log","event":[{"listen":"prerequest","script":{"id":"2b9048a5-1a30-43de-975a-219b49c7f414","exec":[""],"type":"text/javascript"}}],"id":"e8f58f98-022a-494a-9a80-2aabb1fd7034","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"point_source_ids\": [\n \"b295b211-6985-408a-a40a-2eab1d954ddf\"\n ],\n \"point_account_ids\": [\n \"9118e229-42be-4109-b731-308503aa0abf\"\n ],\n \"exclude_specified_modification_types\": true,\n \"skip\": 0,\n \"take\": 10\n}"},"url":"{{endpoint_connect}}/incentives/api/2.0/user_points/fetch_point_audit_logs","description":"

Fetches point audit logs for retailer specified in request. Request may contain filtering properties and pagination parameters to tailor response. Endpoint is recommended for retrieving itemized list of how users have spent and acquired points.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","2.0","user_points","fetch_point_audit_logs"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e8f58f98-022a-494a-9a80-2aabb1fd7034"},{"name":"4.2.3 Spend Multiple User Points","event":[{"listen":"prerequest","script":{"id":"8ff4abdb-8f56-434e-a6f0-eaad9a75ada6","exec":[""],"type":"text/javascript"}}],"id":"8251c7f6-b034-4078-b54d-acc7677024c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"spend_details\": [\n\t{\t\t\n \t\t\"amount\": 1,\n\t\t\"point_account_ids\": [\n \t\t\"{{award_points_id}}\"\n\t\t],\n\t\t\"reference_id\": \"my-test-spend-01\",\n\t\t\"reference_type\": \"api-test\",\n\t\t\"force_spend\": false,\n\t\t\"rank\" : 0,\n\t\t\"is_return\" : false\n\t}\n\t],\n \"allow_partial_success\" : false,\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/incentives/api/2.0/user_points/spend_multiple","description":"

Spends points from the specified point accounts or from the default accounts if specific accounts are not specified in the request.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","2.0","user_points","spend_multiple"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8251c7f6-b034-4078-b54d-acc7677024c3"},{"name":"4.2.4 Spend Multiple Batch User Points","event":[{"listen":"prerequest","script":{"id":"0e5d20ea-a2be-4449-944b-b9462e1016e4","exec":[""],"type":"text/javascript"}}],"id":"d774874b-8986-42c4-b610-3458a7724378","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{endpoint_connect}}/incentives/api/2.0/user_points/spend_multiple_batch","description":"

Spends in batch multiple requests to spend.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","2.0","user_points","spend_multiple_batch"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d774874b-8986-42c4-b610-3458a7724378"},{"name":"4.2.5 Fetch User Point Balance","event":[{"listen":"prerequest","script":{"id":"26276450-4698-49bc-a40d-9d208ed64d35","exec":[""],"type":"text/javascript"}}],"id":"65a53586-3461-449a-b3f6-6ce004a9e95e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"point_account_ids\": [],\n \"culture\": \"en-US\"\n}"},"url":"{{endpoint_connect}}/incentives/api/2.0/user_points/balance","description":"

Fetches the user's current and lifetime point balances in specific point accounts. The request specifies whether specific or default point accounts are tabulated. If no point accounts are specified (null or empty array), only default point accounts are considered.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","2.0","user_points","balance"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65a53586-3461-449a-b3f6-6ce004a9e95e"}],"id":"d194de2a-c656-4dcc-b6b4-91ffb011cf92","description":"

Points are units of currency that represent the amount of equity that a member has earned in a loyalty program. You can set up currencies for a loyalty program so that members earn points when they perform certain activities in the loyalty program

\n

The UserPoints API is responsible for fetching and manipulating a user's point balance, including endpoints to adjust point balances, query the current value of a user's point balance, and retrieve the activity log showing how point balances have changed.

\n

For more information, you also want to review this user points management workflow.

\n

Postman Journey: Points Make the World Go Around

\n

As part of the application integration, Brand X wants to show Marcus all of the points he has earned. When Marcus logs into his application, the backend calls the SessionM API that returns the balances of all his point accounts, rendering them in the SessionM UI.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"320a1ce4-0d37-456e-84e5-a575e03bad58"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"792b72d3-43ed-4131-aaa5-af3c30ba6d3d"}}],"_postman_id":"d194de2a-c656-4dcc-b6b4-91ffb011cf92"},{"name":"4.3 Trigger Loyalty Event","event":[{"listen":"prerequest","script":{"id":"59a608f3-61db-4bc6-b2b2-686a993461a3","exec":[""],"type":"text/javascript"}}],"id":"a3799edb-4ac3-46aa-861b-f640ab829ed5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{appkey_connect}}"},{"key":"password","value":"{{secret_connect}}"}],"advancedConfig":[{"key":"saveHelperData","value":""},{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"event_lookup\": \"PREMIUM_SUBSCRIPTION_STARTED\",\n \"culture\": \"en-US\",\n \"include_progress\": false\n}"},"url":"{{endpoint_connect}}/incentives/api/1.0/user_events/trigger_user_event","description":"

Triggers non-transactional activity (event) subject to loyalty rules without accessing core activities such as messaging or those related to campaigns. For example, users meeting criteria to enter or move between loyalty program tiers.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["incentives","api","1.0","user_events","trigger_user_event"],"host":["{{endpoint_connect}}"],"query":[],"variable":[]}},"response":[{"id":"758a5cec-d210-469e-948d-88d3790deee7","name":"4.3 Trigger Loyalty Event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retailer_id\": \"{{retailer_id}}\",\n \"user_id\": \"{{user_id}}\",\n \"event_lookup\": \"PREMIUM_SUBSCRIPTION_STARTED\",\n \"culture\": \"en-US\",\n \"include_progress\": false\n}"},"url":"{{endpoint_connect}}/incentives/api/1.0/user_events/trigger_user_event"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:07:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"389"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"eae4056b-f1f0-4c66-add7-0dd3d015a758"},{"key":"App-Build-Info","value":"SM"},{"key":"Trace-Id","value":"1e621a72ae6bf2d94d6acca4edb100a4"},{"key":"Server-Timing","value":"traceparent;desc=\"00-1e621a72ae6bf2d94d6acca4edb100a4-af26a938e7b2bd2b-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"payload\": {\n \"user_event\": {\n \"id\": \"315d64c1-42c1-4f01-b923-259663e21a51\",\n \"time_of_occurrence\": \"2025-04-16T17:07:07.2688254Z\",\n \"retailer_id\": \"E59FDC7E-2413-442E-8E38-077A2D150A5E\",\n \"event_lookup\": \"PREMIUM_SUBSCRIPTION_STARTED\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"is_session_m\": false\n },\n \"event_saved_successfully\": true,\n \"rules_processed_successfully\": true,\n \"outcomes\": []\n }\n}"}],"_postman_id":"a3799edb-4ac3-46aa-861b-f640ab829ed5"}],"id":"d16c6a4c-d6bb-41ae-955f-8101173e93a5","description":"

Loyalty rules are an important tool for managing a loyalty member's experience, which often reflects their desire to move from one tier to the next, where they can enjoy better and better outcomes. A key part of tier based loyalty programs is the currency of points, which members can accrue and then spend on whatever future purchases they choose. This API offers endpoints that manage the tier system and the member's point accounts with the following APIs:

\n
    \n

  • Fetch, qualify and move members within a tier systems

    \n
    • \n

  • Fetch, spend and deposit points on behalf of members

    \n
    • \n
\n

Additionally, from this API you can trigger events that are associated with the member's use of points.

\n","_postman_id":"d16c6a4c-d6bb-41ae-955f-8101173e93a5"},{"name":"5. POS/Ecommerce Integration","item":[{"name":"5.1 Lookup User","id":"60ac9ade-652e-4fbc-8649-f3bbb69ad090","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{cloudpos_authorization}}"}],"body":{"mode":"raw","raw":"{ \n \"store_id\":\"{{store_id}}\",\n \"client_id\":\"{{retailer_id}}\",\n \"request_id\":\"e6c8d9f3-6e17-4e22-a44c-846aa5515f41\",\n \"request_payload\":{ \n \"email\":null,\n \"phone\":null,\n \"user_id\":null,\n \"external_customer_id\":\"{{external_id}}\",\n \"transaction\":null\n }\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/lookup","description":"

Supports user lookups by exact match.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["api","2.0","lookup"],"host":["{{endpoint_cloudpos}}"],"query":[],"variable":[]}},"response":[{"id":"3fde6315-d28f-4800-abaf-63b2e58f5062","name":"5.1 Lookup User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{cloudpos_authorization}}"}],"body":{"mode":"raw","raw":"{ \n \"store_id\":\"{{store_id}}\",\n \"client_id\":\"{{retailer_id}}\",\n \"request_id\":\"2ae18476-1d72-421c-96ed-477cf1436f0e\",\n \"request_payload\":{ \n \"email\":null,\n \"phone\":null,\n \"user_id\":null,\n \"external_customer_id\":\"{{external_id}}\",\n \"transaction\":null\n }\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/lookup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:50:15 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4517"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"e0c5f073-3936-4577-b550-e23a2c563ed5"},{"key":"App-Build-Info","value":"SM"},{"key":"Trace-Id","value":"456f2d171fd7f26187ef09a458d1a0bb"},{"key":"Server-Timing","value":"traceparent;desc=\"00-456f2d171fd7f26187ef09a458d1a0bb-5a496848ae3ddd73-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"payload\": [\n {\n \"user_reference_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"user_account_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"partial_response\": false,\n \"first_name\": \"Marcus\",\n \"last_name\": \"Mastercardson\",\n \"phone\": \"1112223333\",\n \"email\": \"mmastercarson@sessionm.com\",\n \"points\": 0,\n \"profile_fields\": {\n \"_version\": 2,\n \"org\": [],\n \"favorite_activities\": [],\n \"interests\": [],\n \"clothes_size\": \"large\",\n \"preferred_channel\": [],\n \"cpg_brand_of_interest\": [],\n \"partner_type\": [],\n \"languages\": [],\n \"socioeconomic_status\": [],\n \"mcc\": [],\n \"partner\": [\n \"root\"\n ],\n \"allergens\": [\n \"nuts\",\n \"shellfish\"\n ],\n \"preferred_language\": \"english\",\n \"home_store\": \"Boston-Seaport\",\n \"email_optin\": true\n },\n \"offers\": [\n {\n \"reference_id\": \"c60e876d-bcfe-402b-90a0-d681cca9afec\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"reference_id_type\": \"userofferid\",\n \"pos_discount_id\": null,\n \"status\": \"INFO\",\n \"display_name\": \"$5 Reward\",\n \"image_url\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"discounted_line_ids\": [],\n \"discounted_line_id_quantities\": [],\n \"discount_source\": \"sessionm\",\n \"amount\": 0,\n \"stack_order\": 0,\n \"applied_time\": null,\n \"offer_custom_data\": null,\n \"user_offer_custom_data\": null\n },\n {\n \"reference_id\": \"2840f11b-3d10-496c-914d-e5658642c63e\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"reference_id_type\": \"userofferid\",\n \"pos_discount_id\": null,\n \"status\": \"INFO\",\n \"display_name\": \"$5 Reward\",\n \"image_url\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"discounted_line_ids\": [],\n \"discounted_line_id_quantities\": [],\n \"discount_source\": \"sessionm\",\n \"amount\": 0,\n \"stack_order\": 0,\n \"applied_time\": null,\n \"offer_custom_data\": null,\n \"user_offer_custom_data\": null\n },\n {\n \"reference_id\": \"161e4a9b-da2f-40b4-aedc-14b9e0586a83\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"reference_id_type\": \"userofferid\",\n \"pos_discount_id\": null,\n \"status\": \"INFO\",\n \"display_name\": \"$5 Reward\",\n \"image_url\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"discounted_line_ids\": [],\n \"discounted_line_id_quantities\": [],\n \"discount_source\": \"sessionm\",\n \"amount\": 0,\n \"stack_order\": 0,\n \"applied_time\": null,\n \"offer_custom_data\": null,\n \"user_offer_custom_data\": null\n },\n {\n \"reference_id\": \"RSO:0c2ee80a-fa6a-49c8-9469-201e20b7d987\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"reference_id_type\": \"userofferid\",\n \"pos_discount_id\": \"1234\",\n \"status\": \"INFO\",\n \"display_name\": \"Koalla Point Exchange\",\n \"image_url\": \"http://cdn.loyaltr.ee/mobile/568D75D8-F935-4A91-855B-9AE6952D5127/item_B62CB79F-1CE7-4D80-86EA-F844804803BE.png\",\n \"discounted_line_ids\": [],\n \"discounted_line_id_quantities\": [],\n \"discount_source\": \"sessionm\",\n \"amount\": 0,\n \"stack_order\": 0,\n \"applied_time\": null,\n \"offer_custom_data\": null,\n \"user_offer_custom_data\": null\n }\n ],\n \"accounts\": [\n {\n \"AccountName\": \"[LSBX] BlueJay Miles - Spendable Account\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"42b3a88a-c116-40ed-b453-009336082b71\",\n \"GroupingLabel\": \"bluejay_miles_spend\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"Partner Bank Spendable Account\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"72c4d0ce-d170-4357-afd4-046f4fc2564d\",\n \"GroupingLabel\": \"partner_bank\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"TQ Points\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"76df898a-b375-4d61-adeb-3594bac95f51\",\n \"GroupingLabel\": \"Tier\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"Raffle Entry\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"b2deac4c-07f0-4719-b956-42aa9f476dec\",\n \"GroupingLabel\": \"\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"[LSBX] BlueJay Miles - Tier Points\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"1ea9866e-e794-4b4f-8950-4db2e184eda7\",\n \"GroupingLabel\": \"bluejay_miles_tier\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"[Gamification] Account\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"747a570f-1bd0-4860-9f55-540ba8f804a0\",\n \"GroupingLabel\": \"\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"Spendable Account\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"f4d91345-bbe8-4ca7-864d-771761be873e\",\n \"GroupingLabel\": \"spendable_account\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"e-bidding Tickets\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"cb8a3ded-a0aa-4bba-b891-8706eb14560b\",\n \"GroupingLabel\": \"\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n },\n {\n \"AccountName\": \"Tier Points\",\n \"UserPointAccountID\": \"\",\n \"PointAccountID\": \"3d1c4e93-8b93-432f-a9c9-ab6854b57b7f\",\n \"GroupingLabel\": \"Tier\",\n \"AvailableBalance\": 0,\n \"LifeTimeValue\": 0\n }\n ]\n }\n ],\n \"errors\": null\n}"}],"_postman_id":"60ac9ade-652e-4fbc-8649-f3bbb69ad090"},{"name":"5.2.1 Redeem Immediate","id":"2df03354-70aa-4543-a8e5-53da55b24f67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{cloudpos_authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"store_id\": \"{{store_id}}\",\n \"client_id\": \"{{retailer_id}}\",\n \"request_id\": \"1\",\n \"request_payload\": {\n \"offer_lookup_code\": \"c60e876d-bcfe-402b-90a0-d681cca9afec\",\n \"offer_lookup_type\": \"userofferid\",\n \"transaction\": {\n \"channel\": \"STORE\",\n \"pos_employee_id\": \"1000\",\n \"table_id\": \"12\",\n \"transaction_id\": \"TXN-0000-0001\",\n \"guest_count\": \"1\",\n \"subtotal\": \"9\",\n \"tax_total\": \".35\",\n \"open_time\": \"2025-04-16 10:20:00.000\",\n \"modified_time\": \"2025-04-16 10:20:00.000\",\n \"items\": [\n {\n \"line_id\": \"0\",\n \"item_id\": \"1\",\n \"quantity\": \"1\",\n \"unit_price\": \"6\",\n \"subtotal\": \"6\",\n \"tax_included\": \".70\",\n \"modifies_line_id\": \"\"\n },\n {\n \"line_id\": \"1\",\n \"item_id\": \"139\",\n \"quantity\": \"1\",\n \"unit_price\": \"3\",\n \"subtotal\": \"3\",\n \"tax_included\": \".70\",\n \"modifies_line_id\": \"\"\n }\n ],\n \"payments\": [],\n \"discounts\": []\n }\n }\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/redeem","description":"

Allows an offer to be immediately consumed. To reverse the offer usage, you will have to call the Reinstate Offer API to re-issue the offer to the user.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["api","2.0","redeem"],"host":["{{endpoint_cloudpos}}"],"query":[],"variable":[]}},"response":[{"id":"a60eda66-b63d-472b-ae0d-b179a926d5b8","name":"5.2.1 Redeem Immediate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{cloudpos_authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"store_id\": \"{{store_id}}\",\n \"client_id\": \"{{retailer_id}}\",\n \"request_id\": \"1\",\n \"request_payload\": {\n \"offer_lookup_code\": \"c60e876d-bcfe-402b-90a0-d681cca9afec\",\n \"offer_lookup_type\": \"userofferid\",\n \"transaction\": {\n \"channel\": \"STORE\",\n \"pos_employee_id\": \"1000\",\n \"table_id\": \"12\",\n \"transaction_id\": \"TXN-0000-0001\",\n \"guest_count\": \"1\",\n \"subtotal\": \"9\",\n \"tax_total\": \".35\",\n \"open_time\": \"2025-04-16 10:20:00.000\",\n \"modified_time\": \"2025-04-16 10:20:00.000\",\n \"items\": [\n {\n \"line_id\": \"0\",\n \"item_id\": \"1\",\n \"quantity\": \"1\",\n \"unit_price\": \"6\",\n \"subtotal\": \"6\",\n \"tax_included\": \".70\",\n \"modifies_line_id\": \"\"\n },\n {\n \"line_id\": \"1\",\n \"item_id\": \"139\",\n \"quantity\": \"1\",\n \"unit_price\": \"3\",\n \"subtotal\": \"3\",\n \"tax_included\": \".70\",\n \"modifies_line_id\": \"\"\n }\n ],\n \"payments\": [],\n \"discounts\": []\n }\n }\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/redeem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Apr 2025 17:55:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"495"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"App-Instance-Id","value":"e0c5f073-3936-4577-b550-e23a2c563ed5"},{"key":"App-Build-Info","value":"SM"},{"key":"Trace-Id","value":"02d2a159db07f39461bc8f8cda9fcfb1"},{"key":"Server-Timing","value":"traceparent;desc=\"00-02d2a159db07f39461bc8f8cda9fcfb1-701afbb58f6428a6-01\""},{"key":"Access-Control-Expose-Headers","value":"Server-Timing"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"OK\",\n \"payload\": {\n \"reference_id\": \"c60e876d-bcfe-402b-90a0-d681cca9afec\",\n \"user_id\": \"4b59009c-1481-11f0-9cf6-6a36ac110002\",\n \"reference_id_type\": \"userofferid\",\n \"pos_discount_id\": null,\n \"status\": \"REDEEMED\",\n \"display_name\": \"$5 Reward\",\n \"image_url\": null,\n \"discounted_line_ids\": [\n \"1\",\n \"0\"\n ],\n \"discounted_line_id_quantities\": [\n 1,\n 1\n ],\n \"discount_source\": \"sessionm\",\n \"amount\": 5,\n \"stack_order\": 0,\n \"applied_time\": \"2025-04-16T17:55:17.1289854Z\",\n \"offer_custom_data\": null,\n \"user_offer_custom_data\": null\n },\n \"errors\": null\n}"}],"_postman_id":"2df03354-70aa-4543-a8e5-53da55b24f67"},{"name":"5.2.2 Lock Offer","id":"754b8e6e-33fc-4cf8-91e8-dbcb8e705990","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{cloudpos_authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"store_id\": \"{{store_id}}\",\n \"client_id\": \"{{retailer_id}}\",\n \"request_id\": \"1\",\n \"request_payload\": {\n \"offer_lookup_code\": \"96a15cd6-a269-4707-a86e-bd060d1f0d69\",\n \"offer_lookup_type\": \"userofferid\",\n \"transaction\": {\n \"pos_employee_id\": \"1000\",\n \"table_id\": \"12\",\n \"channel\": \"STORE\",\n \"transaction_id\": \"e98f6a50-71b5-4d4c-a1d4-490a8f8f0698\",\n \"guest_count\": \"1\",\n \"subtotal\": \"11.77\",\n \"TaxTotal\": \".77\",\n \"open_time\": \"2018-04-10 10:20:00.000\",\n \"modified_time\": \"2018-04-10 10:30:00.000\",\n \"items\": [\n {\n \"line_id\": \"0\",\n \"item_id\": \"1\",\n \"quantity\": \"1\",\n \"unit_price\": \"10\",\n \"subtotal\": \"10\",\n \"tax_included\": \".70\",\n \"modifies_line_id\": \"\"\n },\n {\n \"line_id\": \"1\",\n \"item_id\": \"2\",\n \"quantity\": \"1\",\n \"unit_price\": \"1\",\n \"subtotal\": \"1\",\n \"tax_included\": \".07\",\n \"modifies_line_id\": \"0\"\n }\n ],\n \"discounts\": [],\n \"payments\": []\n }\n }\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/lock","description":"

Allows an offer to be “locked” by a transaction and redeemed upon the finalization of that transaction.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["api","2.0","lock"],"host":["{{endpoint_cloudpos}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"754b8e6e-33fc-4cf8-91e8-dbcb8e705990"},{"name":"5.3.1 Reinstate Offer","id":"40b9ac12-835d-4416-84cc-7fe9828ef82f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{cloudpos_authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"store_id\": \"{{store_id}}\",\n \"client_id\": \"{{retailer_id}}\",\n \"request_id\": \"1\",\n \"request_payload\": {\n \"user_offer_id\": \"983d441e-6de0-44a6-9ea0-08f9523e9d79\",\n \"employee_id\": \"100\"\n }\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/reinstate","description":"

Allows an offer to be reinstated after it has been redeemed.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["api","2.0","reinstate"],"host":["{{endpoint_cloudpos}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"40b9ac12-835d-4416-84cc-7fe9828ef82f"},{"name":"5.3.2 Unlock Offer","id":"1d1c9a29-ce27-4d4b-9e8d-f048021e43a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{cloudpos_authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"store_id\": \"{{store_id}}\",\r\n \"client_id\": \"{{retailer_id}}\",\r\n \"request_id\": \"1\",\r\n \"request_payload\": {\r\n \"user_offer_id\": \"96a15cd6-a269-4707-a86e-bd060d1f0d69\",\r\n \"employee_id\": \"100\"\r\n }\r\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/unlock","description":"

Allows an offer to be “unlocked” once it had been locked.

\n

For more information, see this API endpoint documentation.

\n","urlObject":{"path":["api","2.0","unlock"],"host":["{{endpoint_cloudpos}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1d1c9a29-ce27-4d4b-9e8d-f048021e43a5"},{"name":"5.4 Send or Void Transaction","event":[{"listen":"test","script":{"exec":["var jsonData = JSON.parse(responseBody)","postman.setGlobalVariable(\"transaction_id\", jsonData.payload.transaction.id);"],"type":"text/javascript","id":"6143999e-ebd1-4a05-8d92-dfdce4143b41"}}],"id":"b82c141e-6e72-450a-b665-7fb3b7b5686e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{cloudpos_authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"store_id\": \"{{store_id}}\",\n\t\"client_id\": \"{{retailer_id}}\",\n\t\"user_id\": \"{{user_id}}\",\n\t\"request_id\": \"1\",\n\t\"request_payload\": {\n\t\t\"pos_employee_id\": \"1000\",\n\t\t\"table_id\": \"12\",\n\t\t\"channel\": \"STORE\",\n\t\t\"transaction_id\": \"FIN20191216456\",\n\t\t\"subtotal\": 30.00,\n\t\t\"tax_total\": 0.00,\n\t\t\"open_time\": \"2018-09-20 09:30:00.000\",\n\t\t\"modified_time\": \"2018-09-20 09:30:00.000\",\n\t\t\"items\": [\n\t\t\t{\n\t\t\t\"item_id\": \"0\",\n\t\t\t\"line_id\": \"1\",\n\t\t\t\"quantity\": 2.0,\n\t\t\t\"unit_price\": 15.00,\n\t\t\t\"tax_included\": 0.00,\n\t\t\t\"subtotal\": 30.00\n\t\t\t}\n\t\t],\n\t\t\"payments\": [\n\t\t\t{\n\t\t\t\"receipt_code\": \"receipt-code-0815-21-99\",\n\t\t\t\"payment_id\": \"10409444599\",\n\t\t\t\"user_id\": \"{{user_id}}\",\n\t\t\t\"user_id_type\": \"SessionM_ID\",\n\t\t\t\"amount\": 30.00,\n\t\t\t\"type\": \"CASH\",\n\t\t\t\"payment_time\": \"2018-09-20 09:30:00.2727288Z\"\n\t\t\t}\n\t\t],\n\t\t\"discounts\": [\n\t\t\t{\n\t\t\t\"reference_id\": \"offer_id_or_external\",\n\t\t\t\"reference_id_type\": \"code\",\n\t\t\t\"pos_discount_id\": \"optional_field\",\n\t\t\t\"status\": \"REDEEMED\",\n\t\t\t\"display_name\": \"BOGO\",\n\t\t\t\"discount_source\": \"POS\",\n\t\t\t\"amount\": 9.99,\n\t\t\t\"stack_order\": 0,\n\t\t\t\"applied_time\": \"2018-09-20 09:30:00.2727288Z\"\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"{{endpoint_cloudpos}}/api/2.0/send_transaction","description":"

Processes and sends SessionM transaction details when a e-commerce and POS locations are online. In the event a location is offline, these requests should be batched using the Batch Send Transaction API.

\n

Important to note that this endpoint supports sending a void transaction. Setting is_voided to to true in the request_payload object removes any related loyalty earnings.

\n

For more information, see this API documentation.

\n","urlObject":{"path":["api","2.0","send_transaction"],"host":["{{endpoint_cloudpos}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b82c141e-6e72-450a-b665-7fb3b7b5686e"}],"id":"c35884a8-f652-4a3e-a771-48e78193e7af","description":"

Point of Sale (POS) objects support connecting a 3rd party point of sale or ecommerce platform to the SessionM Platform.

\n

These POS APIs allow 3rd parties to programmatically send transaction data and associate transactions to known members of a loyalty program. The APIs enable those using such a system the ability to do the following:

\n
    \n
  • Send or void a transaction
    • \n
  • Look up a user
    • \n
  • Redeem immediately
    • \n
  • Lock an offer
    • \n
  • Unlock an offer
    • \n
  • Reinstate an offer
    • \n
\n

Postman Journey: The Point of the Sale

\n

Marcus goes to his local Brand X store and is looking to purchase a few items. After selecting his items, he heads out to the counter to make his purchase. After adding the items to the basket, the cashier asks him if he is a loyalty member, to which he replies \"yes.\"

\n

Marcus provides the cashier his phone number so she can look him up in the system. The POS system sends his phone number in a SessionM POS API that looks him up with the basket items and retrieves his profile and any points/offers currently available for use in this purchase. SessionM returns Marcus’s profile and the 5% discount Marcus received earlier from completing the survey.

\n

The cashier informs Marcus of his reward and asks him if he would like to redeem it on this purchase. Marcus agrees and the cashier applies the discount. The POS system sends a redeem call in a SessionM API call that applies the offer and calculates the discount. SessionM returns the discount value to apply. and the POS system updates the transaction.

\n

Marcus finishes paying for his purchase and the transaction is finalized at the POS system. The POS system sends the final transaction payload to SessionM using the API that sends a transaction. SessionM then runs the transaction through the loyalty and promotion rules to award any points, offers, or promotions to Marcus.

\n","_postman_id":"c35884a8-f652-4a3e-a771-48e78193e7af"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8c0d58a3-4581-4a43-b56c-2fb0ed695085"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"ad7b1141-836c-4255-adb6-070aebdd1f18"}}]}