{ "openapi": "3.2.0", "info": { "title": "TrueLoyal Loyalty API", "version": "2", "description": "The reference for every endpoint of the TrueLoyal Loyalty API, which is made up of the Admin, UI and Guest APIs. See the [Loyalty API guides](loyalty/guides/authentication.html) to create API keys and authenticate, and for rate limits and status codes.\n\nDownload the OpenAPI definition: [YAML](loyalty-openapi.yml) or [JSON](loyalty-openapi.json)." }, "servers": [ { "url": "https://api.zinrelo.com/v2" } ], "tags": [ { "name": "admin", "summary": "Admin API", "description": "Authenticated with an API key and your partner ID." }, { "name": "admin_members", "summary": "Members", "parent": "admin" }, { "name": "admin_activities", "summary": "Activities", "parent": "admin" }, { "name": "admin_rewards", "summary": "Rewards", "parent": "admin" }, { "name": "admin_transactions", "summary": "Transactions", "parent": "admin" }, { "name": "admin_tiers", "summary": "Tiers", "parent": "admin" }, { "name": "ui", "summary": "UI API", "description": "Designed for the front end. Authenticated with a JSON Web Token (JWT) and your partner ID. Responses include limited data, unlike the Admin API." }, { "name": "guest", "summary": "Guest API", "description": "Designed for the front end. Authenticated with your partner ID only, and only returns basic program details." }, { "name": "loyalty_member_events", "summary": "Members", "description": "Events about the members of your loyalty program.", "x-sourcey-hide": true }, { "name": "loyalty_transaction_events", "summary": "Transactions", "description": "Events about members' points transactions.", "x-sourcey-hide": true }, { "name": "loyalty_referral_events", "summary": "Referrals", "description": "Events about the Refer a Friend activity.", "x-sourcey-hide": true }, { "name": "loyalty_system_events", "summary": "System", "description": "Reminders and offers sent to members by the loyalty program.", "x-sourcey-hide": true }, { "name": "loyalty_campaign_events", "summary": "Campaigns", "description": "Events sent when members enter or exit a campaign.", "x-sourcey-hide": true }, { "name": "loyalty_import_events", "summary": "Imports", "description": "Events sent when a member or transaction import file finishes processing.", "x-sourcey-hide": true }, { "name": "loyalty_job_events", "summary": "Bulk Jobs", "description": "Events sent when a bulk job completes.", "x-sourcey-hide": true }, { "name": "loyalty_workflow_events", "summary": "Workflows", "description": "Events sent by workflows, and when a workflow run fails.", "x-sourcey-hide": true } ], "paths": { "/loyalty/members": { "get": { "summary": "List Members", "operationId": "list-members-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "in": "query", "description": "For the first request, you do not need to send the start_cursor in the request param. The start cursor value will be populated in the response of the API call. You can use that value to fetch the next pages.", "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "type": "integer", "format": "int32" } }, { "name": "enrolment_date", "in": "query", "description": "

This can be used to filter the list of members based on their enrolment_date. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: enrolment_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: enrolment_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: enrolment_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: enrolment_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: enrolment_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: enrolment_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"gt\":\"01/21/2022\"}" } }, { "name": "last_modified_date", "in": "query", "description": "

This can be used to filter the list of members based on their last_modified date. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: last_modified_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: last_modified_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: last_modified_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: last_modified_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: last_modified_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: last_modified_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"lt\":\"01/21/2022\"}" } }, { "name": "member_status", "in": "query", "description": "Defaults to “active”. The other acceptable values are “blocked” and “opted_out”.", "schema": { "type": "string" } }, { "name": "member_tags", "in": "query", "description": "

This can be used to filter the list of members based on the values they are tagged with. Child parameters are:

contain_all_of: Pass a single string which may contain one tag or multiple tags separated by comma to get a list of all members whose member tags list contains all the passed values in their member tags list. Example: {\"contain_all_of\":\"active\"}

contain_any_of: Pass a single string which may contain one tag or multiple tags separated by comma to get a list of all members whose member tags list contains at least one of the passed values. Example: {\"contain_any_of\":\"active\"}

contain_none_of: Pass a single string which may contain one tag or multiple tags separated by comma to get a list of all members whose member tags list contains none of the passed values. Example: {\"contain_none_of\":\"active\"}

", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 48, "next_cursor": "eyJzZWFyY2hfYWZ0ZXIiOiBbMTY3NDY0MzQzNjY2NV0sICJzdGFydF9pbmRleCI6IDJ9", "members": [ { "last_name": "Doe", "twitter_handle": "www.twitter.com/john", "revenue": 0, "lifetime_points_expired": 0, "last_modified_date": "2023-02-07T06:00:05.345Z", "available_points": 10000, "lifetime_points_earned": 10000, "pending_points": 1000, "referral_URL": "https://zinrelo.com/ref/JOH4N54C", "member_status": "active", "email_address": "johndoe@gmail.com", "id": "63e1e8e47d5790000dc0c81b", "first_name": "John", "member_tags": [ "memberadded", "membercreated" ], "referrer_code": "ANA855D6", "tier_info": { "current_period_start": "03/01/2022", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023", "qualified_points": 0 }, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "37", "Gender_Identity": "Male", "Graduation_Date": "15/12/1989 00:00:00" }, "first_purchase_date": "12/12/2021", "lifetime_points_deducted": 0, "phone_number": "+1-65070177596", "points_expiration_schedule": null, "instagram_handle": "www.instagram.com/john", "referrer_name": "Anna Scott", "aov": null, "address": { "city": "Palo Alto", "country": "US", "line2": "537 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94307" }, "deleted_date": null, "last_purchase_date": "12/02/2022", "lifetime_points_redeemed": 0, "preferred_language": "English", "number_of_purchases": 20, "number_of_redemptions": 0, "birthdate": "1900-08-26T00:00:00Z", "anniversary_date": "2023-02-07T06:00:04.589Z", "enrollment_date": "2023-02-07T06:00:04.589Z", "member_id": "5779678689" }, { "last_name": "Scott", "twitter_handle": "www.twitter.com/anna", "revenue": 15002, "lifetime_points_expired": 0, "last_modified_date": "2023-01-25T11:03:55.594Z", "available_points": 25002, "lifetime_points_earned": 25002, "pending_points": 100, "referral_URL": "https://zinrelo.com/ref/ANN1QBDY", "member_status": "active", "email_address": "annascott286@gmail.com", "id": "63d107ec354176000a742cd7", "first_name": "Anna", "member_tags": [ "exit_campaign_80456" ], "referrer_code": "463278John", "tier_info": { "current_period_start": "12/03/2022", "loyalty_tier_name": "Platinum", "loyalty_tier_id": "zrl_platinum", "current_period_end": "02/28/2024", "qualified_points": 15002 }, "custom_attributes": { "traveller_name": "Anna", "booking_date": "02/07/2023", "preferences": "British Airways", "high_value_purchase": 10000, "purchase_place": "London" }, "first_purchase_date": "2023-01-25T10:45:47.616Z", "lifetime_points_deducted": 0, "phone_number": "+1-6507017134", "points_expiration_schedule": null, "instagram_handle": "www.instagram.com/anna", "referrer_name": "John Doe", "aov": null, "address": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "15702" }, "deleted_date": null, "last_purchase_date": "2023-01-25T11:03:55.235Z", "lifetime_points_redeemed": 0, "preferred_language": "English", "number_of_purchases": 4, "number_of_redemptions": 0, "birthdate": "07/01/1997", "anniversary_date": "03/12/2022", "enrollment_date": "2023-01-25T10:43:56.665Z", "member_id": "annascott2355" } ], "more": true }, "success": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false }, "post": { "summary": "Create a Loyalty Member", "operationId": "create-a-loyalty-member-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "member_id" ], "properties": { "member_id": { "type": "string", "description": "Unique Identifier (Member ID) for the member object in the client’s system. Examples include “Customer ID”, “GUID”, “Email Address”, “Phone Number”" }, "first_name": { "type": "string", "description": "

First name of the loyalty member.

Please Note: The first name should be less than 100 characters.

" }, "last_name": { "type": "string", "description": "

Last name of the loyalty member.

Please Note: The last name should be less than 100 characters.

" }, "email_address": { "type": "string", "description": "

Email address of the loyalty member. You will not be able to use TrueLoyal’s in-built email notifications if this field is not set.

Note: Optional, if this is not marked as a unique field.

" }, "phone_number": { "type": "string", "description": "

Phone number of the loyalty member. Format : <+COUNTRY CODE - PHONE NUMBER> E.g : +1-7203332525 COUNTRY CODE defaults to +1

Note: Optional, if this is not marked as a unique field. REQUIRED if marked as unique.

", "default": "+91-##########" }, "birthdate": { "type": "string", "description": "

Birthdate of the loyalty member. Format : <MM/DD/YYYY>

Note: Our API records all date and time fields in UTC time.

", "default": "08/26/1979" }, "anniversary_date": { "type": "string", "description": "

Wedding anniversary date of the loyalty member. Format : <MM/DD/YYYY>

Note: Our API records all date and time fields in UTC time.

", "default": "12/06/2020" }, "twitter_handle": { "type": "string", "description": "Twitter username of the loyalty member." }, "preferred_language": { "type": "string", "description": "Enter your preferred language.", "default": "english" }, "instagram_handle": { "type": "string", "description": "Instagram username of the loyalty member." }, "address": { "type": "object", "description": "Address of the loyalty member. Child Parameters are as follows:", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" } } }, "referrer_code": { "type": "string", "description": "If a member has used a referral code shared by a friend, which you may have captured in the user registration form, you may pass it in referrer_code to let TrueLoyal identify the friend who referred this member." }, "member_tags": { "type": "array", "description": "

List of tags that you’d want to tag this member with.

IMPORTANT: Updating the member tags will wipe out the existing tags and add the new array of tags. If you wish to append the new tag to an existing list, please make sure you retrieve the existing tags first , add the new tag to this list of existing tags and then make the update API call.

", "items": { "type": "string" } }, "email_subscription_status": { "type": "string", "description": "Values can be ‘subscribed’ or ‘unsubscribed’. If ‘unsubscribed’, this member will not receive any email notifications triggered by TrueLoyal. Default value is ‘subscribed’." }, "member_status": { "type": "string", "description": "

Accepted values in the request are ‘active’ , ‘blocked’, ‘opted_out’. Default is ‘active’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program. 

" }, "current_tier_id": { "type": "string", "description": "The ID of the tier the member should be assigned.", "default": "zrl_silver" }, "custom_attributes": { "type": "string", "description": "

Apart from the above parameters, you can also pass in custom attributes that you want TrueLoyal to associate with this member. You will first need to define the custom member attributes and then use the internal IDs in the API to pass the data. All the custom attributes will have to be passed in a dictionary called ‘custom_attributes’ . ’For e . g - Let’s assume you define a new group called - Demographics Info and education, nationality, religion as the custom attributes in that group, the new dictionary that you can pass in the API is as follows:
“custom_attributes”: {\"wishlist\" : [\"shirt\", \"t-shirt\"], \"preferred stores\" : [\"USA\", \"France\"] }

", "default": "{\"wishlist\" : [\"shirt\", \"t-shirt\"], \"preferred stores\" : [\"USA\", \"France\"] }", "format": "json" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "lifetime_points_earned": 100, "twitter_handle": "www.twitter.com/john", "revenue": 0, "lifetime_points_expired": 0, "last_modified_date": "03/10/2023 09:24:29", "available_points": 100, "last_name": "Doe", "referral_URL": "https://zinrelo.com//ref/JOH4F47O", "member_status": "active", "referral_code": "JOH4F47O", "email_address": "johndoe@gmail.com", "id": "640af74c955940000a629a67", "first_name": "John", "number_of_activities": "", "member_tags": [ "membercreated", "memberadded", "addedmember" ], "referrer_code": "ANN9PJZN", "tier_info": { "current_period_start": "03/01/2023", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "03/31/2023", "qualified_points": 100 }, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "37", "Gender_Identity": "Male", "Graduation_Date": "15/12/1989 00:00:00" }, "referrer_ID": "6409c685c487dc000b2b3039", "first_purchase_date": null, "lifetime_points_deducted": 0, "phone_number": "+1-6507017759", "points_expiration_schedule": [ { "expiration_date": "11-Feb-2024 00:00:00", "points": 100 } ], "instagram_handle": "www.instagram.com/john", "referrer_name": "Anna Scott", "aov": 0, "address": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "12345" }, "deleted_date": null, "last_purchase_date": null, "pending_points": 200, "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 0, "gender": null, "number_of_redemptions": 0, "birthdate": "01/31/1900", "anniversary_date": "07/07/2021", "enrollment_date": "03/10/2023 09:24:28", "member_id": "greatMRT01003012", "email_subscription_status": "subscribed" }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "lifetime_points_earned": { "type": "integer", "example": 100, "default": 0 }, "twitter_handle": { "type": "string", "example": "www.twitter.com/john" }, "revenue": { "type": "integer", "example": 0, "default": 0 }, "lifetime_points_expired": { "type": "integer", "example": 0, "default": 0 }, "last_modified_date": { "type": "string", "example": "03/10/2023 09:24:29" }, "available_points": { "type": "integer", "example": 100, "default": 0 }, "last_name": { "type": "string", "example": "Doe" }, "referral_URL": { "type": "string", "example": "https://zinrelo.com//ref/JOH4F47O" }, "member_status": { "type": "string", "example": "active" }, "referral_code": { "type": "string", "example": "JOH4F47O" }, "email_address": { "type": "string", "example": "johndoe@gmail.com" }, "id": { "type": "string", "example": "640af74c955940000a629a67" }, "first_name": { "type": "string", "example": "John" }, "number_of_activities": { "type": "string", "example": "" }, "member_tags": { "type": "array", "items": { "type": "string", "example": "membercreated" } }, "referrer_code": { "type": "string", "example": "ANN9PJZN" }, "tier_info": { "type": "object", "properties": { "current_period_start": { "type": "string", "example": "03/01/2023" }, "loyalty_tier_name": { "type": "string", "example": "Silver" }, "loyalty_tier_id": { "type": "string", "example": "zrl_silver" }, "current_period_end": { "type": "string", "example": "03/31/2023" }, "qualified_points": { "type": "integer", "example": 100, "default": 0 } } }, "custom_attributes": { "type": "object", "properties": { "City_Name": { "type": "string", "example": "Paris" }, "Marital_Status": { "type": "string", "example": "Married" }, "Income_Source": { "type": "string", "example": "Service" }, "Age_In_Years": { "type": "string", "example": "37" }, "Gender_Identity": { "type": "string", "example": "Male" }, "Graduation_Date": { "type": "string", "example": "15/12/1989 00:00:00" } } }, "referrer_ID": { "type": "string", "example": "6409c685c487dc000b2b3039" }, "first_purchase_date": {}, "lifetime_points_deducted": { "type": "integer", "example": 0, "default": 0 }, "phone_number": { "type": "string", "example": "+1-6507017759" }, "points_expiration_schedule": { "type": "array", "items": { "type": "object", "properties": { "expiration_date": { "type": "string", "example": "11-Feb-2024 00:00:00" }, "points": { "type": "integer", "example": 100, "default": 0 } } } }, "instagram_handle": { "type": "string", "example": "www.instagram.com/john" }, "referrer_name": { "type": "string", "example": "Anna Scott" }, "aov": { "type": "integer", "example": 0, "default": 0 }, "address": { "type": "object", "properties": { "city": { "type": "string", "example": "Superior" }, "country": { "type": "string", "example": "US" }, "line2": { "type": "string", "example": "" }, "line1": { "type": "string", "example": "1000 S. McCaslin Blvd., Suite 301" }, "state": { "type": "string", "example": "CO" }, "postal_code": { "type": "string", "example": "12345" } } }, "deleted_date": {}, "last_purchase_date": {}, "pending_points": { "type": "integer", "example": 200, "default": 0 }, "lifetime_points_redeemed": { "type": "integer", "example": 0, "default": 0 }, "preferred_language": { "type": "string", "example": "english" }, "number_of_purchases": { "type": "integer", "example": 0, "default": 0 }, "gender": {}, "number_of_redemptions": { "type": "integer", "example": 0, "default": 0 }, "birthdate": { "type": "string", "example": "01/31/1900" }, "anniversary_date": { "type": "string", "example": "07/07/2021" }, "enrollment_date": { "type": "string", "example": "03/10/2023 09:24:28" }, "member_id": { "type": "string", "example": "greatMRT01003012" }, "email_subscription_status": { "type": "string", "example": "subscribed" } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{member_id}": { "get": { "summary": "Retrieve a Loyalty Member with Member ID", "operationId": "retrieve-a-loyalty-member-with-member-id-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "member_id", "in": "path", "description": "Enter member ID.", "schema": { "type": "string", "default": "john.doe@gmail.com" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'member_id' as idParam.", "required": true, "schema": { "type": "string", "default": "member_id" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "lifetime_points_earned": 101, "twitter_handle": "www.twitter.com/john", "revenue": 1, "lifetime_points_expired": 0, "last_modified_date": "04/04/2023 08:49:50", "available_points": 101, "pending_points": 100, "last_name": "Doe", "referral_URL": "https://shopsocially.com//ref/TES6CMHR", "member_status": "opted_out", "referral_code": "TES6CMHR", "email_address": "johndoe@gmail.com", "id": "642be3a67d79420009443840", "first_name": "John", "number_of_activities": "", "member_tags": [ "memberretrieve", "retrievedmember" ], "referrer_code": null, "tier_info": { "current_period_start": "04/01/2023", "loyalty_tier_name": "Silver_1iuytry*&^%$漢字ës", "loyalty_tier_id": "zrl_silver", "current_period_end": "04/30/2023", "qualified_points": 101 }, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "37", "Gender_Identity": "Male", "Graduation_Date": "15/12/1989 00:00:00" }, "referrer_ID": null, "first_purchase_date": "04/04/2023", "lifetime_points_deducted": 0, "phone_number": "+1-65070177596", "points_expiration_schedule": [ { "expiration_date": "5-Mar-2024 00:00:00", "points": 101 } ], "instagram_handle": "www.instagram.com/john", "referrer_name": "Anna Scott", "aov": 1, "address": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "" }, "deleted_date": null, "last_purchase_date": "04/04/2023", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 1, "gender": null, "number_of_redemptions": 0, "birthdate": "01/31/1900", "anniversary_date": "07/07/2021", "enrollment_date": "04/04/2023 08:45:26", "member_id": "greatMRT040401", "email_subscription_status": "subscribed" }, "success": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false }, "post": { "summary": "Update a Loyalty Member with Member ID", "operationId": "update-a-loyalty-member-with-member-id-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "member_id", "in": "path", "description": "Enter member ID.", "schema": { "type": "string", "default": "john.doe@gmail.com" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'member_id' as idParam.", "required": true, "schema": { "type": "string", "default": "member_id" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "description": "

First name of the loyalty member.

Please Note: The first name should be less than 100 characters.

" }, "last_name": { "type": "string", "description": "

Last name of the loyalty member.

Please Note: The last name should be less than 100 characters.

" }, "email_address": { "type": "string", "description": "Email address of the loyalty member." }, "phone_number": { "type": "string", "description": "Phone number of the loyalty member. Format : [COUNTRY CODE - PHONE NUMBER] E.g : 91-9960654555 COUNTRY CODE defaults to +1", "default": "+91-##########" }, "birthdate": { "type": "string", "description": "

Birthdate of the loyalty member. Format : <MM/DD/YYYY>

Note: Our API records all date and time fields in UTC time.

", "default": "08/26/1979" }, "anniversary_date": { "type": "string", "description": "

Wedding anniversary date of the loyalty member. Format : <MM/DD/YYYY>

Note: Our API records all date and time fields in UTC time.

", "default": "12/06/2020" }, "preferred_language": { "type": "string", "description": "Enter your preferred language.", "default": "english" }, "twitter_handle": { "type": "string", "description": "Twitter username of the loyalty member." }, "instagram_handle": { "type": "string", "description": "Instagram username of the loyalty member." }, "address": { "type": "object", "description": "Address of the loyalty member. Child Parameters are as follows:", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" } } }, "referral_code": { "type": "string", "description": "If a member used a referral code shared by a friend, which you may have captured in the user registration form, you may pass it in referral_code to let TrueLoyal identify the friend who referred this member.", "default": "wh36786" }, "member_tags": { "type": "array", "description": "

List of tags that you’d want to tag this member with.

IMPORTANT: Updating the member tags will wipe out the existing tags and add the new array of tags. If you wish to append the new tag to an existing list, please make sure you retrieve the existing tags first , add the new tag to this list of existing tags and then make the update API call.

", "items": { "type": "string" } }, "email_subscription_status": { "type": "string", "description": "Values can be ‘subscribed’ or ‘unsubscribed’ . If ‘unsubscribed’, this member will not receive any email notifications triggered by TrueLoyal." }, "member_status": { "type": "string", "description": "

Accepted values in the request are ‘active’ , ‘blocked’, ‘opted_out’. Default is ‘active’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program. 

opted_out and/or blocked members can become active by passing member_status as 'active'.

" }, "current_tier_id": { "type": "string", "description": "

The ID of the tier to which the member should be assigned.

IMPORTANT: 

If the tier that you want to assign this member to is lower than the member’s existing tier (Tier downgrade scenario), the next time the member earns points, TrueLoyal will recalculate the qualified points to check whether the member is eligible for a tier upgrade. If the tier that you want to assign this member to, is higher than the member’s existing tier (Tier Upgrade scenario), the next time this member is penalized by means of a ‘Deduct’ transaction, TrueLoyal will recalculate the qualified points to check whether the member has enough points to be on the higher tier or else, this member will be downgraded. 

If you have period based tiers, at the end of every interval, TrueLoyal will check whether the member has enough qualified points to be on a certain tier. If a member does not have enough qualified points, they will be downgraded.

", "default": "zrl_gold" }, "custom_attributes": { "type": "string", "description": "

Apart from the above parameters, you can also update the custom attributes that you would have already defined. Let’s assume, you had defined a new group called - Demographics Info (demographics_info) and education, nationality, religion as the custom attributes in the group and you wish to update the nationality, you can update it as follows: 

“custom_attributes”: { “nationality” : “USA” }

Note: Only the parameters/attributes that you pass in the API request will be updated.

", "default": "{\"nationality\" : \"USA\", \"Gender\" : \"Male\"}", "format": "json" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "lifetime_points_earned": 10000, "twitter_handle": "www.twitter.com/john", "revenue": 0, "lifetime_points_expired": 0, "last_modified_date": "02/07/2023 06:00:05", "available_points": 10000, "pending_points": 100, "last_name": "Doe", "referral_URL": "https://zinrelo.com/ref/JOH4N54C", "member_status": "active", "referral_code": "JOH4N54C", "email_address": "johndoe@gmail.com", "id": "63e1e8e47d5790000dc0c81b", "first_name": "John", "number_of_activities": "", "member_tags": [ "memberadded", "membercreated" ], "referrer_code": "ANA855D6", "tier_info": { "current_period_start": "03/01/2022", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023", "qualified_points": 1000 }, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "37", "Gender_Identity": "Male", "Graduation_Date": "15/12/1989 00:00:00" }, "referrer_ID": "63dce02f1c31f902817d0118", "first_purchase_date": "09/30/2022", "lifetime_points_deducted": 0, "phone_number": "+1-6507017759", "points_expiration_schedule": [ { "expiration_date": "7-Feb-2024 00:00:00", "points": 10000 } ], "instagram_handle": "www.instagram.com/john", "referrer_name": "Anna Scott", "aov": 0, "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "deleted_date": null, "last_purchase_date": "12/18/2022", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 0, "number_of_redemptions": 0, "birthdate": "08/26/1900", "anniversary_date": "10/17/2022", "enrollment_date": "10/17/2022 09:59:03", "member_id": "76543", "email_subscription_status": "subscribed" } } }, "schema": { "type": "object", "properties": { "lifetime_points_earned": { "type": "integer", "example": 10000, "default": 0 }, "twitter_handle": { "type": "string", "example": "www.twitter.com/john" }, "revenue": { "type": "integer", "example": 0, "default": 0 }, "lifetime_points_expired": { "type": "integer", "example": 0, "default": 0 }, "last_modified_date": { "type": "string", "example": "02/07/2023 06:00:05" }, "available_points": { "type": "integer", "example": 10000, "default": 0 }, "pending_points": { "type": "integer", "example": 100, "default": 0 }, "last_name": { "type": "string", "example": "Doe" }, "referral_URL": { "type": "string", "example": "https://zinrelo.com/ref/JOH4N54C" }, "member_status": { "type": "string", "example": "active" }, "referral_code": { "type": "string", "example": "JOH4N54C" }, "email_address": { "type": "string", "example": "johndoe@gmail.com" }, "id": { "type": "string", "example": "63e1e8e47d5790000dc0c81b" }, "first_name": { "type": "string", "example": "John" }, "number_of_activities": { "type": "string", "example": "" }, "member_tags": { "type": "array", "items": { "type": "string", "example": "memberadded" } }, "referrer_code": { "type": "string", "example": "ANA855D6" }, "tier_info": { "type": "object", "properties": { "current_period_start": { "type": "string", "example": "03/01/2022" }, "loyalty_tier_name": { "type": "string", "example": "Silver" }, "loyalty_tier_id": { "type": "string", "example": "zrl_silver" }, "current_period_end": { "type": "string", "example": "02/28/2023" }, "qualified_points": { "type": "integer", "example": 1000, "default": 0 } } }, "custom_attributes": { "type": "object", "properties": { "City_Name": { "type": "string", "example": "Paris" }, "Marital_Status": { "type": "string", "example": "Married" }, "Income_Source": { "type": "string", "example": "Service" }, "Age_In_Years": { "type": "string", "example": "37" }, "Gender_Identity": { "type": "string", "example": "Male" }, "Graduation_Date": { "type": "string", "example": "15/12/1989 00:00:00" } } }, "referrer_ID": { "type": "string", "example": "63dce02f1c31f902817d0118" }, "first_purchase_date": { "type": "string", "example": "09/30/2022" }, "lifetime_points_deducted": { "type": "integer", "example": 0, "default": 0 }, "phone_number": { "type": "string", "example": "+1-6507017759" }, "points_expiration_schedule": { "type": "array", "items": { "type": "object", "properties": { "expiration_date": { "type": "string", "example": "7-Feb-2024 00:00:00" }, "points": { "type": "integer", "example": 10000, "default": 0 } } } }, "instagram_handle": { "type": "string", "example": "www.instagram.com/john" }, "referrer_name": { "type": "string", "example": "Anna Scott" }, "aov": { "type": "integer", "example": 0, "default": 0 }, "address": { "type": "object", "properties": { "city": { "type": "string", "example": "Palo Alto" }, "country": { "type": "string", "example": "US" }, "line2": { "type": "string", "example": "530 Lytton Ave" }, "line1": { "type": "string", "example": "Suite #200" }, "state": { "type": "string", "example": "CA" }, "postal_code": { "type": "string", "example": "94301" } } }, "deleted_date": {}, "last_purchase_date": { "type": "string", "example": "12/18/2022" }, "lifetime_points_redeemed": { "type": "integer", "example": 0, "default": 0 }, "preferred_language": { "type": "string", "example": "english" }, "number_of_purchases": { "type": "integer", "example": 0, "default": 0 }, "number_of_redemptions": { "type": "integer", "example": 0, "default": 0 }, "birthdate": { "type": "string", "example": "08/26/1900" }, "anniversary_date": { "type": "string", "example": "10/17/2022" }, "enrollment_date": { "type": "string", "example": "10/17/2022 09:59:03" }, "member_id": { "type": "string", "example": "76543" }, "email_subscription_status": { "type": "string", "example": "subscribed" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false }, "delete": { "summary": "Delete a Loyalty Member with Member ID", "operationId": "delete-a-loyalty-member-with-member-id-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "member_id", "in": "path", "description": "Enter member ID.", "schema": { "type": "string", "default": "john.doe@gmail.com" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'member_id' as idParam.", "required": true, "schema": { "type": "string", "default": "member_id" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "id": "63e1e8e47d5790000dc0c81b", "member_status": "deleted" }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "63e1e8e47d5790000dc0c81b" }, "member_status": { "type": "string", "example": "deleted" } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{id}": { "get": { "summary": "Retrieve a Loyalty Member with TrueLoyal-generated ID", "operationId": "retrieve-a-loyalty-member-with-zinrelo-generated-id-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add TrueLoyal generated ID.", "schema": { "type": "string", "default": "62d6439adfa6b74ab18eb1a6" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "lifetime_points_earned": 101, "twitter_handle": "www.twitter.com/john", "revenue": 1, "lifetime_points_expired": 0, "last_modified_date": "04/04/2023 08:49:50", "available_points": 101, "pending_points": 100, "last_name": "Doe", "referral_URL": "https://shopsocially.com//ref/TES6CMHR", "member_status": "opted_out", "referral_code": "TES6CMHR", "email_address": "johndoe@gmail.com", "id": "642be3a67d79420009443840", "first_name": "John", "number_of_activities": "", "member_tags": [ "memberretrieve", "retrievedmember" ], "referrer_code": null, "tier_info": { "current_period_start": "04/01/2023", "loyalty_tier_name": "Silver_1iuytry*&^%$漢字ës", "loyalty_tier_id": "zrl_silver", "current_period_end": "04/30/2023", "qualified_points": 101 }, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "37", "Gender_Identity": "Male", "Graduation_Date": "15/12/1989 00:00:00" }, "referrer_ID": null, "first_purchase_date": "04/04/2023", "lifetime_points_deducted": 0, "phone_number": "+1-65070177596", "points_expiration_schedule": [ { "expiration_date": "5-Mar-2024 00:00:00", "points": 101 } ], "instagram_handle": "www.instagram.com/john", "referrer_name": "Anna Scott", "aov": 1, "address": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "" }, "deleted_date": null, "last_purchase_date": "04/04/2023", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 1, "gender": null, "number_of_redemptions": 0, "birthdate": "01/31/1900", "anniversary_date": "07/07/2021", "enrollment_date": "04/04/2023 08:45:26", "member_id": "greatMRT040401", "email_subscription_status": "subscribed" }, "success": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false }, "post": { "summary": "Update a Loyalty Member with TrueLoyal-generated ID", "operationId": "update-a-loyalty-member-with-zinrelo-generated-id-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add TrueLoyal generated ID.", "schema": { "type": "string", "default": "62d6439adfa6b74ab18eb1a6" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "first_name": { "type": "string", "description": "

First name of the loyalty member.

Please Note: The first name should be less than 100 characters.

" }, "last_name": { "type": "string", "description": "

Last name of the loyalty member.

Please Note: The last name should be less than 100 characters.

" }, "email_address": { "type": "string", "description": "Email address of the loyalty member." }, "phone_number": { "type": "string", "description": "Phone number of the loyalty member. Format : [COUNTRY CODE - PHONE NUMBER] E.g : 91-9960654555 COUNTRY CODE defaults to +1", "default": "+91-##########" }, "birthdate": { "type": "string", "description": "

Birthdate of the loyalty member. Format : <MM/DD/YYYY>

Note: Our API records all date and time fields in UTC time.

", "default": "08/26/1979" }, "anniversary_date": { "type": "string", "description": "

Wedding anniversary date of the loyalty member. Format : <MM/DD/YYYY>

Note: Our API records all date and time fields in UTC time.

", "default": "12/06/2020" }, "preferred_language": { "type": "string", "description": "Enter your preferred language.", "default": "english" }, "twitter_handle": { "type": "string", "description": "Twitter username of the loyalty member." }, "instagram_handle": { "type": "string", "description": "Instagram username of the loyalty member." }, "address": { "type": "object", "description": "Address of the loyalty member. Child Parameters are as follows:", "properties": { "line1": { "type": "string" }, "line2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "postal_code": { "type": "string" } } }, "referral_code": { "type": "string", "description": "If a member used a referral code shared by a friend, which you may have captured in the user registration form, you may pass it in referrer_code to let TrueLoyal identify the friend who referred this member.", "default": "wh36786" }, "member_tags": { "type": "array", "description": "

List of tags that you’d want to tag this member with.

IMPORTANT: Updating the member tags will wipe out the existing tags and add the new array of tags. If you wish to append the new tag to an existing list, please make sure you retrieve the existing tags first , add the new tag to this list of existing tags and then make the update API call.

", "items": { "type": "string" } }, "email_subscription_status": { "type": "string", "description": "Values can be ‘subscribed’ or ‘unsubscribed’ . If ‘unsubscribed’, this member will not receive any email notifications triggered by TrueLoyal." }, "member_status": { "type": "string", "description": "

Accepted values in the request are ‘active’ , ‘blocked’, ‘opted_out’. Default is ‘active’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program. 

opted_out and/or blocked members can become active by passing member_status as 'active'.

" }, "current_tier_id": { "type": "string", "description": "

The ID of the tier to which the member should be assigned.

IMPORTANT: 

If the tier that you want to assign this member to is lower than the member’s existing tier (Tier downgrade scenario), the next time the member earns points, TrueLoyal will recalculate the qualified points to check whether the member is eligible for a tier upgrade. If the tier that you want to assign this member to, is higher than the member’s existing tier (Tier Upgrade scenario), the next time this member is penalized by means of a ‘Deduct’ transaction, TrueLoyal will recalculate the qualified points to check whether the member has enough points to be on the higher tier or else, this member will be downgraded. 

If you have period based tiers, at the end of every interval, TrueLoyal will check whether the member has enough qualified points to be on a certain tier. If a member does not have enough qualified points, they will be downgraded.

", "default": "zrl_gold" }, "custom_attributes": { "type": "string", "description": "

Apart from the above parameters, you can also update the custom attributes that you would have already defined. Let’s assume, you had defined a new group called - Demographics Info (demographics_info) and education, nationality, religion as the custom attributes in the group and you wish to update the nationality, you can update it as follows: 

\"custom_attributes\": { \"nationality\" : \"USA\" }

Note: Only the parameters/attributes that you pass in the API request will be updated.

", "default": "{\"nationality\" : \"USA\", \"Gender\" : \"Male\"}", "format": "json" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "lifetime_points_earned": 10000, "twitter_handle": "www.twitter.com/john", "revenue": 0, "lifetime_points_expired": 0, "last_modified_date": "02/07/2023 06:00:05", "available_points": 10000, "pending_points": 100, "last_name": "Doe", "referral_URL": "https://zinrelo.com/ref/JOH4N54C", "member_status": "active", "referral_code": "JOH4N54C", "email_address": "johndoe@gmail.com", "id": "63e1e8e47d5790000dc0c81b", "first_name": "John", "number_of_activities": "", "member_tags": [ "memberadded", "membercreated" ], "referrer_code": "ANA855D6", "tier_info": { "current_period_start": "03/01/2022", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023", "qualified_points": 1000 }, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "37", "Gender_Identity": "Male", "Graduation_Date": "15/12/1989 00:00:00" }, "referrer_ID": "63dce02f1c31f902817d0118", "first_purchase_date": "09/30/2022", "lifetime_points_deducted": 0, "phone_number": "+1-6507017759", "points_expiration_schedule": [ { "expiration_date": "7-Feb-2024 00:00:00", "points": 10000 } ], "instagram_handle": "www.instagram.com/john", "referrer_name": "Anna Scott", "aov": 0, "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "deleted_date": null, "last_purchase_date": "12/18/2022", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 0, "number_of_redemptions": 0, "birthdate": "08/26/1900", "anniversary_date": "10/17/2022", "enrollment_date": "10/17/2022 09:59:03", "member_id": "76543", "email_subscription_status": "subscribed" } } }, "schema": { "type": "object", "properties": { "lifetime_points_earned": { "type": "integer", "example": 10000, "default": 0 }, "twitter_handle": { "type": "string", "example": "www.twitter.com/john" }, "revenue": { "type": "integer", "example": 0, "default": 0 }, "lifetime_points_expired": { "type": "integer", "example": 0, "default": 0 }, "last_modified_date": { "type": "string", "example": "02/07/2023 06:00:05" }, "available_points": { "type": "integer", "example": 10000, "default": 0 }, "pending_points": { "type": "integer", "example": 100, "default": 0 }, "last_name": { "type": "string", "example": "Doe" }, "referral_URL": { "type": "string", "example": "https://zinrelo.com/ref/JOH4N54C" }, "member_status": { "type": "string", "example": "active" }, "referral_code": { "type": "string", "example": "JOH4N54C" }, "email_address": { "type": "string", "example": "johndoe@gmail.com" }, "id": { "type": "string", "example": "63e1e8e47d5790000dc0c81b" }, "first_name": { "type": "string", "example": "John" }, "number_of_activities": { "type": "string", "example": "" }, "member_tags": { "type": "array", "items": { "type": "string", "example": "memberadded" } }, "referrer_code": { "type": "string", "example": "ANA855D6" }, "tier_info": { "type": "object", "properties": { "current_period_start": { "type": "string", "example": "03/01/2022" }, "loyalty_tier_name": { "type": "string", "example": "Silver" }, "loyalty_tier_id": { "type": "string", "example": "zrl_silver" }, "current_period_end": { "type": "string", "example": "02/28/2023" }, "qualified_points": { "type": "integer", "example": 1000, "default": 0 } } }, "custom_attributes": { "type": "object", "properties": { "City_Name": { "type": "string", "example": "Paris" }, "Marital_Status": { "type": "string", "example": "Married" }, "Income_Source": { "type": "string", "example": "Service" }, "Age_In_Years": { "type": "string", "example": "37" }, "Gender_Identity": { "type": "string", "example": "Male" }, "Graduation_Date": { "type": "string", "example": "15/12/1989 00:00:00" } } }, "referrer_ID": { "type": "string", "example": "63dce02f1c31f902817d0118" }, "first_purchase_date": { "type": "string", "example": "09/30/2022" }, "lifetime_points_deducted": { "type": "integer", "example": 0, "default": 0 }, "phone_number": { "type": "string", "example": "+1-6507017759" }, "points_expiration_schedule": { "type": "array", "items": { "type": "object", "properties": { "expiration_date": { "type": "string", "example": "7-Feb-2024 00:00:00" }, "points": { "type": "integer", "example": 10000, "default": 0 } } } }, "instagram_handle": { "type": "string", "example": "www.instagram.com/john" }, "referrer_name": { "type": "string", "example": "Anna Scott" }, "aov": { "type": "integer", "example": 0, "default": 0 }, "address": { "type": "object", "properties": { "city": { "type": "string", "example": "Palo Alto" }, "country": { "type": "string", "example": "US" }, "line2": { "type": "string", "example": "530 Lytton Ave" }, "line1": { "type": "string", "example": "Suite #200" }, "state": { "type": "string", "example": "CA" }, "postal_code": { "type": "string", "example": "94301" } } }, "deleted_date": {}, "last_purchase_date": { "type": "string", "example": "12/18/2022" }, "lifetime_points_redeemed": { "type": "integer", "example": 0, "default": 0 }, "preferred_language": { "type": "string", "example": "english" }, "number_of_purchases": { "type": "integer", "example": 0, "default": 0 }, "number_of_redemptions": { "type": "integer", "example": 0, "default": 0 }, "birthdate": { "type": "string", "example": "08/26/1900" }, "anniversary_date": { "type": "string", "example": "10/17/2022" }, "enrollment_date": { "type": "string", "example": "10/17/2022 09:59:03" }, "member_id": { "type": "string", "example": "76543" }, "email_subscription_status": { "type": "string", "example": "subscribed" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false }, "delete": { "summary": "Delete a Loyalty Member with TrueLoyal-generated ID", "operationId": "delete-a-loyalty-member-with-zinrelo-generated-id-1", "tags": [ "admin_members" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add Trueloyal generated ID.", "schema": { "type": "string", "default": "62d6439adfa6b74ab18eb1a6" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "id": "63d107ec354176000a742cd7", "member_status": "deleted" }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "example": "63d107ec354176000a742cd7" }, "member_status": { "type": "string", "example": "deleted" } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "reason": "643e802acd2a36000b07f9829 is not a valid id.", "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } }, "schema": { "type": "object", "properties": { "reason": { "type": "string", "example": "643e802acd2a36000b07f9829 is not a valid id." }, "error_code": { "type": "string", "example": "INVALID_REQUEST_PARAMETER_VALUES" }, "success": { "type": "boolean", "example": false, "default": true } } } } } } }, "deprecated": false } }, "/loyalty/activities": { "get": { "summary": "List all activities", "operationId": "list-all-activities-1", "tags": [ "admin_activities" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "in": "query", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "type": "integer", "format": "int32" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 25, "activities": [ { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-08 16:55:20.470000", "is_active": true, "metadata": { "Category": "Chocolate Cake" }, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "Product Category", "value": "Blue Rainbow" }, { "operator": "Between", "attribute": "Transaction Date", "value": "3/8/2023-3/8/2023" }, { "operator": "Equals", "attribute": "nationality", "value": "American" } ], "rule_value": 10 }, { "rule_type": "Fixed Points", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 30 } ], "rule_value": 500 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Less Than", "attribute": "Order Value", "value": 100 } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "11/1/2022" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "1/1/2023" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Gold Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 2 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "Platinum Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_platinum" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "extra_config": {}, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, { "points_config": { "points": 1000, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you follow us on Instagram.", "activity_id": "follow_on_instagram", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-10-30 07:09:02.212000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "LIFETIME" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.886000", "activity_name": "Follow on Instagram", "extra_config": { "business_instagram_username": "pallavi" }, "id": "604f5a3b8152252216f5c1a4", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you create your loyalty account.", "activity_id": "created_an_account", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-06-14 09:03:33.343000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Between", "attribute": "Enrollment Date", "value": "5/3/2021-5/7/2021" } ], "rule_value": 12 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 1 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.812000", "activity_name": "Account Creation", "extra_config": {}, "id": "604f5a3b8152252216f5c19a", "activity_benefit_type": "points" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "", "activity_id": "9d768_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-06-13 17:13:03.968000", "is_active": false, "metadata": { "Category": "Survey" }, "rules_config": null, "approval_method": "immediate", "created_date": "2021-03-16 07:17:05.038000", "activity_name": "", "extra_config": {}, "id": "60505b71bb711d656ab9d252", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you share us on Twitter.", "activity_id": "share_on_twitter", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-31 06:39:47.745000", "is_active": false, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "WEEK" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.857000", "activity_name": "Share on Twitter", "extra_config": { "tweet_message": "Loving this site! Check it out", "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a1", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": null, "multiplier": 1 }, "enduser_activity_short_description": "Earn points for writing a review.", "activity_id": "write_a_review", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:13:10.021000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "DAY" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.824000", "activity_name": "Write a Review", "extra_config": {}, "id": "604f5a3b8152252216f5c19c", "activity_benefit_type": "points" }, { "points_config": { "points": 200, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points on your anniversary.", "activity_id": "anniversary_bonus", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:07:02.905000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "YEAR" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 1 } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.836000", "activity_name": "Anniversary Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19e", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "", "activity_id": "f00ca_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-17 11:21:50.190000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Awards 3X points, If the subscribing was done between Jan 1, 2020 - March 1, 2020", "conditions": [ { "operator": "Between", "attribute": "Transaction Date", "value": "1/1/2022-3/31/2022" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-05-05 05:29:46.129000", "activity_name": "", "extra_config": {}, "id": "60922d4abed0d56677192dcf", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Award points on referral purchase.", "activity_id": "referral", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-12 11:10:12.088000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-03-22 08:46:18.898000", "activity_name": "Refer a Friend", "extra_config": {}, "id": "6058595abb711d6fa73fcd36", "activity_benefit_type": "points_and_coupon_code" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Enter the code on your LD pack and earn points", "activity_id": "684fc_custom_activity", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "
", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-04-10 11:47:27.127000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-05-05 11:41:57.738000", "activity_name": "684fc_custom_activity", "extra_config": {}, "id": "609284851c9396204c8b984b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "a7ee1_custom_activity", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-03-08 11:01:06.969000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2023-01-23 13:52:30.665000", "activity_name": "Custom Activity", "extra_config": {}, "id": "63ce911ef380d8000b8d7753", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward points to wake up your dormant users.", "activity_id": "winback_bonus", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-02-24 07:39:20.915000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.842000", "activity_name": "Winback Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19f", "activity_benefit_type": "points" }, { "points_config": { "points": 130, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Award points on birthday.", "activity_id": "birthday_bonus", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-02-24 07:27:55.290000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "YEAR" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Award Points to Gold Tiers", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 5 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.830000", "activity_name": "Birthday Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Redeemed points will be rolled back for returned orders.", "activity_id": "redeemed_points_rollback", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-10-19 14:12:21.667000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2022-10-10 09:17:16.952000", "activity_name": "Redeemed Points Rollback", "extra_config": {}, "id": "6343e31ce34bfe022c725dec", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points for uploading a photo.", "activity_id": "upload_photo", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-10-06 10:26:28.835000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "DAY" } ], "rule_value": 0 } ], "approval_method": "manual", "created_date": "2022-07-28 06:53:03.616000", "activity_name": "Upload a Photo", "extra_config": {}, "id": "62e2324f23d74243d1c5af29", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "receipt_order_value", "multiplier": 1 }, "enduser_activity_short_description": "Reward users for submitting receipts of their purchases.", "activity_id": "submit_a_receipt", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-10-06 09:54:55.183000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "manual", "created_date": "2021-03-22 08:56:14.632000", "activity_name": "Submit A Receipt", "extra_config": {}, "id": "60585baef5a67a16e1871b56", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "5d1b1_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-19 10:06:40.112000", "is_active": false, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2022-07-19 10:06:40.112000", "activity_name": "Custom Activity", "extra_config": {}, "id": "62d68230e6006a5888211e6b", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you share us on Pinterest.", "activity_id": "share_on_pinterest", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:19.592000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "WEEK" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.873000", "activity_name": "Share on Pinterest", "extra_config": { "pin_post_image": "", "pin_post_description": "Awesome products at great prices. You should really check them out.", "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a3", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you follow us on Twitter.", "activity_id": "follow_on_twitter", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:12.990000", "is_active": false, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.867000", "activity_name": "Follow on Twitter", "extra_config": {}, "id": "604f5a3b8152252216f5c1a2", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward points to users when they share you on Facebook.", "activity_id": "share_on_facebook", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-07-14 08:17:00.673000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "WEEK" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.848000", "activity_name": "Share on Facebook", "extra_config": { "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a0", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "f46f4_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-06-14 11:09:16.199000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2022-03-03 05:30:58.331000", "activity_name": "Quiz form", "extra_config": {}, "id": "622052924e6d9f1dfd89ed88", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": null, "multiplier": 1 }, "enduser_activity_short_description": "Get rewarded for your purchases by submitting the code you received with your purchase.", "activity_id": "code_submission", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-05-19 10:32:40.318000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Award 5x Bonus Points", "conditions": [ { "operator": "Between", "attribute": "Transaction Date", "value": "4/5/2022-7/5/2022" } ], "rule_value": 5 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Postal Code Rule", "conditions": [ { "operator": "Equals", "attribute": "Postal Code", "value": 75462 } ], "rule_value": 2 } ], "approval_method": "immediate", "created_date": "2022-05-18 10:05:41.642000", "activity_name": "Enter a Code", "extra_config": {}, "id": "6284c4f5dfa6b7425568ba6d", "activity_benefit_type": "points" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "", "activity_id": "89fc8_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-04-22 07:07:15.584000", "is_active": false, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-03-18 07:05:01.680000", "activity_name": "", "extra_config": {}, "id": "6052fb9d4d60ac7069c8361b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "496c7_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-03-17 04:41:58.695000", "is_active": false, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2022-03-17 04:41:58.695000", "activity_name": "Custom Activity", "extra_config": {}, "id": "6232bc1699b4e119340ec7d3", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "96cbd_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-03-04 05:08:53.512000", "is_active": false, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2022-03-04 05:08:53.512000", "activity_name": "Custom Activity", "extra_config": {}, "id": "62219ee5d7d5dc534c3f6b97", "activity_benefit_type": "points" } ], "next_cursor": 100, "more": false }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total": { "type": "integer", "example": 25, "default": 0 }, "activities": { "type": "array", "items": { "type": "object", "properties": { "points_config": { "type": "object", "properties": { "points_computation_type": { "type": "string", "example": "multiplier_based" }, "attribute_to_multiply": { "type": "string", "example": "order_subtotal" }, "multiplier": { "type": "integer", "example": 1, "default": 0 } } }, "enduser_activity_short_description": { "type": "string", "example": "Earn points for every dollar you spend in purchases." }, "activity_id": { "type": "string", "example": "made_a_purchase" }, "is_points_expiry_reset_activity": { "type": "boolean", "example": true, "default": true }, "show_on_guest_dashboard": { "type": "boolean", "example": true, "default": true }, "enduser_activity_description_html": { "type": "string", "example": "Earn 100 points for every advisor you talk to." }, "activity_card_background_image_url": { "type": "string", "example": "" }, "is_qualified_for_tier_upgrade": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "2023-12-08 16:55:20.470000" }, "is_active": { "type": "boolean", "example": true, "default": true }, "metadata": { "type": "object", "properties": { "Category": { "type": "string", "example": "Chocolate Cake" } } }, "rules_config": { "type": "array", "items": { "type": "object", "properties": { "rule_type": { "type": "string", "example": "Bonus Multiplier" }, "is_archived": { "type": "boolean", "example": false, "default": true }, "is_active": { "type": "boolean", "example": false, "default": true }, "conditions_matching_policy": { "type": "string", "example": "match_all" }, "rule_name": { "type": "string", "example": "" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "example": "Equals" }, "attribute": { "type": "string", "example": "Product Category" }, "value": { "type": "string", "example": "Blue Rainbow" } } } }, "rule_value": { "type": "integer", "example": 10, "default": 0 } } } }, "approval_method": { "type": "string", "example": "immediate" }, "created_date": { "type": "string", "example": "2021-03-15 12:59:39.818000" }, "activity_name": { "type": "string", "example": "Loan Installment Payment" }, "extra_config": { "type": "object", "properties": {} }, "id": { "type": "string", "example": "604f5a3b8152252216f5c19b" }, "activity_benefit_type": { "type": "string", "example": "points" } } } }, "next_cursor": { "type": "integer", "example": 100, "default": 0 }, "more": { "type": "boolean", "example": false, "default": true } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{member_id}/activities": { "get": { "summary": "List all the Eligible Activities for a Member using Member ID", "operationId": "list-all-the-eligible-activities-for-a-member-with-member-id-1", "tags": [ "admin_activities" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "member_id", "in": "path", "schema": { "type": "string", "default": "john.doe@gmail.com" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'member_id' as idParam.", "required": true, "schema": { "type": "string", "default": "member_id" } }, { "name": "start_cursor", "in": "query", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "type": "integer", "format": "int32" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 16, "activities": [ { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-08 16:55:20.470000", "is_active": true, "metadata": { "Category": "Chocolate Cake" }, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "Product Category", "value": "Blue Rainbow" }, { "operator": "Between", "attribute": "Transaction Date", "value": "3/8/2023-3/8/2023" }, { "operator": "Equals", "attribute": "nationality", "value": "American" } ], "rule_value": 10 }, { "rule_type": "Fixed Points", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 30 } ], "rule_value": 500 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Less Than", "attribute": "Order Value", "value": 100 } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "11/1/2022" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "1/1/2023" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Gold Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 2 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "Platinum Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_platinum" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "extra_config": {}, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, { "points_config": { "points": 1000, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you follow us on Instagram.", "activity_id": "follow_on_instagram", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-10-30 07:09:02.212000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "LIFETIME" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.886000", "activity_name": "Follow on Instagram", "extra_config": { "business_instagram_username": "pallavi" }, "id": "604f5a3b8152252216f5c1a4", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you create your loyalty account.", "activity_id": "created_an_account", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-06-14 09:03:33.343000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Between", "attribute": "Enrollment Date", "value": "5/3/2021-5/7/2021" } ], "rule_value": 12 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 1 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.812000", "activity_name": "Account Creation", "extra_config": {}, "id": "604f5a3b8152252216f5c19a", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": null, "multiplier": 1 }, "enduser_activity_short_description": "Earn points for writing a review.", "activity_id": "write_a_review", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:13:10.021000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "DAY" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.824000", "activity_name": "Write a Review", "extra_config": {}, "id": "604f5a3b8152252216f5c19c", "activity_benefit_type": "points" }, { "points_config": { "points": 200, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points on your anniversary.", "activity_id": "anniversary_bonus", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:07:02.905000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "YEAR" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 1 } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.836000", "activity_name": "Anniversary Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19e", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "", "activity_id": "f00ca_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-17 11:21:50.190000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Awards 3X points, If the subscribing was done between Jan 1, 2020 - March 1, 2020", "conditions": [ { "operator": "Between", "attribute": "Transaction Date", "value": "1/1/2022-3/31/2022" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-05-05 05:29:46.129000", "activity_name": "", "extra_config": {}, "id": "60922d4abed0d56677192dcf", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Award points on referral purchase.", "activity_id": "referral", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-12 11:10:12.088000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-03-22 08:46:18.898000", "activity_name": "Refer a Friend", "extra_config": {}, "id": "6058595abb711d6fa73fcd36", "activity_benefit_type": "points_and_coupon_code" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Enter the code on your LD pack and earn points", "activity_id": "684fc_custom_activity", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "
", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-04-10 11:47:27.127000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-05-05 11:41:57.738000", "activity_name": "684fc_custom_activity", "extra_config": {}, "id": "609284851c9396204c8b984b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "a7ee1_custom_activity", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-03-08 11:01:06.969000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2023-01-23 13:52:30.665000", "activity_name": "Custom Activity", "extra_config": {}, "id": "63ce911ef380d8000b8d7753", "activity_benefit_type": "points" }, { "points_config": { "points": 130, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Award points on birthday.", "activity_id": "birthday_bonus", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-02-24 07:27:55.290000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "YEAR" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Award Points to Gold Tiers", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 5 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.830000", "activity_name": "Birthday Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points for uploading a photo.", "activity_id": "upload_photo", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-10-06 10:26:28.835000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "DAY" } ], "rule_value": 0 } ], "approval_method": "manual", "created_date": "2022-07-28 06:53:03.616000", "activity_name": "Upload a Photo", "extra_config": {}, "id": "62e2324f23d74243d1c5af29", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "receipt_order_value", "multiplier": 1 }, "enduser_activity_short_description": "Reward users for submitting receipts of their purchases.", "activity_id": "submit_a_receipt", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-10-06 09:54:55.183000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "manual", "created_date": "2021-03-22 08:56:14.632000", "activity_name": "Submit A Receipt", "extra_config": {}, "id": "60585baef5a67a16e1871b56", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you share us on Pinterest.", "activity_id": "share_on_pinterest", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:19.592000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "WEEK" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.873000", "activity_name": "Share on Pinterest", "extra_config": { "pin_post_image": "", "pin_post_description": "Awesome products at great prices. You should really check them out.", "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a3", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward points to users when they share you on Facebook.", "activity_id": "share_on_facebook", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-07-14 08:17:00.673000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "WEEK" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.848000", "activity_name": "Share on Facebook", "extra_config": { "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a0", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "f46f4_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-06-14 11:09:16.199000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2022-03-03 05:30:58.331000", "activity_name": "Quiz form", "extra_config": {}, "id": "622052924e6d9f1dfd89ed88", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": null, "multiplier": 1 }, "enduser_activity_short_description": "Get rewarded for your purchases by submitting the code you received with your purchase.", "activity_id": "code_submission", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-05-19 10:32:40.318000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Award 5x Bonus Points", "conditions": [ { "operator": "Between", "attribute": "Transaction Date", "value": "4/5/2022-7/5/2022" } ], "rule_value": 5 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Postal Code Rule", "conditions": [ { "operator": "Equals", "attribute": "Postal Code", "value": 75462 } ], "rule_value": 2 } ], "approval_method": "immediate", "created_date": "2022-05-18 10:05:41.642000", "activity_name": "Enter a Code", "extra_config": {}, "id": "6284c4f5dfa6b7425568ba6d", "activity_benefit_type": "points" } ], "next_cursor": 100, "more": false }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total": { "type": "integer", "example": 16, "default": 0 }, "activities": { "type": "array", "items": { "type": "object", "properties": { "points_config": { "type": "object", "properties": { "points_computation_type": { "type": "string", "example": "multiplier_based" }, "attribute_to_multiply": { "type": "string", "example": "order_subtotal" }, "multiplier": { "type": "integer", "example": 1, "default": 0 } } }, "enduser_activity_short_description": { "type": "string", "example": "Earn points for every dollar you spend in purchases." }, "activity_id": { "type": "string", "example": "made_a_purchase" }, "is_points_expiry_reset_activity": { "type": "boolean", "example": true, "default": true }, "show_on_guest_dashboard": { "type": "boolean", "example": true, "default": true }, "enduser_activity_description_html": { "type": "string", "example": "Earn 100 points for every advisor you talk to." }, "activity_card_background_image_url": { "type": "string", "example": "" }, "is_qualified_for_tier_upgrade": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "2023-12-08 16:55:20.470000" }, "is_active": { "type": "boolean", "example": true, "default": true }, "metadata": { "type": "object", "properties": { "Category": { "type": "string", "example": "Chocolate Cake" } } }, "rules_config": { "type": "array", "items": { "type": "object", "properties": { "rule_type": { "type": "string", "example": "Bonus Multiplier" }, "is_archived": { "type": "boolean", "example": false, "default": true }, "is_active": { "type": "boolean", "example": false, "default": true }, "conditions_matching_policy": { "type": "string", "example": "match_all" }, "rule_name": { "type": "string", "example": "" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "example": "Equals" }, "attribute": { "type": "string", "example": "Product Category" }, "value": { "type": "string", "example": "Blue Rainbow" } } } }, "rule_value": { "type": "integer", "example": 10, "default": 0 } } } }, "approval_method": { "type": "string", "example": "immediate" }, "created_date": { "type": "string", "example": "2021-03-15 12:59:39.818000" }, "activity_name": { "type": "string", "example": "Loan Installment Payment" }, "extra_config": { "type": "object", "properties": {} }, "id": { "type": "string", "example": "604f5a3b8152252216f5c19b" }, "activity_benefit_type": { "type": "string", "example": "points" } } } }, "next_cursor": { "type": "integer", "example": 100, "default": 0 }, "more": { "type": "boolean", "example": false, "default": true } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{id}/activities": { "get": { "summary": "List all the Eligible Activities for a Member using TrueLoyal-generated Member ID", "operationId": "list-all-the-eligible-activities-for-a-member-using-zinrelo-generated-member-id-1", "tags": [ "admin_activities" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add TrueLoyal generated ID.", "schema": { "type": "string", "default": "62d6439adfa6b74ab18eb1a6" }, "required": true }, { "name": "start_cursor", "in": "query", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "type": "integer", "format": "int32" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 16, "activities": [ { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-08 16:55:20.470000", "is_active": true, "metadata": { "Category": "Chocolate Cake" }, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "Product Category", "value": "Blue Rainbow" }, { "operator": "Between", "attribute": "Transaction Date", "value": "3/8/2023-3/8/2023" }, { "operator": "Equals", "attribute": "nationality", "value": "American" } ], "rule_value": 10 }, { "rule_type": "Fixed Points", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 30 } ], "rule_value": 500 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Less Than", "attribute": "Order Value", "value": 100 } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "11/1/2022" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "1/1/2023" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Gold Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 2 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "Platinum Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_platinum" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "extra_config": {}, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, { "points_config": { "points": 1000, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you follow us on Instagram.", "activity_id": "follow_on_instagram", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-10-30 07:09:02.212000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "LIFETIME" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.886000", "activity_name": "Follow on Instagram", "extra_config": { "business_instagram_username": "pallavi" }, "id": "604f5a3b8152252216f5c1a4", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you create your loyalty account.", "activity_id": "created_an_account", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-06-14 09:03:33.343000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Between", "attribute": "Enrollment Date", "value": "5/3/2021-5/7/2021" } ], "rule_value": 12 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 1 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.812000", "activity_name": "Account Creation", "extra_config": {}, "id": "604f5a3b8152252216f5c19a", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": null, "multiplier": 1 }, "enduser_activity_short_description": "Earn points for writing a review.", "activity_id": "write_a_review", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:13:10.021000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "DAY" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.824000", "activity_name": "Write a Review", "extra_config": {}, "id": "604f5a3b8152252216f5c19c", "activity_benefit_type": "points" }, { "points_config": { "points": 200, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points on your anniversary.", "activity_id": "anniversary_bonus", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:07:02.905000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "YEAR" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 1 } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.836000", "activity_name": "Anniversary Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19e", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "", "activity_id": "f00ca_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-17 11:21:50.190000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Awards 3X points, If the subscribing was done between Jan 1, 2020 - March 1, 2020", "conditions": [ { "operator": "Between", "attribute": "Transaction Date", "value": "1/1/2022-3/31/2022" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-05-05 05:29:46.129000", "activity_name": "", "extra_config": {}, "id": "60922d4abed0d56677192dcf", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Award points on referral purchase.", "activity_id": "referral", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-12 11:10:12.088000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-03-22 08:46:18.898000", "activity_name": "Refer a Friend", "extra_config": {}, "id": "6058595abb711d6fa73fcd36", "activity_benefit_type": "points_and_coupon_code" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Enter the code on your LD pack and earn points", "activity_id": "684fc_custom_activity", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "
", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-04-10 11:47:27.127000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2021-05-05 11:41:57.738000", "activity_name": "684fc_custom_activity", "extra_config": {}, "id": "609284851c9396204c8b984b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "a7ee1_custom_activity", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-03-08 11:01:06.969000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2023-01-23 13:52:30.665000", "activity_name": "Custom Activity", "extra_config": {}, "id": "63ce911ef380d8000b8d7753", "activity_benefit_type": "points" }, { "points_config": { "points": 130, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Award points on birthday.", "activity_id": "birthday_bonus", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-02-24 07:27:55.290000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "YEAR" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Award Points to Gold Tiers", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 5 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.830000", "activity_name": "Birthday Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points for uploading a photo.", "activity_id": "upload_photo", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-10-06 10:26:28.835000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "DAY" } ], "rule_value": 0 } ], "approval_method": "manual", "created_date": "2022-07-28 06:53:03.616000", "activity_name": "Upload a Photo", "extra_config": {}, "id": "62e2324f23d74243d1c5af29", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "receipt_order_value", "multiplier": 1 }, "enduser_activity_short_description": "Reward users for submitting receipts of their purchases.", "activity_id": "submit_a_receipt", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-10-06 09:54:55.183000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "manual", "created_date": "2021-03-22 08:56:14.632000", "activity_name": "Submit A Receipt", "extra_config": {}, "id": "60585baef5a67a16e1871b56", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Earn points when you share us on Pinterest.", "activity_id": "share_on_pinterest", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:19.592000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "WEEK" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.873000", "activity_name": "Share on Pinterest", "extra_config": { "pin_post_image": "", "pin_post_description": "Awesome products at great prices. You should really check them out.", "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a3", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward points to users when they share you on Facebook.", "activity_id": "share_on_facebook", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-07-14 08:17:00.673000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Frequency", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "frequency_value": "1", "frequency_range": "WEEK" } ], "rule_value": 0 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.848000", "activity_name": "Share on Facebook", "extra_config": { "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a0", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "enduser_activity_short_description": "Reward your users for any activity you want.", "activity_id": "f46f4_custom_activity", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-06-14 11:09:16.199000", "is_active": true, "metadata": {}, "rules_config": null, "approval_method": "immediate", "created_date": "2022-03-03 05:30:58.331000", "activity_name": "Quiz form", "extra_config": {}, "id": "622052924e6d9f1dfd89ed88", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": null, "multiplier": 1 }, "enduser_activity_short_description": "Get rewarded for your purchases by submitting the code you received with your purchase.", "activity_id": "code_submission", "is_points_expiry_reset_activity": false, "show_on_guest_dashboard": true, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-05-19 10:32:40.318000", "is_active": true, "metadata": {}, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Award 5x Bonus Points", "conditions": [ { "operator": "Between", "attribute": "Transaction Date", "value": "4/5/2022-7/5/2022" } ], "rule_value": 5 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Postal Code Rule", "conditions": [ { "operator": "Equals", "attribute": "Postal Code", "value": 75462 } ], "rule_value": 2 } ], "approval_method": "immediate", "created_date": "2022-05-18 10:05:41.642000", "activity_name": "Enter a Code", "extra_config": {}, "id": "6284c4f5dfa6b7425568ba6d", "activity_benefit_type": "points" } ], "next_cursor": 100, "more": false }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total": { "type": "integer", "example": 16, "default": 0 }, "activities": { "type": "array", "items": { "type": "object", "properties": { "points_config": { "type": "object", "properties": { "points_computation_type": { "type": "string", "example": "multiplier_based" }, "attribute_to_multiply": { "type": "string", "example": "order_subtotal" }, "multiplier": { "type": "integer", "example": 1, "default": 0 } } }, "enduser_activity_short_description": { "type": "string", "example": "Earn points for every dollar you spend in purchases." }, "activity_id": { "type": "string", "example": "made_a_purchase" }, "is_points_expiry_reset_activity": { "type": "boolean", "example": true, "default": true }, "show_on_guest_dashboard": { "type": "boolean", "example": true, "default": true }, "enduser_activity_description_html": { "type": "string", "example": "Earn 100 points for every advisor you talk to." }, "activity_card_background_image_url": { "type": "string", "example": "" }, "is_qualified_for_tier_upgrade": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "2023-12-08 16:55:20.470000" }, "is_active": { "type": "boolean", "example": true, "default": true }, "metadata": { "type": "object", "properties": { "Category": { "type": "string", "example": "Chocolate Cake" } } }, "rules_config": { "type": "array", "items": { "type": "object", "properties": { "rule_type": { "type": "string", "example": "Bonus Multiplier" }, "is_archived": { "type": "boolean", "example": false, "default": true }, "is_active": { "type": "boolean", "example": false, "default": true }, "conditions_matching_policy": { "type": "string", "example": "match_all" }, "rule_name": { "type": "string", "example": "" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "example": "Equals" }, "attribute": { "type": "string", "example": "Product Category" }, "value": { "type": "string", "example": "Blue Rainbow" } } } }, "rule_value": { "type": "integer", "example": 10, "default": 0 } } } }, "approval_method": { "type": "string", "example": "immediate" }, "created_date": { "type": "string", "example": "2021-03-15 12:59:39.818000" }, "activity_name": { "type": "string", "example": "Loan Installment Payment" }, "extra_config": { "type": "object", "properties": {} }, "id": { "type": "string", "example": "604f5a3b8152252216f5c19b" }, "activity_benefit_type": { "type": "string", "example": "points" } } } }, "next_cursor": { "type": "integer", "example": 100, "default": 0 }, "more": { "type": "boolean", "example": false, "default": true } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/activities/{activity_id}": { "get": { "summary": "Retrieve an Activity using Activity ID", "operationId": "retrieve-an-activity-using-activity-id-1", "tags": [ "admin_activities" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "activity_id", "in": "path", "description": "Enter activity ID.", "schema": { "type": "string", "default": "made_a_purchase" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'activity_id' as idParam.", "required": true, "schema": { "type": "string", "default": "activity_id" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-08 16:55:20.470000", "is_active": true, "metadata": { "Category": "Chocolate Cake" }, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "Product Category", "value": "Blue Rainbow" }, { "operator": "Between", "attribute": "Transaction Date", "value": "3/8/2023-3/8/2023" }, { "operator": "Equals", "attribute": "nationality", "value": "American" } ], "rule_value": 10 }, { "rule_type": "Fixed Points", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 30 } ], "rule_value": 500 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Less Than", "attribute": "Order Value", "value": 100 } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "11/1/2022" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "1/1/2023" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Gold Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 2 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "Platinum Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_platinum" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "extra_config": {}, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "points_config": { "type": "object", "properties": { "points_computation_type": { "type": "string", "example": "multiplier_based" }, "attribute_to_multiply": { "type": "string", "example": "order_subtotal" }, "multiplier": { "type": "integer", "example": 1, "default": 0 } } }, "enduser_activity_short_description": { "type": "string", "example": "Earn points for every dollar you spend in purchases." }, "activity_id": { "type": "string", "example": "made_a_purchase" }, "is_points_expiry_reset_activity": { "type": "boolean", "example": true, "default": true }, "show_on_guest_dashboard": { "type": "boolean", "example": true, "default": true }, "enduser_activity_description_html": { "type": "string", "example": "Earn 100 points for every advisor you talk to." }, "activity_card_background_image_url": { "type": "string", "example": "" }, "is_qualified_for_tier_upgrade": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "2023-12-08 16:55:20.470000" }, "is_active": { "type": "boolean", "example": true, "default": true }, "metadata": { "type": "object", "properties": { "Category": { "type": "string", "example": "Chocolate Cake" } } }, "rules_config": { "type": "array", "items": { "type": "object", "properties": { "rule_type": { "type": "string", "example": "Bonus Multiplier" }, "is_archived": { "type": "boolean", "example": false, "default": true }, "is_active": { "type": "boolean", "example": false, "default": true }, "conditions_matching_policy": { "type": "string", "example": "match_all" }, "rule_name": { "type": "string", "example": "" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "example": "Equals" }, "attribute": { "type": "string", "example": "Product Category" }, "value": { "type": "string", "example": "Blue Rainbow" } } } }, "rule_value": { "type": "integer", "example": 10, "default": 0 } } } }, "approval_method": { "type": "string", "example": "immediate" }, "created_date": { "type": "string", "example": "2021-03-15 12:59:39.818000" }, "activity_name": { "type": "string", "example": "Loan Installment Payment" }, "extra_config": { "type": "object", "properties": {} }, "id": { "type": "string", "example": "604f5a3b8152252216f5c19b" }, "activity_benefit_type": { "type": "string", "example": "points" } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/activities/{id}": { "get": { "summary": "Retrieve an Activity using TrueLoyal-generated ID", "operationId": "retrieve-an-activity-using-zinrelo-generated-id-1", "tags": [ "admin_activities" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add Trueloyal generated ID.", "schema": { "type": "string", "default": "62d6439adfa6b74ab18eb1a6" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "show_on_guest_dashboard": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-08 16:55:20.470000", "is_active": true, "metadata": { "Category": "Chocolate Cake" }, "rules_config": [ { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Equals", "attribute": "Product Category", "value": "Blue Rainbow" }, { "operator": "Between", "attribute": "Transaction Date", "value": "3/8/2023-3/8/2023" }, { "operator": "Equals", "attribute": "nationality", "value": "American" } ], "rule_value": 10 }, { "rule_type": "Fixed Points", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "More than X day(s) ago", "attribute": "Enrollment Date", "value": 30 } ], "rule_value": 500 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "Less Than", "attribute": "Order Value", "value": 100 } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "11/1/2022" } ], "rule_value": 0 }, { "rule_type": "Update Attribute", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "", "conditions": [ { "operator": "After", "attribute": "Enrollment Date", "value": "1/1/2023" } ], "rule_value": 0 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": false, "conditions_matching_policy": "match_all", "rule_name": "Gold Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_gold" } ], "rule_value": 2 }, { "rule_type": "Bonus Multiplier", "is_archived": false, "is_active": true, "conditions_matching_policy": "match_all", "rule_name": "Platinum Tier Rule", "conditions": [ { "operator": "Equals", "attribute": "User Tier", "value": "zrl_platinum" } ], "rule_value": 3 } ], "approval_method": "immediate", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "extra_config": {}, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "points_config": { "type": "object", "properties": { "points_computation_type": { "type": "string", "example": "multiplier_based" }, "attribute_to_multiply": { "type": "string", "example": "order_subtotal" }, "multiplier": { "type": "integer", "example": 1, "default": 0 } } }, "enduser_activity_short_description": { "type": "string", "example": "Earn points for every dollar you spend in purchases." }, "activity_id": { "type": "string", "example": "made_a_purchase" }, "is_points_expiry_reset_activity": { "type": "boolean", "example": true, "default": true }, "show_on_guest_dashboard": { "type": "boolean", "example": true, "default": true }, "enduser_activity_description_html": { "type": "string", "example": "Earn 100 points for every advisor you talk to." }, "activity_card_background_image_url": { "type": "string", "example": "" }, "is_qualified_for_tier_upgrade": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "2023-12-08 16:55:20.470000" }, "is_active": { "type": "boolean", "example": true, "default": true }, "metadata": { "type": "object", "properties": { "Category": { "type": "string", "example": "Chocolate Cake" } } }, "rules_config": { "type": "array", "items": { "type": "object", "properties": { "rule_type": { "type": "string", "example": "Bonus Multiplier" }, "is_archived": { "type": "boolean", "example": false, "default": true }, "is_active": { "type": "boolean", "example": false, "default": true }, "conditions_matching_policy": { "type": "string", "example": "match_all" }, "rule_name": { "type": "string", "example": "" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "example": "Equals" }, "attribute": { "type": "string", "example": "Product Category" }, "value": { "type": "string", "example": "Blue Rainbow" } } } }, "rule_value": { "type": "integer", "example": 10, "default": 0 } } } }, "approval_method": { "type": "string", "example": "immediate" }, "created_date": { "type": "string", "example": "2021-03-15 12:59:39.818000" }, "activity_name": { "type": "string", "example": "Loan Installment Payment" }, "extra_config": { "type": "object", "properties": {} }, "id": { "type": "string", "example": "604f5a3b8152252216f5c19b" }, "activity_benefit_type": { "type": "string", "example": "points" } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/activities/{activity_id}/attributes": { "get": { "summary": "Retrieve Custom Attribute for an Activity using Activity ID", "operationId": "retrieve-custom-attribute-for-an-activity-using-activity-id-1", "tags": [ "admin_activities" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "activity_id", "in": "path", "description": "Enter activity ID.", "schema": { "type": "string", "default": "referral" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'activity_id' as idParam.", "required": true, "schema": { "type": "string", "default": "activity_id" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "attributes": [ { "attribute_name": "number of purchases", "attribute_id": "no_of_purchases_number", "attribute_type": "Number" }, { "attribute_name": "place of purchases", "attribute_id": "place_of_purchases_text", "attribute_type": "String" }, { "attribute_name": "List of number", "attribute_id": "list_of_number", "attribute_type": "List" }, { "attribute_name": "List of dictionary", "attribute_id": "list_of_dictionary", "attribute_type": "List" }, { "attribute_name": "List of dictionary New", "attribute_id": "list_of_dictionary_new", "attribute_type": "List" }, { "attribute_name": "customer_enrollment", "attribute_id": "customer_enrollment_list", "attribute_type": "List" }, { "attribute_name": "customer_enrollment_batch", "attribute_id": "customer_enrollment_batch", "attribute_type": "List" }, { "attribute_name": "customer_dob", "attribute_id": "customer_dob_number", "attribute_type": "Number" }, { "attribute_name": "customer_name", "attribute_id": "customer_name_text", "attribute_type": "String" }, { "attribute_name": "customer_anniversary", "attribute_id": "customer_anniversary_date", "attribute_type": "Date" }, { "attribute_name": "customer_dob", "attribute_id": "customer_dob_twitter", "attribute_type": "Number" } ], "activity_id": "made_a_purchase", "total": 11 }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "object", "properties": { "attribute_name": { "type": "string", "example": "number of purchases" }, "attribute_id": { "type": "string", "example": "no_of_purchases_number" }, "attribute_type": { "type": "string", "example": "Number" } } } }, "activity_id": { "type": "string", "example": "made_a_purchase" }, "total": { "type": "integer", "example": 11, "default": 0 } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/activities/{id}/attributes": { "get": { "summary": "Retrieve Custom Attribute for an Activity using TrueLoyal-generated ID", "operationId": "retrieve-custom-attribute-for-an-activity-using-zinrelo-generated-id-1", "tags": [ "admin_activities" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add Trueloyal generated activity ID.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "attributes": [ { "attribute_name": "number of purchases", "attribute_id": "no_of_purchases_number", "attribute_type": "Number" }, { "attribute_name": "place of purchases", "attribute_id": "place_of_purchases_text", "attribute_type": "String" }, { "attribute_name": "List of number", "attribute_id": "list_of_number", "attribute_type": "List" }, { "attribute_name": "List of dictionary", "attribute_id": "list_of_dictionary", "attribute_type": "List" }, { "attribute_name": "List of dictionary New", "attribute_id": "list_of_dictionary_new", "attribute_type": "List" }, { "attribute_name": "customer_enrollment", "attribute_id": "customer_enrollment_list", "attribute_type": "List" }, { "attribute_name": "customer_enrollment_batch", "attribute_id": "customer_enrollment_batch", "attribute_type": "List" }, { "attribute_name": "customer_dob", "attribute_id": "customer_dob_number", "attribute_type": "Number" }, { "attribute_name": "customer_name", "attribute_id": "customer_name_text", "attribute_type": "String" }, { "attribute_name": "customer_anniversary", "attribute_id": "customer_anniversary_date", "attribute_type": "Date" }, { "attribute_name": "customer_dob", "attribute_id": "customer_dob_twitter", "attribute_type": "Number" } ], "activity_id": "made_a_purchase", "total": 11 }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "type": "object", "properties": { "attribute_name": { "type": "string", "example": "number of purchases" }, "attribute_id": { "type": "string", "example": "no_of_purchases_number" }, "attribute_type": { "type": "string", "example": "Number" } } } }, "activity_id": { "type": "string", "example": "made_a_purchase" }, "total": { "type": "integer", "example": 11, "default": 0 } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/rewards": { "get": { "summary": "List All Rewards", "operationId": "list-all-rewards-1", "tags": [ "admin_rewards" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 10, "rewards": [ { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 11:09:52", "is_active": false, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/02/2023 08:45:56", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 0, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "640062440266f8000a4305c7", "reward_id": "reward_1d72a", "metadata": { "Brand": "Nescafe", "Location": "London" }, "reward_value": "0" }, { "reward_name": "Test Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 11:09:44", "is_active": false, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/06/2023 10:52:10", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "6405c5daf7e368000c9de4e9", "reward_id": "reward_82805", "metadata": { "Brand": "Nescafe", "Location": "London" }, "reward_value": "15" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:10:31", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/01/2023 12:50:37", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 10, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63ff4a1dfed629000bacf55c", "reward_id": "reward_a0d68", "metadata": { "Brand": "Nescafe" }, "reward_value": "0" }, { "reward_name": "Test Rewards within reach ", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:10:29", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "02/10/2023 07:27:32", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1000, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63e5f1e458a3ad000d03be8f", "reward_id": "reward_f484f", "metadata": { "Brand": "Davidoff", "Location": "London" }, "reward_value": "10" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:10:27", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "12/19/2022 10:42:30", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 10, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63a040161507dc000848e630", "reward_id": "reward_4fcf1", "metadata": { "Brand": "Starbucks", "Location": "London" }, "reward_value": "0" }, { "reward_name": "Product Redemption Type reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "product_id": "2", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:09:44", "is_active": true, "product_url": "http://18.143.114.190/battle-field.html", "reward_sub_type": "Product Redemption", "created_date": "12/09/2022 08:20:38", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Go to the product page and add this product to cart. Apply the coupon code at checkout", "id": "6392efd671891b0009b5a74b", "reward_id": "reward_2ed89", "metadata": { "Brand": "Costa Coffee", "Location": "US" }, "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/de6010baeefdd69737338afe3793944a.png" }, { "reward_name": "$5 OFF COUPON", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:09:42", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "12/09/2022 08:20:38", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "6392efd671891b0009b5a74a", "reward_id": "reward_ac6fc", "metadata": { "Brand": "Nescafe", "Location": "India" }, "reward_value": "5" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/02/2023 08:46:05", "is_active": false, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/02/2023 08:46:05", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 0, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "6400624d0266f8000b127ffb", "reward_id": "reward_a3371", "metadata": { "Brand": "Costa Coffee", "Location": "UK" }, "reward_value": "0" }, { "reward_name": "$15 OFF COUPON", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/02/2023 06:37:25", "is_active": false, "reward_sub_type": "Fixed Amount Discount", "created_date": "12/09/2022 08:20:38", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 10, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "6392efd671891b0009b5a74c", "reward_id": "reward_043ee", "metadata": { "Brand": "Dunkin", "Location": "India" }, "reward_value": "15" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/01/2023 13:16:50", "is_active": false, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/01/2023 13:16:50", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 0, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63ff5042fed629000c00aa7f", "reward_id": "reward_2a0af", "metadata": { "Brand": "Nescafe", "Location": "Paris" }, "reward_value": "0" } ], "next_cursor": 100, "more": false }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total": { "type": "integer", "example": 10, "default": 0 }, "rewards": { "type": "array", "items": { "type": "object", "properties": { "reward_name": { "type": "string", "example": "New Reward" }, "enduser_reward_confirmation_html": { "type": "string", "example": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
" }, "reward_card_background_image_url": { "type": "string", "example": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png" }, "implementation_type": { "type": "string", "example": "coupon_code" }, "redemption_eligibility_criteria": { "type": "string", "example": "Tier Based" }, "show_on_guest_dashboard": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "03/13/2023 11:09:52" }, "is_active": { "type": "boolean", "example": false, "default": true }, "reward_sub_type": { "type": "string", "example": "Fixed Amount Discount" }, "created_date": { "type": "string", "example": "03/02/2023 08:45:56" }, "enduser_reward_short_description": { "type": "string", "example": "For {{POINTS}} points" }, "points_to_be_redeemed": { "type": "integer", "example": 0, "default": 0 }, "reward_type": { "type": "string", "example": "Coupon Based Rewards" }, "enduser_reward_post_confirmation_html": { "type": "string", "example": "Here is your coupon code." }, "id": { "type": "string", "example": "640062440266f8000a4305c7" }, "reward_id": { "type": "string", "example": "reward_1d72a" }, "metadata": { "type": "object", "properties": { "Brand": { "type": "string", "example": "Nescafe" }, "Location": { "type": "string", "example": "London" } } }, "reward_value": { "type": "string", "example": "0" } } } }, "next_cursor": { "type": "integer", "example": 100, "default": 0 }, "more": { "type": "boolean", "example": false, "default": true } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{member_id}/rewards": { "get": { "summary": "Get Eligible Rewards with Member ID", "operationId": "get-eligible-rewards-with-member-id-1", "tags": [ "admin_rewards" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "member_id", "in": "path", "schema": { "type": "string", "default": "john.doe@gmail.com" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'member_id' as idParam.", "required": true, "schema": { "type": "string", "default": "member_id" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 4, "rewards": [ { "reward_name": "Product Redemption Type reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "product_id": "2", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/14/2023 11:22:38", "is_active": true, "product_url": "http://18.143.114.190/battle-field.html", "reward_sub_type": "Product Redemption", "created_date": "12/09/2022 08:20:38", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Go to the product page and add this product to cart. Apply the coupon code at checkout", "id": "6392efd671891b0009b5a74b", "reward_id": "reward_2ed89", "metadata": { "Brand": "Nescafe", "Location": "London" }, "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/de6010baeefdd69737338afe3793944a.png" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:10:31", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/01/2023 12:50:37", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 10, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63ff4a1dfed629000bacf55c", "reward_id": "reward_a0d68", "metadata": { "Brand": "Davidoff", "Location": "US" }, "reward_value": "0" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:10:27", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "12/19/2022 10:42:30", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 10, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63a040161507dc000848e630", "reward_id": "reward_4fcf1", "metadata": { "Brand": "Dunkin", "Location": "India" }, "reward_value": "0" }, { "reward_name": "$5 OFF COUPON", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:09:42", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "12/09/2022 08:20:38", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "6392efd671891b0009b5a74a", "reward_id": "reward_ac6fc", "metadata": { "Brand": "Nescafe", "Location": "India" }, "reward_value": "5" } ], "next_cursor": 100, "more": false }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total": { "type": "integer", "example": 4, "default": 0 }, "rewards": { "type": "array", "items": { "type": "object", "properties": { "reward_name": { "type": "string", "example": "Product Redemption Type reward" }, "enduser_reward_confirmation_html": { "type": "string", "example": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
" }, "product_id": { "type": "string", "example": "2" }, "implementation_type": { "type": "string", "example": "coupon_code" }, "redemption_eligibility_criteria": { "type": "string", "example": "Tier Based" }, "show_on_guest_dashboard": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "03/14/2023 11:22:38" }, "is_active": { "type": "boolean", "example": true, "default": true }, "product_url": { "type": "string", "example": "http://18.143.114.190/battle-field.html" }, "reward_sub_type": { "type": "string", "example": "Product Redemption" }, "created_date": { "type": "string", "example": "12/09/2022 08:20:38" }, "enduser_reward_short_description": { "type": "string", "example": "For {{POINTS}} points" }, "points_to_be_redeemed": { "type": "integer", "example": 1, "default": 0 }, "reward_type": { "type": "string", "example": "Coupon Based Rewards" }, "enduser_reward_post_confirmation_html": { "type": "string", "example": "Go to the product page and add this product to cart. Apply the coupon code at checkout" }, "id": { "type": "string", "example": "6392efd671891b0009b5a74b" }, "reward_id": { "type": "string", "example": "reward_2ed89" }, "metadata": { "type": "object", "properties": { "Brand": { "type": "string", "example": "Nescafe" }, "Location": { "type": "string", "example": "London" } } }, "reward_card_background_image_url": { "type": "string", "example": "https://d1qbqkkh49kht1.cloudfront.net/de6010baeefdd69737338afe3793944a.png" } } } }, "next_cursor": { "type": "integer", "example": 100, "default": 0 }, "more": { "type": "boolean", "example": false, "default": true } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{id}/rewards": { "get": { "summary": "Get Eligible Rewards with TrueLoyal-generated Member ID", "operationId": "get-eligible-rewards-with-zinrelo-generated-id-1", "tags": [ "admin_rewards" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add Trueloyal generated ID.", "schema": { "type": "string", "default": "62d6439adfa6b74ab18eb1a6" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 4, "rewards": [ { "reward_name": "Product Redemption Type reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "product_id": "2", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/14/2023 11:22:38", "is_active": true, "product_url": "http://18.143.114.190/battle-field.html", "reward_sub_type": "Product Redemption", "created_date": "12/09/2022 08:20:38", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Go to the product page and add this product to cart. Apply the coupon code at checkout", "id": "6392efd671891b0009b5a74b", "reward_id": "reward_2ed89", "metadata": { "Brand": "Nescafe", "Location": "London" }, "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/de6010baeefdd69737338afe3793944a.png" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:10:31", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/01/2023 12:50:37", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 10, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63ff4a1dfed629000bacf55c", "reward_id": "reward_a0d68", "metadata": { "Brand": "Davidoff", "Location": "US" }, "reward_value": "0" }, { "reward_name": "New Reward", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:10:27", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "12/19/2022 10:42:30", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 10, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "63a040161507dc000848e630", "reward_id": "reward_4fcf1", "metadata": { "Brand": "Dunkin", "Location": "India" }, "reward_value": "0" }, { "reward_name": "$5 OFF COUPON", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "redemption_eligibility_criteria": "Tier Based", "show_on_guest_dashboard": false, "last_modified_date": "03/13/2023 10:09:42", "is_active": true, "reward_sub_type": "Fixed Amount Discount", "created_date": "12/09/2022 08:20:38", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "6392efd671891b0009b5a74a", "reward_id": "reward_ac6fc", "metadata": { "Brand": "Nescafe", "Location": "India" }, "reward_value": "5" } ], "next_cursor": 100, "more": false }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "total": { "type": "integer", "example": 4, "default": 0 }, "rewards": { "type": "array", "items": { "type": "object", "properties": { "reward_name": { "type": "string", "example": "Product Redemption Type reward" }, "enduser_reward_confirmation_html": { "type": "string", "example": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
" }, "product_id": { "type": "string", "example": "2" }, "implementation_type": { "type": "string", "example": "coupon_code" }, "redemption_eligibility_criteria": { "type": "string", "example": "Tier Based" }, "show_on_guest_dashboard": { "type": "boolean", "example": false, "default": true }, "last_modified_date": { "type": "string", "example": "03/14/2023 11:22:38" }, "is_active": { "type": "boolean", "example": true, "default": true }, "product_url": { "type": "string", "example": "http://18.143.114.190/battle-field.html" }, "reward_sub_type": { "type": "string", "example": "Product Redemption" }, "created_date": { "type": "string", "example": "12/09/2022 08:20:38" }, "enduser_reward_short_description": { "type": "string", "example": "For {{POINTS}} points" }, "points_to_be_redeemed": { "type": "integer", "example": 1, "default": 0 }, "reward_type": { "type": "string", "example": "Coupon Based Rewards" }, "enduser_reward_post_confirmation_html": { "type": "string", "example": "Go to the product page and add this product to cart. Apply the coupon code at checkout" }, "id": { "type": "string", "example": "6392efd671891b0009b5a74b" }, "reward_id": { "type": "string", "example": "reward_2ed89" }, "metadata": { "type": "object", "properties": { "Brand": { "type": "string", "example": "Nescafe" }, "Location": { "type": "string", "example": "London" } } }, "reward_card_background_image_url": { "type": "string", "example": "https://d1qbqkkh49kht1.cloudfront.net/de6010baeefdd69737338afe3793944a.png" } } } }, "next_cursor": { "type": "integer", "example": 100, "default": 0 }, "more": { "type": "boolean", "example": false, "default": true } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/award": { "post": { "summary": "Award Points", "operationId": "award-points-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "member_id", "activity_id" ], "properties": { "member_id": { "type": "string", "description": "Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in TrueLoyal.", "default": "john.doe@gmail.com" }, "activity_id": { "type": "string", "description": "Unique ID that identifies an activity in TrueLoyal. This is the activity against which the transaction has to be recorded.", "default": "made_a_purchase" }, "transaction_date": { "type": "string", "description": "

Add the transaction date of the activity. The transaction date would be considered for all activities except for the submit a receipt activity. Format : MM/DD/YYYY HH:MM:SS

Note: Our API records all date and time fields in UTC time.

", "default": "10/05/2019 23:10:55" }, "points_passed": { "type": "integer", "description": "Set custom points for an activity. You can set custom points for all activities except made_a_purchase activity.", "default": 1000, "format": "int32" }, "transaction_attributes": { "type": "string", "description": "

Every activity has a two predefined transaction attributes - reason and tags. While awarding points for an activity, data can be passed in these attributes.

Custom attributes: In addition to the predefined attributes, you can define custom attributes for each activity and pass data in those attributes. 

The custom attribute should be created in advance. To create custom attributes for your store, reach out to your account manager at support.trueloyal.com.

Note: \"transaction_attributes\" is mandatory only for 3 of the predefined activities.

made_a_purchase activity

Mandatory attributes are order_id, order_total, order_subtotal.

The order_subtotal should be greater than 0.01

A sample structure of the transaction_attributes for the made_a_purchase activity is given below:

{
\"tags\" : [\"tag1\",\"tag2\"],
\"reason\" : \"purchase\",
\"order_id\" : \"75\",
\"coupons\" : \"$5OFFVYZ,$10FFEDT,$05RTNVLW\",
\"order_total\" : \"1000\",
\"order_subtotal\" : \"1000\",

\"products\" : [{
\"product_id\": \"112\",
\"product_quantity\": \"1\",
\"product_category\": \"tshirt, blue range, on sale\",
\"product_price\": \"15\",
\"product_title\": \"Sweatshirt\",
\"product_image_url\": \"\"
},

{
\"product_id\": \"980\",
\"product_quantity\": \"2\",
\"product_category\": \"sales, straight range of pants, formals, on 10% discount\",
\"product_price\": \"10.017\",
\"product_title\": \"Pant\",
\"product_image_url\": \"\"
}]

}

Note:

- The attributes like “product_id”, “product_price”, “product_quantity” and “product_title” are mandatory only when you pass product attributes.

- The order subtotal should be calculated as the sum of the subtotals of all products in the order, without taking into account any discounts. The discounted price needs to be adjusted in products and passed accordingly.

- When individual product prices are provided, the subtotal is ignored.

- In instances where product information is absent, the purchase amount is derived from the 'order_subtotal' field.

submit_a_receipt activity

Mandatory attribute is 'receipt_files'. 'receipt_uid' is the optional field. Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.

A sample structure of the transaction_attributes for the submit_a_receipt activity is given below:

{\"receipt_files\":[\"\"]}

upload_photo activity

Mandatory attribute is image_file. Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.

A sample structure of the transaction_attributes for the upload_photo activity is given below:

{\"image_file\": [\"\"]}

To know more about the transaction attributes for Award API, click here.

", "default": "{ \"tags\" : [\"tag1\",\"tag2\"], \"reason\" : \"purchase\", \"order_id\" : \"75\", \"coupons\" : \"$5OFFVYZ\", \"order_total\" : \"1000\", \"order_subtotal\" : \"1000\", \"products\" : [{ \"product_id\": \"112\", \"product_quantity\": \"1\", \"product_category\": \"tshirt\", \"product_price\": \"15\", \"product_title\": \"Sweatshirt\", \"product_image_url\": \"\" }, { \"product_id\": \"980\", \"product_quantity\": \"2\", \"product_category\": \"Sales\", \"product_price\": \"10.017\", \"product_title\": \"Pant\", \"product_image_url\": \"\" }] }", "format": "json" }, "approval_date": { "type": "string", "description": "

Date and time on which the transaction will be auto approved. Format : MM/DD/YYYY HH:MM:SS.

Note: Our API records all date and time fields in UTC time.

", "default": "10/15/2019 16:10:50" }, "points_expiration_date": { "type": "string", "description": "

Pass the date and time for point expiration.

Format- MM/DD/YYYY HH:MM:SS

Note: Our API records all date and time fields in UTC time.

", "default": "10/10/2019 23:10:55" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "points_expiration_date": "21-Aug-2023 00:00:00", "auto_approval_date": "29-June-2023 05:12:41", "last_modified_date": "21-Mar-2023 05:12:41", "redemptions_list": [], "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "id": "64193cc9df192b000a6d1374", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "21-Mar-2023 05:12:41", "member_id": "greatMRT090399656", "created_date": "21-Mar-2023 05:12:41", "transaction_type": "award", "transaction_attributes": { "order_total": 110, "order_subtotal": 100, "order_id": "887y12", "tags": [ "purchasemade", "madeapurchaseactivity" ], "currency": "$", "coupon_code": "abtrojkl", "reason": "THird", "products": [ { "product_id": "12", "is_excluded": false, "product_category": "[u'Essentials', u'Sale', u'test', u'gdgd']", "product_url": "https://www.product.com", "product_price": "50", "product_points_per_quantity": 500, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "RelaxedFitSweatshirt-Mintgreen" }, { "product_id": "98012", "is_excluded": false, "product_category": "[u'Sale', u'test', u'gdgd']", "product_url": "https://www.product.com", "product_price": "25", "product_points_per_quantity": 250, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "Sweatshirt" } ], "coupons": "abtrojkl" }, "additional_data": { "activity_multiplier": 10 } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "points_expiration_date": { "type": "string", "example": "21-Aug-2023 00:00:00" }, "auto_approval_date": { "type": "string", "example": "29-June-2023 05:12:41" }, "last_modified_date": { "type": "string", "example": "21-Mar-2023 05:12:41" }, "redemptions_list": { "type": "array" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "made_a_purchase" }, "points": { "type": "integer", "example": 1000, "default": 0 }, "points_status": { "type": "string", "example": "approved" }, "activity_name": { "type": "string", "example": "Purchase on website" } } }, "id": { "type": "string", "example": "64193cc9df192b000a6d1374" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "21-Mar-2023 05:12:41" }, "member_id": { "type": "string", "example": "greatMRT090399656" }, "created_date": { "type": "string", "example": "21-Mar-2023 05:12:41" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "order_total": { "type": "integer", "example": 110, "default": 0 }, "order_subtotal": { "type": "integer", "example": 100, "default": 0 }, "order_id": { "type": "string", "example": "887y12" }, "tags": { "type": "array", "items": { "type": "string", "example": "purchasemade" } }, "currency": { "type": "string", "example": "$" }, "coupon_code": { "type": "string", "example": "abtrojkl" }, "reason": { "type": "string", "example": "THird" }, "products": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "string", "example": "12" }, "is_excluded": { "type": "boolean", "example": false, "default": true }, "product_category": { "type": "string", "example": [ "Essentials", "Sale", "test", "gdgd" ] }, "product_url": { "type": "string", "example": "https://www.product.com" }, "product_price": { "type": "string", "example": "50" }, "product_points_per_quantity": { "type": "integer", "example": 500, "default": 0 }, "bonus_multiplier": { "type": "integer", "example": 0, "default": 0 }, "product_quantity": { "type": "string", "example": "1" }, "product_image_url": { "type": "string", "example": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" }, "product_title": { "type": "string", "example": "RelaxedFitSweatshirt-Mintgreen" } } } }, "coupons": { "type": "string", "example": "abtrojkl" } } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 10, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/redeem": { "post": { "summary": "Redeem Points", "operationId": "redeem-points-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "member_id", "reward_id" ], "properties": { "member_id": { "type": "string", "description": "Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in TrueLoyal.", "default": "john.doe@gmail.com" }, "reward_id": { "type": "string", "description": "Unique ID that identifies a reward in TrueLoyal. This is the ID of the reward against which the redemption transaction has to be recorded.", "default": "reward_bc668" }, "transaction_attributes": { "type": "string", "description": "

Every activity has a two predefined transaction attributes - reason and tags. While redeeming points for an activity, data can be passed in these attributes.

For example:

{
\"reason\" : \"redeem\",
\"tags\" : [\"purchasenmade\",\"redeemingpoints\"]
}

Custom attributes: In addition to the predefined attributes, you can define custom attributes for each activity and pass data in those attributes. 

The custom attribute should be created in advance. To create custom attributes for your store, reach out to your account manager at support@zinrelo.com.

", "default": "{ \"reason\" : \"redeem\", \"tags\" : [\"purchasenmade\",\"redeemingpoints\"] }", "format": "json" }, "points_to_be_redeemed": { "type": "integer", "description": "REQUIRED: only for flexible redemption. The number of points to be redeemed; it also accepts 0 points.", "format": "int32" }, "status": { "type": "string", "description": "Pass the redemption status—approved or pending. If no entry is passed, the transaction will be redeemed, and its status will be approved.", "default": "pending" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "pending", "transaction_attributes": { "reason": "redeem", "source_of_redemption": "api", "tags": [ "purchasenmade", "redeemingpoints" ] }, "last_modified_date": "22-Mar-2023 05:54:11", "additional_data": { "points_to_be_redeemed": 1400 }, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 05:54:11", "reward_info": { "reward_name": "$15 OFF COUPON", "points_status": "redemption_pending", "coupon_code": "81c0bd3b", "reward_link": null, "reward_id": "reward_9c350", "points": 1400 }, "member_id": "5779678689", "created_date": "22-Mar-2023 05:54:11", "transaction_type": "redeem", "id": "641a9804c2161f000ee6e469" }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "pending" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string", "example": "redeem" }, "source_of_redemption": { "type": "string", "example": "api" }, "tags": { "type": "array", "items": { "type": "string", "example": "purchasenmade" } } } }, "last_modified_date": { "type": "string", "example": "22-Mar-2023 05:54:11" }, "additional_data": { "type": "object", "properties": { "points_to_be_redeemed": { "type": "integer", "example": 1400, "default": 0 } } }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "22-Mar-2023 05:54:11" }, "reward_info": { "type": "object", "properties": { "reward_name": { "type": "string", "example": "$15 OFF COUPON" }, "points_status": { "type": "string", "example": "redemption_pending" }, "coupon_code": { "type": "string", "example": "81c0bd3b" }, "reward_link": {}, "reward_id": { "type": "string", "example": "reward_9c350" }, "points": { "type": "integer", "example": 1400, "default": 0 } } }, "member_id": { "type": "string", "example": "5779678689" }, "created_date": { "type": "string", "example": "22-Mar-2023 05:54:11" }, "transaction_type": { "type": "string", "example": "redeem" }, "id": { "type": "string", "example": "641a9804c2161f000ee6e469" } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/return": { "post": { "summary": "Return Points", "operationId": "return-points-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "member_id" ], "properties": { "member_id": { "type": "string", "description": "Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in TrueLoyal.", "default": "john.doe@gmail.com" }, "transaction_attributes": { "type": "string", "description": "

In order to return points for \"made_a_purchase\" activity, the mandatory field is order_id. With this, you can also pass returned_product_id and returned_product_quantity together or just returned_amount. 

Note: If you just pass \"order_id,\" the amount will be fully returned.

For example:

{

\"tags\" : [\"ProductReturn\"],
\"reason\" : \"Order partially returned\",
\"order_id\" : \"56789\",
\"returned_amount\" : \"200\"
}

or

{
\"order_id\" : \"56789\",
\"returned_product_id\" : \"1235BCDI\",
\"returned_product_quantity\" : 2
}

", "default": "{ \"order_id\" : \"56789\", \"returned_product_id\" : \"1235BCDI\", \"returned_product_quantity\" : 2}", "format": "json" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "transaction_attributes": { "returned_product_id": null, "tags": [ "productreturned", "returned" ], "order_id": "7597659870", "reason": "Order partially returned", "returned_amount": 200, "returned_product_quantity": null }, "last_modified_date": "22-Mar-2023 06:14:15", "additional_data": { "returned_orders_revenue": 200, "product_id": null, "quantity": 1 }, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 06:14:15", "member_id": "5779678689", "created_date": "22-Mar-2023 06:14:15", "transaction_type": "deduct", "id": "641a9cb7c2161f000c2eb553", "deduct_info": { "points": 200, "points_status": "deducted", "unable_to_deduct": 0 } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "transaction_attributes": { "type": "object", "properties": { "returned_product_id": {}, "tags": { "type": "array", "items": { "type": "string", "example": "productreturned" } }, "order_id": { "type": "string", "example": "7597659870" }, "reason": { "type": "string", "example": "Order partially returned" }, "returned_amount": { "type": "integer", "example": 200, "default": 0 }, "returned_product_quantity": {} } }, "last_modified_date": { "type": "string", "example": "22-Mar-2023 06:14:15" }, "additional_data": { "type": "object", "properties": { "returned_orders_revenue": { "type": "integer", "example": 200, "default": 0 }, "product_id": {}, "quantity": { "type": "integer", "example": 1, "default": 0 } } }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "22-Mar-2023 06:14:15" }, "member_id": { "type": "string", "example": "5779678689" }, "created_date": { "type": "string", "example": "22-Mar-2023 06:14:15" }, "transaction_type": { "type": "string", "example": "deduct" }, "id": { "type": "string", "example": "641a9cb7c2161f000c2eb553" }, "deduct_info": { "type": "object", "properties": { "points": { "type": "integer", "example": 200, "default": 0 }, "points_status": { "type": "string", "example": "deducted" }, "unable_to_deduct": { "type": "integer", "example": 0, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/deduct": { "post": { "summary": "Deduct Points", "operationId": "deduct-points-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "member_id", "points_to_be_deducted" ], "properties": { "member_id": { "type": "string", "description": "Unique Identifier (Member ID) for the member object in the client’s system which was used while creating a member in TrueLoyal.", "default": "john.doe@gmail.com" }, "points_to_be_deducted": { "type": "number", "description": "Number of points to be deducted.", "default": 100, "format": "double" }, "transaction_attributes": { "type": "string", "description": "

Apart from the above parameters, you can also pass custom attributes for deduct activities, like reason and tags. 

For example:

{
\"reason\" : \"deduct\",
\"tags\" : [\"deductionmade\",\"productreturned\"]
}

", "default": "{\"reason\" : \"deduct\", \"tags\" : [\"deductionmade\",\"productreturned\"]}", "format": "json" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "transaction_attributes": { "reason": "deduct", "tags": [ "deductionmade", "productreturned" ] }, "last_modified_date": "22-Mar-2023 06:19:35", "additional_data": {}, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 06:19:35", "member_id": "5779678689", "created_date": "22-Mar-2023 06:19:35", "transaction_type": "deduct", "id": "641a9df7c2161f000c2eb56a", "deduct_info": { "points": 100, "points_status": "deducted" } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string", "example": "deduct" }, "tags": { "type": "array", "items": { "type": "string", "example": "deductionmade" } } } }, "last_modified_date": { "type": "string", "example": "22-Mar-2023 06:19:35" }, "additional_data": { "type": "object", "properties": {} }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "22-Mar-2023 06:19:35" }, "member_id": { "type": "string", "example": "5779678689" }, "created_date": { "type": "string", "example": "22-Mar-2023 06:19:35" }, "transaction_type": { "type": "string", "example": "deduct" }, "id": { "type": "string", "example": "641a9df7c2161f000c2eb56a" }, "deduct_info": { "type": "object", "properties": { "points": { "type": "integer", "example": 100, "default": 0 }, "points_status": { "type": "string", "example": "deducted" } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{id}/reverse": { "post": { "summary": "Reverse Points with Transaction ID", "operationId": "reverse-points-with-transaction-id-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Enter transaction ID.", "schema": { "type": "string", "default": "62dfc6c6595b7b17ebbf7148" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "transaction_attributes": { "reason": "Transaction reversed", "tags": [ "reversedtransaction", "reversed" ] }, "last_modified_date": "22-Mar-2023 06:24:57", "additional_data": { "award_transaction_id": "640200a652e6a100098e7208" }, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 06:24:57", "member_id": "5779678689", "created_date": "22-Mar-2023 06:24:57", "transaction_type": "deduct", "id": "641a9f39d2e73e0009ca2ec5", "deduct_info": { "points": 10000, "points_status": "deducted" } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string", "example": "Transaction reversed" }, "tags": { "type": "array", "items": { "type": "string", "example": "reversedtransaction" } } } }, "last_modified_date": { "type": "string", "example": "22-Mar-2023 06:24:57" }, "additional_data": { "type": "object", "properties": { "award_transaction_id": { "type": "string", "example": "640200a652e6a100098e7208" } } }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "22-Mar-2023 06:24:57" }, "member_id": { "type": "string", "example": "5779678689" }, "created_date": { "type": "string", "example": "22-Mar-2023 06:24:57" }, "transaction_type": { "type": "string", "example": "deduct" }, "id": { "type": "string", "example": "641a9f39d2e73e0009ca2ec5" }, "deduct_info": { "type": "object", "properties": { "points": { "type": "integer", "example": 10000, "default": 0 }, "points_status": { "type": "string", "example": "deducted" } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{unique_transaction_attribute}/reverse": { "post": { "summary": "Reverse Points using Unique Transaction Attribute", "operationId": "reverse-points-using-unique-transaction-attribute-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "unique_transaction_attribute", "in": "path", "description": "Pass the value that was stored against the client internal id.", "schema": { "type": "string", "default": "752245347" }, "required": true }, { "name": "idParam", "in": "query", "description": "The idParam for purchase activity will be order_id, but if you have created any unique transaction attribute like serial_number, invoice_number, etc., then place it as an idParam.", "required": true, "schema": { "type": "string", "default": "order_id" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "transaction_attributes": { "reason": "Transaction reversed", "tags": [ "reversedtransaction", "reversed" ] }, "last_modified_date": "14-Nov-2022 09:20:16", "additional_data": { "award_transaction_id": "6368bb4fc7f28f000c2fcf76" }, "approver_details": { "approver_name": "System", "approver_id": "null" }, "approved_date": "14-Nov-2022 09:20:16", "member_id": "john6543", "created_date": "14-Nov-2022 09:20:16", "transaction_type": "deduct", "id": "63720850a042a3000dc1f1c9", "deduct_info": { "points": 1000, "points_status": "deducted" } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string", "example": "Transaction reversed" }, "tags": { "type": "array", "items": { "type": "string", "example": "reversedtransaction" } } } }, "last_modified_date": { "type": "string", "example": "14-Nov-2022 09:20:16" }, "additional_data": { "type": "object", "properties": { "award_transaction_id": { "type": "string", "example": "6368bb4fc7f28f000c2fcf76" } } }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": { "type": "string", "example": "null" } } }, "approved_date": { "type": "string", "example": "14-Nov-2022 09:20:16" }, "member_id": { "type": "string", "example": "john6543" }, "created_date": { "type": "string", "example": "14-Nov-2022 09:20:16" }, "transaction_type": { "type": "string", "example": "deduct" }, "id": { "type": "string", "example": "63720850a042a3000dc1f1c9" }, "deduct_info": { "type": "object", "properties": { "points": { "type": "integer", "example": 1000, "default": 0 }, "points_status": { "type": "string", "example": "deducted" } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{id}": { "get": { "summary": "Retrieve a Transaction with Transaction ID", "operationId": "retrieve-a-transaction-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Enter transaction ID.", "schema": { "type": "string", "default": "62dfc6c6595b7b17ebbf7148" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "points_expiration_date": "03-Mar-2026 00:00:00", "auto_approval_date": "", "last_modified_date": "22-Mar-2023 06:28:51", "redemptions_list": [], "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "exhausted", "activity_name": "Account Creation" }, "id": "640200a652e6a100098e7208", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "03-Mar-2023 14:13:58", "member_id": "5779678689", "created_date": "03-Mar-2023 14:13:58", "transaction_type": "award", "transaction_attributes": { "reason": null, "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "points_expiration_date": { "type": "string", "example": "03-Mar-2026 00:00:00" }, "auto_approval_date": { "type": "string", "example": "" }, "last_modified_date": { "type": "string", "example": "22-Mar-2023 06:28:51" }, "redemptions_list": { "type": "array" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "created_an_account" }, "points": { "type": "integer", "example": 10000, "default": 0 }, "points_status": { "type": "string", "example": "exhausted" }, "activity_name": { "type": "string", "example": "Account Creation" } } }, "id": { "type": "string", "example": "640200a652e6a100098e7208" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "03-Mar-2023 14:13:58" }, "member_id": { "type": "string", "example": "5779678689" }, "created_date": { "type": "string", "example": "03-Mar-2023 14:13:58" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "reason": {}, "tags": { "type": "array" } } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false }, "post": { "summary": "Modify a pending Award Transaction with Transaction ID", "operationId": "modify-a-pending-award-transaction-transaction-id-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Enter transaction ID.", "schema": { "type": "string", "default": "62dfc6c6595b7b17ebbf7148" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_attributes": { "type": "string", "description": "

Every award activity can be modified using this API. You can change the custom attributes for each activity as well as the predefined attributes.

Let's take the example of made_a_purchase activity:

Mandatory attributes are order_total and order_subtotal.

A sample structure of the transaction_attributes for the made_a_purchase activity is given below:

{
\"tags\" : [\"tag1\",\"tag2\"],
\"reason\" : \"purchase\",
\"coupons\" : \"$5OFFVYZ\",
\"order_total\" : \"1000\",
\"order_subtotal\" : \"1000\",

\"products\" : [{
\t\"product_id\": \"112\",
\t\"product_quantity\": \"1\",
\t\"product_category\": \"tshirt\",
\t\"product_price\": \"15\",
\t\"product_title\": \"Sweatshirt\",
\t\"product_image_url\": \"\"
\t},

{
\t\"product_id\": \"980\",
\t\"product_quantity\": \"2\",
\t\"product_category\": \"Sales\",
\t\"product_price\": \"10.017\",
\t\"product_title\": \"Pant\",
\t\"product_image_url\": \"\"
}]

}

Note: You cannot modify the upload_a_photo, submit_a_receipt and code_submission activities.

", "default": "{ \"tags\" : [\"tag1\",\"tag2\"], \"reason\" : \"purchase\", \"coupons\" : \"$5OFFVYZ\", \"order_total\" : \"1000\", \"order_subtotal\" : \"1000\", \"products\" : [{ \"product_id\": \"112\", \"product_quantity\": \"1\", \"product_category\": \"tshirt\", \"product_price\": \"15\", \"product_title\": \"Sweatshirt\", \"product_image_url\": \"\" }, { \"product_id\": \"980\", \"product_quantity\": \"2\", \"product_category\": \"Sales\", \"product_price\": \"10.017\", \"product_title\": \"Pant\", \"product_image_url\": \"\" }] }", "format": "json" }, "approval_date": { "type": "string", "description": "

Date and time on which the transaction will be auto approved. Format : MM/DD/YYYY HH:MM:SS

Note: Our API records all date and time fields in UTC time.

", "default": "10/15/2019 16:10:00" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": {\n \"status\": \"pending\",\n \"points_expiration_date\": \"22-Mar-2026 00:00:00\",\n \"auto_approval_date\": \"23-Oct-2023 16:10:00\",\n \"last_modified_date\": \"22-Mar-2023 09:21:19\",\n \"redemptions_list\": [],\n \"award_info\": {\n \"activity_id\": \"made_a_purchase\",\n \"points\": 1000,\n \"points_status\": \"pending\",\n \"activity_name\": \"Purchase on website\"\n },\n \"id\": \"641ac88fc2161f000b21ff5e\",\n \"approver_details\": {\n \"approver_name\": \"System\",\n \"approver_id\": null\n },\n \"approved_date\": \"\",\n \"member_id\": \"5779678689\",\n \"created_date\": \"22-Mar-2023 09:21:18\",\n \"transaction_type\": \"award\",\n \"transaction_attributes\": {\n \"order_total\": 1000,\n \"products\": [\n {\n \"product_id\": \"112\",\n \"is_excluded\": false,\n \"product_category\": \"tshirt\",\n \"product_url\": \"www.zinrelo.com/sweatshirts\",\n \"product_price\": \"15\",\n \"product_points_per_quantity\": 15,\n \"bonus_multiplier\": 0,\n \"product_quantity\": \"1\",\n \"product_image_url\": \"https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252\",\n \"product_title\": \"Sweatshirt\"\n },\n {\n \"product_id\": \"980\",\n \"is_excluded\": false,\n \"product_category\": \"Sales\",\n \"product_url\": \"www.zinrelo.com/pant\",\n \"product_price\": \"10.017\",\n \"product_points_per_quantity\": 10,\n \"bonus_multiplier\": 0,\n \"product_quantity\": \"2\",\n \"product_image_url\": \"https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252\",\n \"product_title\": \"Pant\"\n }\n ],\n \"coupon_code\": \"$5OFFVYZ\",\n \"order_id\": \"7590984210\",\n \"booked_location\": null,\n \"age\": null,\n \"tags\": [\n \"productpurchased\",\n \"transactioninpendingstatus\"\n ],\n \"currency\": \"dollars\",\n \"reason\": \"purchase\",\n \"favourite_cuisine\": \"indian\",\n \"product_list\": [\"pants\", \"t-shirt\", \"trousers\"],\n \"gender\": \"Male\",\n \"favourite_destination\": \"London\",\n \"order_subtotal\": 1000,\n \"coupons\": \"$5OFFVYZ\"\n },\n \"additional_data\": {\n \"activity_multiplier\": 1,\n \"history\": [\n {\n \"activity_multiplier\": 1,\n \"zrl_products\": [\n {\n \"category\": \"tshirt\",\n \"product_id\": \"112\",\n \"is_excluded\": false,\n \"title\": \"Sweatshirt\",\n \"url\": \"www.zinrelo.com/tshirt\",\n \"price\": \"15\",\n \"product_points_per_quantity\": 15,\n \"bonus_multiplier\": 0,\n \"img_url\": \"https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252\",\n \"quantity\": \"1\"\n },\n {\n \"category\": \"Sales\",\n \"product_id\": \"980\",\n \"is_excluded\": false,\n \"title\": \"Pant\",\n \"url\": \"www.zinrelo.com/pant\",\n \"price\": \"10.017\",\n \"product_points_per_quantity\": 10,\n \"bonus_multiplier\": 0,\n \"img_url\": \"https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252\",\n \"quantity\": \"2\"\n }\n ],\n }\n },\n \"success\": true\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{order_id}": { "get": { "summary": "Retrieve a transaction with Order ID", "operationId": "retrieve-a-transaction-with-order-id-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "order_id", "in": "path", "description": "Enter the order id.", "schema": { "type": "string" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'order_id' as idParam.", "required": true, "schema": { "type": "string", "default": "order_id" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "points_expiration_date": "23-Aug-2023 06:00:11", "auto_approval_date": "07-Sep-2022 06:00:11", "last_modified_date": "23-Aug-2022 06:00:48", "award_info": { "activity_id": "made_a_purchase", "points": 10000, "points_status": "approved", "activity_name": "Purchase on website" }, "id": "63046ceb8d7cfa7d39a18457", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "23-Aug-2022 06:00:48", "member_id": "76543", "created_date": "23-Aug-2022 06:00:11", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "order_subtotal": 10000, "order_id": "70", "tags": [ "purchasemade", "octoberpurchase" ], "currency": null, "coupon_code": null, "reason": "purchase", "products": [ { "product_id": "112", "is_excluded": false, "product_category": "tshirt", "product_url": null, "product_price": 15, "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": 1, "product_image_url": "", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": "false", "product_category": "Sales", "product_url": null, "product_price": 10, "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": 2, "product_image_url": "", "product_title": "Pant" } ], "coupons": null }, "additional_data": { "activity_multiplier": 1 } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "points_expiration_date": { "type": "string", "example": "23-Aug-2023 06:00:11" }, "auto_approval_date": { "type": "string", "example": "07-Sep-2022 06:00:11" }, "last_modified_date": { "type": "string", "example": "23-Aug-2022 06:00:48" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "made_a_purchase" }, "points": { "type": "integer", "example": 10000, "default": 0 }, "points_status": { "type": "string", "example": "approved" }, "activity_name": { "type": "string", "example": "Purchase on website" } } }, "id": { "type": "string", "example": "63046ceb8d7cfa7d39a18457" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "23-Aug-2022 06:00:48" }, "member_id": { "type": "string", "example": "76543" }, "created_date": { "type": "string", "example": "23-Aug-2022 06:00:11" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "order_total": { "type": "integer", "example": 1000, "default": 0 }, "order_subtotal": { "type": "integer", "example": 10000, "default": 0 }, "order_id": { "type": "string", "example": "70" }, "tags": { "type": "array", "items": { "type": "string", "example": "purchasemade" } }, "currency": {}, "coupon_code": {}, "reason": { "type": "string", "example": "purchase" }, "products": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "string", "example": "112" }, "is_excluded": { "type": "boolean", "example": false, "default": true }, "product_category": { "type": "string", "example": "tshirt" }, "product_url": {}, "product_price": { "type": "integer", "example": 15, "default": 0 }, "product_points_per_quantity": { "type": "integer", "example": 15, "default": 0 }, "bonus_multiplier": { "type": "integer", "example": 0, "default": 0 }, "product_quantity": { "type": "integer", "example": 1, "default": 0 }, "product_image_url": { "type": "string", "example": "" }, "product_title": { "type": "string", "example": "Sweatshirt" } } } }, "coupons": {} } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{unique_transaction_attribute}": { "get": { "summary": "Retrieve a Transaction using Unique Transaction Attribute", "operationId": "retrieve-a-transaction-using-unique-custom-transaction-attribute-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "idParam", "in": "query", "description": "The idParam for purchase activity will be order_id, but if you have created any unique transaction attribute like serial_number, invoice_number, etc., then place it as an idParam.", "required": true, "schema": { "type": "string", "default": "order_id" } }, { "name": "unique_transaction_attribute", "in": "path", "description": "Pass the value that was stored against the client internal id.", "schema": { "type": "string", "default": "752245347" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "points_expiration_date": "07-Nov-2023 00:00:00", "auto_approval_date": "19-Nov-2022 16:10:00", "last_modified_date": "14-Nov-2022 09:19:17", "redemptions_list": [ { "redemption_id": "reward_b7f19", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f34", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "id": "6368bb4fc7f28f000c2fcf76", "approver_details": { "approver_name": "System", "approver_id": "null" }, "approved_date": "14-Nov-2022 09:19:17", "member_id": "john76543", "created_date": "07-Nov-2022 07:55:31", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "order_subtotal": 1000, "order_id": "752245347", "tags": [ "retrieveatransaction", "transactionretrieved" ], "currency": "Dollars", "coupon_code": "$5OFFVYZ", "reason": "purchase", "products": [ { "product_id": "1126", "is_excluded": false, "product_category": "tshirt", "product_url": "www.zinrelo.com/sweatshirt", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "www.zinrelo.com/pant", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "Pant" } ], "coupons": "$5OFFVYZ" }, "additional_data": { "activity_multiplier": 1, "history": [ { "activity_multiplier": 1, "zrl_products": [ { "category": "tshirt", "product_id": "112", "is_excluded": false, "title": "Sweatshirt", "url": "www.zinrelo.com/tshirt", "price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "img_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "quantity": "1" }, { "category": "Sales", "product_id": "980", "is_excluded": false, "title": "Pant", "url": "www.zinrelo.com/pant", "price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "img_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "quantity": "2" } ], "current_loyalty_level_id": "zrl_silver", "custom_attributes": {}, "points": 1000, "created_time": "2022-11-07 07:55:31.854000" } ] } }, "success": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false }, "post": { "summary": "Modify a pending Award Transaction using Unique Transaction Attribute", "operationId": "modify-a-pending-award-transaction-using-unique-transaction-attribute-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "unique_transaction_attribute", "in": "path", "description": "Pass the value that was stored against the client internal id.", "schema": { "type": "string", "default": "752245347" }, "required": true }, { "name": "idParam", "in": "query", "description": "The idParam for purchase activity will be order_id, but if you have created any unique transaction attribute like serial_number, invoice_number, etc., then replace it as an idParam.", "required": true, "schema": { "type": "string", "default": "order_id" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transaction_attributes": { "type": "string", "description": "

Every award activity can be modified using this API. You can change the custom attributes for each activity as well as the predefined attributes.

Let's take the example of made_a_purchase activity:

Mandatory attributes are order_total and order_subtotal.

A sample structure of the transaction_attributes for the made_a_purchase activity is given below:

{
\"tags\" : [\"tag1\",\"tag2\"],
\"reason\" : \"purchase\",
\"coupons\" : \"$5OFFVYZ\",
\"order_total\" : \"1000\",
\"order_subtotal\" : \"1000\",

\"products\" : [{
\t\"product_id\": \"112\",
\t\"product_quantity\": \"1\",
\t\"product_category\": \"tshirt\",
\t\"product_price\": \"15\",
\t\"product_title\": \"Sweatshirt\",
\t\"product_image_url\": \"\"
\t},

{
\t\"product_id\": \"980\",
\t\"product_quantity\": \"2\",
\t\"product_category\": \"Sales\",
\t\"product_price\": \"10.017\",
\t\"product_title\": \"Pant\",
\t\"product_image_url\": \"\"
}]

}

Note: You cannot modify the upload_a_photo, submit_a_receipt and code_submission activities.

", "default": "{ \"tags\" : [\"tag1\",\"tag2\"], \"reason\" : \"purchase\", \"order_id\" : \"75\", \"coupons\" : \"$5OFFVYZ\", \"order_total\" : \"1000\", \"order_subtotal\" : \"1000\", \"products\" : [{ \"product_id\": \"112\", \"product_quantity\": \"1\", \"product_category\": \"tshirt\", \"product_price\": \"15\", \"product_title\": \"Sweatshirt\", \"product_image_url\": \"\" }, { \"product_id\": \"980\", \"product_quantity\": \"2\", \"product_category\": \"Sales\", \"product_price\": \"10.017\", \"product_title\": \"Pant\", \"product_image_url\": \"\" }] }", "format": "json" }, "approval_date": { "type": "string", "description": "

Date and time on which the transaction will be auto approved. Format : ;MM/DD/YYYY HH:MM:SS

Note: Our API records all date and time fields in UTC time.

", "default": "10/15/2019 16:10:00" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "pending", "points_expiration_date": "07-Nov-2023 00:00:00", "auto_approval_date": "19-Nov-2022 16:10:00", "last_modified_date": "07-Nov-2022 08:01:19", "redemptions_list": [], "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "redemption_pending", "activity_name": "Purchase on website" }, "id": "6368bb4fc7f28f000c2fcf76", "approver_details": { "approver_name": "System", "approver_id": "null" }, "approved_date": "14-Nov-2022 09:19:17", "member_id": "76543", "created_date": "07-Nov-2022 07:55:31", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "order_subtotal": 1000, "order_id": "752245347", "tags": [ "transactionmodified", "modifyingawardtransaction" ], "currency": "Dollars", "coupon_code": "$5OFFVYZ", "reason": "purchase", "products": [ { "product_id": "1126", "is_excluded": false, "product_category": "tshirt", "product_url": "www.zinrelo.com/sweatshirt", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "www.zinrelo.com/pant", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "Pant" } ], "coupons": "$5OFFVYZ" }, "additional_data": { "activity_multiplier": 1, "history": [ { "activity_multiplier": 1, "zrl_products": [ { "category": "tshirt", "product_id": "112", "is_excluded": false, "title": "Sweatshirt", "url": "www.zinrelo.com/tshirt", "price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "img_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "quantity": "1" }, { "category": "Sales", "product_id": "980", "is_excluded": false, "title": "Pant", "url": "www.zinrelo.com/pant", "price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "img_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "quantity": "2" } ], "current_loyalty_level_id": "zrl_silver", "custom_attributes": {}, "points": 1000, "created_time": "2022-11-07 07:55:31.854000" } ] } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "pending" }, "points_expiration_date": { "type": "string", "example": "07-Nov-2023 00:00:00" }, "auto_approval_date": { "type": "string", "example": "19-Nov-2022 16:10:00" }, "last_modified_date": { "type": "string", "example": "07-Nov-2022 08:01:19" }, "redemptions_list": { "type": "array" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "made_a_purchase" }, "points": { "type": "integer", "example": 1000, "default": 0 }, "points_status": { "type": "string", "example": "redemption_pending" }, "activity_name": { "type": "string", "example": "Purchase on website" } } }, "id": { "type": "string", "example": "6368bb4fc7f28f000c2fcf76" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": { "type": "string", "example": "null" } } }, "approved_date": { "type": "string", "example": "14-Nov-2022 09:19:17" }, "member_id": { "type": "string", "example": "76543" }, "created_date": { "type": "string", "example": "07-Nov-2022 07:55:31" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "order_total": { "type": "integer", "example": 1000, "default": 0 }, "order_subtotal": { "type": "integer", "example": 1000, "default": 0 }, "order_id": { "type": "string", "example": "752245347" }, "tags": { "type": "array", "items": { "type": "string", "example": "transactionmodified" } }, "currency": { "type": "string", "example": "Dollars" }, "coupon_code": { "type": "string", "example": "$5OFFVYZ" }, "reason": { "type": "string", "example": "purchase" }, "products": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "string", "example": "1126" }, "is_excluded": { "type": "boolean", "example": false, "default": true }, "product_category": { "type": "string", "example": "tshirt" }, "product_url": { "type": "string", "example": "www.zinrelo.com/sweatshirt" }, "product_price": { "type": "string", "example": "15" }, "product_points_per_quantity": { "type": "integer", "example": 15, "default": 0 }, "bonus_multiplier": { "type": "integer", "example": 0, "default": 0 }, "product_quantity": { "type": "string", "example": "1" }, "product_image_url": { "type": "string", "example": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" }, "product_title": { "type": "string", "example": "Sweatshirt" } } } }, "coupons": { "type": "string", "example": "$5OFFVYZ" } } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 }, "history": { "type": "array", "items": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 }, "zrl_products": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "example": "tshirt" }, "product_id": { "type": "string", "example": "112" }, "is_excluded": { "type": "boolean", "example": false, "default": true }, "title": { "type": "string", "example": "Sweatshirt" }, "url": { "type": "string", "example": "www.zinrelo.com/tshirt" }, "price": { "type": "string", "example": "15" }, "product_points_per_quantity": { "type": "integer", "example": 15, "default": 0 }, "bonus_multiplier": { "type": "integer", "example": 0, "default": 0 }, "img_url": { "type": "string", "example": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" }, "quantity": { "type": "string", "example": "1" } } } }, "current_loyalty_level_id": { "type": "string", "example": "zrl_silver" }, "custom_attributes": { "type": "object", "properties": {} }, "points": { "type": "integer", "example": 1000, "default": 0 }, "created_time": { "type": "string", "example": "2022-11-07 07:55:31.854000" } } } } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{id}/approve": { "post": { "summary": "Approve a Pending Award/Redeem Transaction using ID", "operationId": "approve-a-pending-award-transaction-using-transaction-id-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Enter transaction ID.", "schema": { "type": "string", "default": "62dfc6c6595b7b17ebbf7148" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "points_expiration_date": "03-Mar-2026 00:00:00", "auto_approval_date": "", "last_modified_date": "22-Mar-2023 06:28:51", "redemptions_list": [], "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "exhausted", "activity_name": "Account Creation" }, "id": "640200a652e6a100098e7208", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "03-Mar-2023 14:13:58", "member_id": "5779678689", "created_date": "03-Mar-2023 14:13:58", "transaction_type": "award", "transaction_attributes": { "reason": null, "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "points_expiration_date": { "type": "string", "example": "03-Mar-2026 00:00:00" }, "auto_approval_date": { "type": "string", "example": "" }, "last_modified_date": { "type": "string", "example": "22-Mar-2023 06:28:51" }, "redemptions_list": { "type": "array" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "created_an_account" }, "points": { "type": "integer", "example": 10000, "default": 0 }, "points_status": { "type": "string", "example": "exhausted" }, "activity_name": { "type": "string", "example": "Account Creation" } } }, "id": { "type": "string", "example": "640200a652e6a100098e7208" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "03-Mar-2023 14:13:58" }, "member_id": { "type": "string", "example": "5779678689" }, "created_date": { "type": "string", "example": "03-Mar-2023 14:13:58" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "reason": {}, "tags": { "type": "array" } } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{order_id}/approve": { "post": { "summary": "Approve a pending award transaction using Order ID", "operationId": "approve-a-pending-award-transaction-using-order-id", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "order_id", "in": "path", "description": "Enter the order id.", "schema": { "type": "string" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'order_id' as idParam.", "required": true, "schema": { "type": "string", "default": "order_id" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "points_expiration_date": "17-Oct-2023 12:33:29", "auto_approval_date": "01-Nov-2022 12:33:29", "last_modified_date": "17-Oct-2022 12:54:12", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "id": "634d4b9a1b2037000deb12d1", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "17-Oct-2022 12:54:12", "member_id": "76543", "created_date": "17-Oct-2022 12:33:29", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "order_subtotal": 1000, "order_id": "75000", "tags": [ "purchasemade", "novemberpurchase" ], "currency": null, "coupon_code": "$5OFFVYZ", "reason": "purchase", "products": [ { "product_id": "112", "is_excluded": false, "product_category": "tshirt", "product_url": null, "product_price": 15, "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": 1, "product_image_url": "", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": null, "product_price": 10, "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": 2, "product_image_url": "", "product_title": "Pant" } ], "coupons": "$5OFFVYZ" }, "additional_data": { "activity_multiplier": 1 } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "points_expiration_date": { "type": "string", "example": "17-Oct-2023 12:33:29" }, "auto_approval_date": { "type": "string", "example": "01-Nov-2022 12:33:29" }, "last_modified_date": { "type": "string", "example": "17-Oct-2022 12:54:12" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "made_a_purchase" }, "points": { "type": "integer", "example": 1000, "default": 0 }, "points_status": { "type": "string", "example": "approved" }, "activity_name": { "type": "string", "example": "Purchase on website" } } }, "id": { "type": "string", "example": "634d4b9a1b2037000deb12d1" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "17-Oct-2022 12:54:12" }, "member_id": { "type": "string", "example": "76543" }, "created_date": { "type": "string", "example": "17-Oct-2022 12:33:29" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "order_total": { "type": "integer", "example": 1000, "default": 0 }, "order_subtotal": { "type": "integer", "example": 1000, "default": 0 }, "order_id": { "type": "string", "example": "75000" }, "tags": { "type": "array", "items": { "type": "string", "example": "purchasemade" } }, "currency": {}, "coupon_code": { "type": "string", "example": "$5OFFVYZ" }, "reason": { "type": "string", "example": "purchase" }, "products": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "string", "example": "112" }, "is_excluded": { "type": "boolean", "example": false, "default": true }, "product_category": { "type": "string", "example": "tshirt" }, "product_url": {}, "product_price": { "type": "integer", "example": 15, "default": 0 }, "product_points_per_quantity": { "type": "integer", "example": 15, "default": 0 }, "bonus_multiplier": { "type": "integer", "example": 0, "default": 0 }, "product_quantity": { "type": "integer", "example": 1, "default": 0 }, "product_image_url": { "type": "string", "example": "" }, "product_title": { "type": "string", "example": "Sweatshirt" } } } }, "coupons": { "type": "string", "example": "$5OFFVYZ" } } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{unique_transaction_attribute}/approve": { "post": { "summary": "Approve a Pending Award/Redeem Transaction using Unique Transaction Attribute", "operationId": "approve-a-pending-transaction-using-unique-custom-transaction-attribute-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "unique_transaction_attribute", "in": "path", "description": "Pass the value that was stored against the client internal id.", "schema": { "type": "string", "default": "752245347" }, "required": true }, { "name": "idParam", "in": "query", "description": "The idParam for purchase activity will be order_id, but if you have created any unique transaction attribute like serial_number, invoice_number, etc., then replace it as an idParam.", "required": true, "schema": { "type": "string", "default": "order_id" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "approved", "points_expiration_date": "17-Oct-2023 00:00:00", "auto_approval_date": "", "last_modified_date": "17-Oct-2022 12:50:50", "redemptions_list": [], "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "id": "634d4c87dfa6b7678ea4dd1a", "approver_details": { "approver_name": "System", "approver_id": "null" }, "approved_date": "17-Oct-2022 12:50:50", "member_id": "76543", "created_date": "17-Oct-2022 12:37:26", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "order_subtotal": 1000, "order_id": "750001", "tags": [ "purchasemade", "novemberpurchse" ], "currency": "Dollars", "coupon_code": "$5OFFVYZ", "reason": "purchase", "products": [ { "product_id": "1126", "is_excluded": false, "product_category": "tshirt", "product_url": "www.zinrelo.com/sweatshirt", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "www.zinrelo.com/pant", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252", "product_title": "Pant" } ], "coupons": "$5OFFVYZ" }, "additional_data": { "activity_multiplier": 1 } }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "approved" }, "points_expiration_date": { "type": "string", "example": "17-Oct-2023 00:00:00" }, "auto_approval_date": { "type": "string", "example": "" }, "last_modified_date": { "type": "string", "example": "17-Oct-2022 12:50:50" }, "redemptions_list": { "type": "array" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "made_a_purchase" }, "points": { "type": "integer", "example": 1000, "default": 0 }, "points_status": { "type": "string", "example": "approved" }, "activity_name": { "type": "string", "example": "Purchase on website" } } }, "id": { "type": "string", "example": "634d4c87dfa6b7678ea4dd1a" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": { "type": "string", "example": "null" } } }, "approved_date": { "type": "string", "example": "17-Oct-2022 12:50:50" }, "member_id": { "type": "string", "example": "76543" }, "created_date": { "type": "string", "example": "17-Oct-2022 12:37:26" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "order_total": { "type": "integer", "example": 1000, "default": 0 }, "order_subtotal": { "type": "integer", "example": 1000, "default": 0 }, "order_id": { "type": "string", "example": "750001" }, "tags": { "type": "array", "items": { "type": "string", "example": "purchasemade" } }, "currency": { "type": "string", "example": "Dollars" }, "coupon_code": { "type": "string", "example": "$5OFFVYZ" }, "reason": { "type": "string", "example": "purchase" }, "products": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "string", "example": "1126" }, "is_excluded": { "type": "boolean", "example": false, "default": true }, "product_category": { "type": "string", "example": "tshirt" }, "product_url": { "type": "string", "example": "www.zinrelo.com/sweatshirt" }, "product_price": { "type": "string", "example": "15" }, "product_points_per_quantity": { "type": "integer", "example": 15, "default": 0 }, "bonus_multiplier": { "type": "integer", "example": 0, "default": 0 }, "product_quantity": { "type": "string", "example": "1" }, "product_image_url": { "type": "string", "example": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" }, "product_title": { "type": "string", "example": "Sweatshirt" } } } }, "coupons": { "type": "string", "example": "$5OFFVYZ" } } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{id}/reject": { "post": { "summary": "Reject a pending award/redeem transaction using ID", "operationId": "reject-a-pending-award-transaction-using-transaction-id-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Enter transaction ID.", "schema": { "type": "string", "default": "62dfc6c6595b7b17ebbf7148" }, "required": true }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "rejected", "transaction_attributes": { "reason": "redeem", "source_of_redemption": "api", "tags": [ "purchasenmade", "redeemingpoints" ] }, "last_modified_date": "17-Oct-2022 12:41:47", "additional_data": { "points_to_be_redeemed": 1000 }, "approver_details": { "approver_name": "Zinrelo", "approver_id": "zinrelo57578" }, "approved_date": "17-Oct-2022 12:41:47", "reward_info": { "reward_name": "$5 OFF COUPON", "points_status": "redemption_cancelled", "coupon_code": "AEAD49CC", "reward_link": null, "reward_id": "reward_bc668", "points": 1000 }, "member_id": "76543", "created_date": "17-Oct-2022 12:41:47", "transaction_type": "redeem", "id": "634d4d8be6006a68add5893b" }, "success": true } } }, "schema": { "oneOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "rejected" }, "points_expiration_date": { "type": "string", "example": "06-Oct-2023 00:00:00" }, "auto_approval_date": { "type": "string", "example": "" }, "last_modified_date": { "type": "string", "example": "22-Mar-2023 09:04:32" }, "redemptions_list": { "type": "array" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "example": "upload_photo" }, "points": { "type": "integer", "example": 5000, "default": 0 }, "points_status": { "type": "string", "example": "rejected" }, "activity_name": { "type": "string", "example": "Upload a Photo" } } }, "id": { "type": "string", "example": "63fd9a72c3ec50000dade39f" }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "System" }, "approver_id": {} } }, "approved_date": { "type": "string", "example": "" }, "member_id": { "type": "string", "example": "john.doe@gmail.com" }, "created_date": { "type": "string", "example": "28-Feb-2023 06:08:50" }, "transaction_type": { "type": "string", "example": "award" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string", "example": "pendingtransaction" }, "tags": { "type": "array" } } }, "additional_data": { "type": "object", "properties": { "activity_multiplier": { "type": "integer", "example": 1, "default": 0 } } } } }, "success": { "type": "boolean", "example": true, "default": true } } }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "rejected" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string", "example": "redeem" }, "source_of_redemption": { "type": "string", "example": "api" }, "tags": { "type": "array", "items": { "type": "string", "example": "purchasenmade" } } } }, "last_modified_date": { "type": "string", "example": "17-Oct-2022 12:41:47" }, "additional_data": { "type": "object", "properties": { "points_to_be_redeemed": { "type": "integer", "example": 1000, "default": 0 } } }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "Zinrelo" }, "approver_id": { "type": "string", "example": "zinrelo57578" } } }, "approved_date": { "type": "string", "example": "17-Oct-2022 12:41:47" }, "reward_info": { "type": "object", "properties": { "reward_name": { "type": "string", "example": "$5 OFF COUPON" }, "points_status": { "type": "string", "example": "redemption_cancelled" }, "coupon_code": { "type": "string", "example": "AEAD49CC" }, "reward_link": {}, "reward_id": { "type": "string", "example": "reward_bc668" }, "points": { "type": "integer", "example": 1000, "default": 0 } } }, "member_id": { "type": "string", "example": "76543" }, "created_date": { "type": "string", "example": "17-Oct-2022 12:41:47" }, "transaction_type": { "type": "string", "example": "redeem" }, "id": { "type": "string", "example": "634d4d8be6006a68add5893b" } } }, "success": { "type": "boolean", "example": true, "default": true } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions/{unique_transaction_attribute}/reject": { "post": { "summary": "Reject a Pending Award/Redeem Transaction using Unique Transaction Attribute", "operationId": "reject-a-pending-award-transaction-using-unique-transaction-attribute-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "unique_transaction_attribute", "in": "path", "description": "Pass the value that was stored against the client internal id.", "schema": { "type": "string", "default": "752245347" }, "required": true }, { "name": "idParam", "in": "query", "description": "The idParam for purchase activity will be order_id, but if you have created any unique transaction attribute like serial_number, invoice_number, etc., then replace it as an idParam.", "required": true, "schema": { "type": "string", "default": "order_id" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "status": "rejected", "transaction_attributes": { "reason": "redeem", "source_of_redemption": "api", "tags": [ "purchasenmade", "redeemingpoints" ] }, "last_modified_date": "17-Oct-2022 12:41:47", "additional_data": { "points_to_be_redeemed": 1000 }, "approver_details": { "approver_name": "Zinrelo", "approver_id": "zinrelo57578" }, "approved_date": "17-Oct-2022 12:41:47", "reward_info": { "reward_name": "$5 OFF COUPON", "points_status": "redemption_cancelled", "coupon_code": "AEAD49CC", "reward_link": null, "reward_id": "reward_bc668", "points": 1000 }, "member_id": "76543", "created_date": "17-Oct-2022 12:41:47", "transaction_type": "redeem", "id": "634d4d8be6006a68add5893b" }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "status": { "type": "string", "example": "rejected" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string", "example": "redeem" }, "source_of_redemption": { "type": "string", "example": "api" }, "tags": { "type": "array", "items": { "type": "string", "example": "purchasenmade" } } } }, "last_modified_date": { "type": "string", "example": "17-Oct-2022 12:41:47" }, "additional_data": { "type": "object", "properties": { "points_to_be_redeemed": { "type": "integer", "example": 1000, "default": 0 } } }, "approver_details": { "type": "object", "properties": { "approver_name": { "type": "string", "example": "Zinrelo" }, "approver_id": { "type": "string", "example": "zinrelo57578" } } }, "approved_date": { "type": "string", "example": "17-Oct-2022 12:41:47" }, "reward_info": { "type": "object", "properties": { "reward_name": { "type": "string", "example": "$5 OFF COUPON" }, "points_status": { "type": "string", "example": "redemption_cancelled" }, "coupon_code": { "type": "string", "example": "AEAD49CC" }, "reward_link": {}, "reward_id": { "type": "string", "example": "reward_bc668" }, "points": { "type": "integer", "example": 1000, "default": 0 } } }, "member_id": { "type": "string", "example": "76543" }, "created_date": { "type": "string", "example": "17-Oct-2022 12:41:47" }, "transaction_type": { "type": "string", "example": "redeem" }, "id": { "type": "string", "example": "634d4d8be6006a68add5893b" } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/transactions": { "get": { "summary": "List all Transactions", "operationId": "list-all-transactions-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "in": "query", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "type": "integer", "format": "int32" } }, { "name": "approved_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their approved_date in Trueloyal. Child parameters are:

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: approved_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: approved_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: approved_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: approved_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: approved_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: approved_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"eq\":\"01/21/2022\"}" } }, { "name": "created_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their created_date in Trueloyal. Child parameters are

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: created_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: created_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: created_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: created_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: created_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: created_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"gt\":\"01/21/2022\"}" } }, { "name": "last_modified_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their last_modified date in Trueloyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: last_modified_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: last_modified_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: last_modified_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: last_modified_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: last_modified_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: last_modified_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"gte\":\"01/21/2022\"}" } }, { "name": "points_expiration_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their points_expiration_date in Trueloyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: points_expiration_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: points_expiration_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: points_expiration_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: points_expiration_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: points_expiration_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: points_expiration_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"lte\":\"01/21/2022\"}" } }, { "name": "points_status", "in": "query", "description": "

This filter will return the point status.

The value can be passed as:

eq: Accepted values are ‘approved, rejected, pending, redeemed, deducted, expired, redemption_pending, redemption_cancelled, pending_deduction, auto_rejected and auto_approved.' Pass the value of the status to get a list of all transactions with points_status equal to the value passed.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "

This filter will return transaction status.

eq: Accepted values are Approved/ Rejected/ Pending.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 15, "next_cursor": 100, "transactions": [ { "status": "approved", "points_expiration_date": "15-Dec-2023 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7fe8", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f20", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "29-Mar-2023 11:17:22", "award_info": { "activity_id": "birthday_bonus", "points": 100, "points_status": "approved", "activity_name": "Birthday Bonus" }, "id": "64241e42df3c93000ab0550a", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "29-Mar-2023 11:17:22", "member_id": "6487956750503", "created_date": "29-Mar-2023 11:17:21", "transaction_type": "award", "transaction_attributes": { "reason": "testing", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "pending", "points_expiration_date": "22-Mar-2026 00:00:00", "redemptions_list": [], "auto_approval_date": "23-Oct-2023 16:10:00", "last_modified_date": "22-Mar-2023 09:21:19", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "pending", "activity_name": "Purchase on website" }, "id": "641ac88fc2161f000b21ff5e", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "", "member_id": "5779678689", "created_date": "22-Mar-2023 09:21:18", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "products": [ { "product_id": "112", "is_excluded": false, "product_category": "tshirt", "product_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097610.png", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_title": "Pant" } ], "coupon_code": "$5OFFVYZ", "order_id": "7590984210", "booked_location": null, "age": null, "tags": [ "successful", "purchased" ], "currency": "$", "reason": "purchase", "favourite_cuisine": "Indian", "gender": null, "order_subtotal": 1000, "coupons": "$5OFFVYZ" }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "points_expiration_date": "22-Mar-2026 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7f22", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f8", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "22-Mar-2023 09:15:00", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "id": "641ac714ce841d000b9d0e7c", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 09:15:00", "member_id": "5779678689", "created_date": "22-Mar-2023 09:14:59", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "products": [ { "product_id": "112", "is_excluded": false, "product_category": "tshirt", "product_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_title": "Pant" } ], "coupon_code": "$5OFFVYZ", "order_id": "75909842", "booked_location": "UK", "age": 25, "tags": [ "awarded", "purchased" ], "currency": "$", "reason": "purchase", "favourite_cuisine": "Chinese", "order_subtotal": 1000, "coupons": "$5OFFVYZ" }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "transaction_attributes": { "reason": "Transaction reversed", "tags": [] }, "last_modified_date": "22-Mar-2023 06:28:51", "additional_data": { "award_transaction_id": "640200a652e6a100098e7208" }, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 06:24:57", "member_id": "pallavi+1003@zinrelo.com", "created_date": "22-Mar-2023 06:24:57", "transaction_type": "deduct", "id": "641a9f39d2e73e0009ca2ec5", "deduct_info": { "points": 10000, "points_status": "deducted" } }, { "status": "approved", "transaction_attributes": { "reason": "deduct", "tags": [ "deductionmade", "productreturned" ] }, "last_modified_date": "22-Mar-2023 06:23:24", "additional_data": {}, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 06:19:35", "member_id": "5779678689", "created_date": "22-Mar-2023 06:19:35", "transaction_type": "deduct", "id": "641a9df7c2161f000c2eb56a", "deduct_info": { "points": 100, "points_status": "deducted" } }, { "status": "approved", "transaction_attributes": { "returned_product_id": null, "tags": [], "order_id": "7597659870", "reason": "Order partially returned", "returned_amount": 200, "returned_product_quantity": null }, "last_modified_date": "22-Mar-2023 06:16:21", "additional_data": { "returned_orders_revenue": 200, "product_id": "BNIE087", "quantity": 1 }, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 06:14:15", "member_id": "5779678689", "created_date": "22-Mar-2023 06:14:15", "transaction_type": "deduct", "id": "641a9cb7c2161f000c2eb553", "deduct_info": { "points": 200, "points_status": "deducted" } }, { "status": "rejected", "transaction_attributes": { "reason": "Product Redemption Failed", "source_of_redemption": "api", "tags": [ "purchasemade", "redeemingpoints" ] }, "last_modified_date": "22-Mar-2023 06:09:12", "additional_data": { "points_to_be_redeemed": 1400 }, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Mar-2023 05:54:11", "reward_info": { "reward_name": "$15 OFF COUPON", "points_status": "redemption_cancelled", "coupon_code": "81c0bd3b", "reward_link": null, "reward_id": "reward_9c350", "points": 1400 }, "member_id": "5779678689", "created_date": "22-Mar-2023 05:54:11", "transaction_type": "redeem", "id": "641a9804c2161f000ee6e469" }, { "status": "approved", "points_expiration_date": "03-Mar-2026 00:00:00", "redemptions_list": [], "auto_approval_date": "", "last_modified_date": "22-Mar-2023 06:28:51", "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "exhausted", "activity_name": "Account Creation" }, "id": "640200a652e6a100098e7208", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "03-Mar-2023 14:13:58", "member_id": "pallavi+1003@zinrelo.com", "created_date": "03-Mar-2023 14:13:58", "transaction_type": "award", "transaction_attributes": { "reason": "accountcreated", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "transaction_attributes": { "reason": "Deleted", "tags": [] }, "last_modified_date": "03-Mar-2023 14:11:12", "additional_data": {}, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "03-Mar-2023 14:11:12", "member_id": "6401ff828bae46000a6b8932", "created_date": "03-Mar-2023 14:11:12", "transaction_type": "deduct", "id": "6402000076759900104870e5", "deduct_info": { "points": 10000, "points_status": "deducted" } }, { "status": "approved", "transaction_attributes": { "reason": "Deleted", "tags": [] }, "last_modified_date": "03-Mar-2023 14:11:11", "additional_data": {}, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "03-Mar-2023 14:11:11", "member_id": "6401feba11a735000c24a260", "created_date": "03-Mar-2023 14:11:11", "transaction_type": "deduct", "id": "6401ffff76759900134870f0", "deduct_info": { "points": 10000, "points_status": "deducted" } }, { "status": "approved", "points_expiration_date": "03-Mar-2026 00:00:00", "auto_approval_date": "", "last_modified_date": "03-Mar-2023 14:10:31", "redemptions_list": [ { "redemption_id": "reward_b7f05", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7fe7", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "approved", "activity_name": "Account Creation" }, "id": "6401ffd7bc8a7b03ed0b2fce", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "03-Mar-2023 14:10:31", "member_id": "pallavi+1001@zinrelo.com", "created_date": "03-Mar-2023 14:10:31", "transaction_type": "award", "transaction_attributes": { "reason": null, "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "points_expiration_date": "17-Jun-2023 00:00:00", "redemptions_list": [], "auto_approval_date": "", "last_modified_date": "26-Feb-2023 00:25:14", "award_info": { "activity_id": "birthday_bonus", "points": 130, "points_status": "approved", "activity_name": "Birthday Bonus" }, "id": "63faa6ea19c62400133bceae", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "26-Feb-2023 00:25:14", "member_id": "2345", "created_date": "26-Feb-2023 00:25:14", "transaction_type": "award", "transaction_attributes": { "reason": "birthday", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "rejected", "transaction_attributes": { "reason": "Product Redemption Failed", "source_of_redemption": "api", "tags": [] }, "last_modified_date": "08-Feb-2023 07:53:24", "additional_data": {}, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "08-Feb-2023 07:38:24", "reward_info": { "reward_name": "$5 OFF COUPON", "points_status": "redemption_cancelled", "coupon_code": "4458FD49", "reward_link": null, "reward_id": "reward_bc668", "points": 750 }, "member_id": "5779678689", "created_date": "08-Feb-2023 07:38:24", "transaction_type": "redeem", "id": "63e35170322067000b9bc8fe" }, { "status": "approved", "points_expiration_date": "22-Mar-2026 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7fe1", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7fe2", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "07-Feb-2023 06:58:07", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "id": "63e1f67f0949ed000b3a658f", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "07-Feb-2023 06:58:07", "member_id": "5779678689", "created_date": "07-Feb-2023 06:58:07", "transaction_type": "award", "transaction_attributes": { "order_total": 1000, "products": [ { "product_id": "112", "is_excluded": false, "product_category": "tshirt", "product_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "product_title": "Pant" } ], "coupon_code": "$5OFFVYZ", "order_id": "7597659870", "booked_location": "US", "age": 51, "tags": [ "purchaseactivity", "purchasemade" ], "currency": "$", "reason": "purchase", "favourite_cuisine": "Continental", "gender": "Male", "order_subtotal": 1000, "coupons": "$5OFFVYZ" }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "points_expiration_date": "18-Jan-2024 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7fe3", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7fe4", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "17-Jan-2023 09:54:34", "award_info": { "activity_id": "share_on_pinterest", "points": 1000, "points_status": "approved", "activity_name": "Share on Pinterest" }, "id": "63c6705a4b1736000b826a7d", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "17-Jan-2023 09:54:34", "member_id": "6508075909287", "created_date": "17-Jan-2023 09:54:33", "transaction_type": "award", "transaction_attributes": { "reason": "testing", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "transaction_attributes": { "reason": "testing", "source_of_redemption": "manual", "tags": [] }, "last_modified_date": "17-Jan-2023 09:53:45", "additional_data": {}, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "17-Jan-2023 09:53:45", "reward_info": { "reward_name": "$5 OFF COUPON", "points_status": "redeemed", "coupon_code": "8D1A3ED4", "reward_link": null, "reward_id": "reward_bc668", "points": 750 }, "member_id": "6508075909287", "created_date": "17-Jan-2023 09:53:45", "transaction_type": "redeem", "id": "63c670294b1736000b826a6a" }, { "status": "approved", "points_expiration_date": "18-Jan-2024 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7fe6", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7fe7", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "16-Jan-2023 12:05:27", "award_info": { "activity_id": "share_on_twitter", "points": 1000, "points_status": "approved", "activity_name": "Share on Twitter" }, "id": "63c53d87ddec80000a41b8f7", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "16-Jan-2023 12:05:27", "member_id": "6508075909287", "created_date": "16-Jan-2023 12:05:27", "transaction_type": "award", "transaction_attributes": { "reason": "testing", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "points_expiration_date": "18-Jan-2024 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7fe0", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f80", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "16-Jan-2023 12:03:53", "award_info": { "activity_id": "share_on_facebook", "points": 1000, "points_status": "approved", "activity_name": "Share on Facebook" }, "id": "63c53d299841af000ce149e7", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "16-Jan-2023 12:03:53", "member_id": "6508075909287", "created_date": "16-Jan-2023 12:03:53", "transaction_type": "award", "transaction_attributes": { "reason": "Testing", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "points_expiration_date": "18-Jan-2024 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7f20", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7fef", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "04-Jan-2023 15:54:34", "award_info": { "activity_id": "follow_on_instagram", "points": 1000, "points_status": "approved", "activity_name": "Follow on Instagram" }, "id": "63b5a13a5e46a8000c1aec7b", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "04-Jan-2023 15:54:34", "member_id": "6508075909287", "created_date": "04-Jan-2023 15:54:34", "transaction_type": "award", "transaction_attributes": { "reason": "testing", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "transaction_attributes": { "reason": "Transaction reversed", "tags": [] }, "last_modified_date": "04-Jan-2023 12:17:17", "additional_data": { "award_transaction_id": "63b56e096de225000974aee2" }, "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "04-Jan-2023 12:17:17", "member_id": "6508075909287", "created_date": "04-Jan-2023 12:17:17", "transaction_type": "deduct", "id": "63b56e4d5e46a800094d18b1", "deduct_info": { "points": 100, "points_status": "deducted" } }, { "status": "approved", "points_expiration_date": "06-Oct-2023 00:00:00", "redemptions_list": [ { "redemption_id": "reward_b7f19", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f34", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "auto_approval_date": "", "last_modified_date": "07-Feb-2023 16:36:39", "award_info": { "activity_id": "upload_photo", "points": 5000, "points_status": "approved", "activity_name": "Upload a Photo" }, "id": "63a3da7d7c04c4000b5b6f68", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "22-Dec-2022 04:18:35", "member_id": "rohit@zinrelo.com", "created_date": "22-Dec-2022 04:18:05", "transaction_type": "award", "transaction_attributes": { "reason": "test", "tags": [] }, "additional_data": { "activity_multiplier": 1 } }, { "status": "approved", "points_expiration_date": "07-Nov-2023 00:00:00", "redemptions_list": [], "auto_approval_date": "", "last_modified_date": "15-Dec-2022 14:18:14", "award_info": { "activity_id": "anniversary_bonus", "points": 200, "points_status": "exhausted", "activity_name": "Anniversary Bonus" }, "id": "638e9beb51ab7a0010b2414c", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "06-Dec-2022 01:33:31", "member_id": "76543", "created_date": "06-Dec-2022 01:33:31", "transaction_type": "award", "transaction_attributes": { "reason": null, "tags": [] }, "additional_data": { "activity_multiplier": 1 } } ], "more": false }, "success": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{member_id}/transactions": { "get": { "summary": "List all Transactions with Member ID", "operationId": "list-all-transaction-with-member-id-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "member_id", "in": "path", "schema": { "type": "string", "default": "john.doe@gmail.com" }, "required": true }, { "name": "idParam", "in": "query", "description": "Enter 'member_id' as idParam.", "required": true, "schema": { "type": "string", "default": "member_id" } }, { "name": "start_cursor", "in": "query", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "type": "integer", "format": "int32" } }, { "name": "approved_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their approved_date in TrueLoyal. Child parameters are:

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: approved_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: approved_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: approved_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: approved_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: approved_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: approved_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"eq\":\"01/21/2022\"}" } }, { "name": "created_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their created_date in Trueloyal. Child parameters are

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: created_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: created_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: created_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: created_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: created_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: created_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"gt\":\"01/21/2022\"}" } }, { "name": "last_modified_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their last_modified date in Trueloyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: last_modified_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: last_modified_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: last_modified_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: last_modified_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: last_modified_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: last_modified_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"gte\":\"01/21/2022\"}" } }, { "name": "points_expiration_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their points_expiration_date in Trueloyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: points_expiration_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: points_expiration_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: points_expiration_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: points_expiration_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: points_expiration_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: points_expiration_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"lte\":\"01/21/2022\"}" } }, { "name": "points_status", "in": "query", "description": "

This filter will return the point status.

The value can be passed as:

eq: Accepted values are ‘approved, rejected, pending, redeemed, deducted, expired’. Pass the value of the status to get a list of all transactions with points_status equal to the value passed.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "

This filter will return transaction status.

eq: Accepted values are Approved/ Rejected/ Pending.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 2, "next_cursor": 100, "transactions": [ { "status": "approved", "points_expiration_date": "14-Nov-2023 00:00:00", "auto_approval_date": "15-Nov-2022 16:10:00", "last_modified_date": "15-Nov-2022 19:51:47", "redemptions_list": [ { "redemption_id": "reward_b7f19", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f34", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "award_info": { "activity_id": "made_a_purchase", "points": 1200, "points_status": "auto_approved", "activity_name": "Purchase on website" }, "id": "63720ae0a042a3000badf6a4", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "15-Nov-2022 19:51:47", "member_id": "pallavi055", "created_date": "14-Nov-2022 09:27:07", "transaction_type": "award", "transaction_attributes": { "order_total": 1100, "products": [ { "product_id": "113", "is_excluded": false, "product_category": "tshirt", "product_url": "https://cdn.shopify.com", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://cdn.shopify.com", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "https://cdn.shopify.com", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://cdn.shopify.com", "product_title": "Pant" } ], "coupon_code": "BEOYUTO09", "order_id": "7509357612", "booked_location": "India", "age": 34, "tags": [ "purchasemade", "purchased" ], "currency": "$", "reason": "purchasing", "favourite_cuisine": "Chinese", "gender": "Male", "favourite_destination": "Paris", "order_subtotal": 1200, "coupons": "$10Off" }, "additional_data": { "activity_multiplier": 1, "history": [ { "activity_multiplier": 1, "zrl_products": [ { "category": "tshirt", "product_id": "112", "is_excluded": false, "title": "Sweatshirt", "url": null, "price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "img_url": "", "quantity": "1" }, { "category": "Sales", "product_id": "980", "is_excluded": false, "title": "Pant", "url": null, "price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "img_url": "", "quantity": "2" } ], "current_loyalty_level_id": "zrl_silver", "custom_attributes": {}, "points": 1000, "created_time": "2022-11-14 09:27:07.807000" } ] } }, { "status": "approved", "points_expiration_date": "14-Nov-2023 00:00:00", "auto_approval_date": "", "last_modified_date": "20-Nov-2022 14:58:27", "redemptions_list": [ { "redemption_id": "reward_b7f19", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f34", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "approved", "activity_name": "Account Creation" }, "id": "6336b6bbdfa6b71f57a48f48", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "30-Sep-2022 09:28:27", "member_id": "pallavi055", "created_date": "30-Sep-2022 09:28:27", "transaction_type": "award", "transaction_attributes": { "reason": null, "tags": [] }, "additional_data": { "activity_multiplier": 1 } } ], "more": false }, "success": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/members/{id}/transactions": { "get": { "summary": "List all Transactions with TrueLoyal-generated Member ID", "operationId": "list-all-transactions-with-zinrelo-generated-member-id-1", "tags": [ "admin_transactions" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "id", "in": "path", "description": "Add Trueloyal generated member ID.", "schema": { "type": "string", "default": "62d6439adfa6b74ab18eb1a6" }, "required": true }, { "name": "start_cursor", "in": "query", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "type": "integer", "format": "int32" } }, { "name": "count", "in": "query", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "type": "integer", "format": "int32" } }, { "name": "approved_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their approved_date in Trueloyal. Child parameters are:

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: approved_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: approved_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: approved_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: approved_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: approved_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: approved_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"eq\":\"01/21/2022\"}" } }, { "name": "created_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their created_date in Trueloyal. Child parameters are

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: created_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: created_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: created_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: created_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: created_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: created_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"gt\":\"01/21/2022\"}" } }, { "name": "last_modified_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their last_modified date in Trueloyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: last_modified_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: last_modified_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: last_modified_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: last_modified_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: last_modified_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: last_modified_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"gte\":\"01/21/2022\"}" } }, { "name": "points_expiration_date", "in": "query", "description": "

This can be used to filter the list of transactions based on their points_expiration_date in Trueloyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: points_expiration_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: points_expiration_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: points_expiration_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: points_expiration_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: points_expiration_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: points_expiration_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "type": "string", "default": "{\"lte\":\"01/21/2022\"}" } }, { "name": "points_status", "in": "query", "description": "

This filter will return the point status.

The value can be passed as:

eq: Accepted values are ‘approved, rejected, pending, redeemed, deducted, expired’. Pass the value of the status to get a list of all transactions with points_status equal to the value passed.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "

This filter will return transaction status.

eq: Accepted values are Approved/ Rejected/ Pending.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "total": 2, "next_cursor": 100, "transactions": [ { "status": "approved", "points_expiration_date": "14-Nov-2023 00:00:00", "auto_approval_date": "15-Nov-2022 16:10:00", "last_modified_date": "15-Nov-2022 19:51:47", "redemptions_list": [ { "redemption_id": "reward_b7f19", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f34", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "award_info": { "activity_id": "made_a_purchase", "points": 1200, "points_status": "auto_approved", "activity_name": "Purchase on website" }, "id": "63720ae0a042a3000badf6a4", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "15-Nov-2022 19:51:47", "member_id": "pallavi055", "created_date": "14-Nov-2022 09:27:07", "transaction_type": "award", "transaction_attributes": { "order_total": 1100, "products": [ { "product_id": "113", "is_excluded": false, "product_category": "tshirt", "product_url": "https://cdn.shopify.com", "product_price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "product_quantity": "1", "product_image_url": "https://cdn.shopify.com", "product_title": "Sweatshirt" }, { "product_id": "980", "is_excluded": false, "product_category": "Sales", "product_url": "https://cdn.shopify.com", "product_price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "product_quantity": "2", "product_image_url": "https://cdn.shopify.com", "product_title": "Pant" } ], "coupon_code": "BEOYUTO09", "order_id": "7509357612", "booked_location": "India", "age": 34, "tags": [ "purchasemade", "purchased" ], "currency": "$", "reason": "purchasing", "favourite_cuisine": "Chinese", "gender": "Male", "favourite_destination": "Paris", "order_subtotal": 1200, "coupons": "$10Off" }, "additional_data": { "activity_multiplier": 1, "history": [ { "activity_multiplier": 1, "zrl_products": [ { "category": "tshirt", "product_id": "112", "is_excluded": false, "title": "Sweatshirt", "url": null, "price": "15", "product_points_per_quantity": 15, "bonus_multiplier": 0, "img_url": "", "quantity": "1" }, { "category": "Sales", "product_id": "980", "is_excluded": false, "title": "Pant", "url": null, "price": "10.017", "product_points_per_quantity": 10, "bonus_multiplier": 0, "img_url": "", "quantity": "2" } ], "current_loyalty_level_id": "zrl_silver", "custom_attributes": {}, "points": 1000, "created_time": "2022-11-14 09:27:07.807000" } ] } }, { "status": "approved", "points_expiration_date": "14-Nov-2023 00:00:00", "auto_approval_date": "", "last_modified_date": "20-Nov-2022 14:58:27", "redemptions_list": [ { "redemption_id": "reward_b7f19", "redeemed_points": 500, "id": "65c1cbbd40aba100353b5c68" }, { "redemption_id": "reward_b7f34", "redeemed_points": 500, "id": "65c1cbbe40aba100353b5c6b" } ], "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "approved", "activity_name": "Account Creation" }, "id": "6336b6bbdfa6b71f57a48f48", "approver_details": { "approver_name": "System", "approver_id": null }, "approved_date": "30-Sep-2022 09:28:27", "member_id": "pallavi055", "created_date": "30-Sep-2022 09:28:27", "transaction_type": "award", "transaction_attributes": { "reason": null, "tags": [] }, "additional_data": { "activity_multiplier": 1 } } ], "more": false }, "success": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty/tiers": { "get": { "summary": "List all Tiers API", "operationId": "list-all-tiers-api-1", "tags": [ "admin_tiers" ], "security": [ { "api_key": [], "partner_id": [] } ], "parameters": [ { "name": "language", "in": "query", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string", "default": "english" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": { "data": { "tiers": [ { "created_time": "07-May-2021 05:44:16", "description": "This is default Tier", "hide_tier_from_user": false, "id": "6094d3b084d28f07bbda724e", "is_active": true, "is_default": true, "minimum_points": 0, "name": "Tier 1", "tier_id": "zrl_silver", "updated_time": "09-Aug-2023 14:11:51" }, { "created_time": "09-Aug-2023 13:17:30", "description": "a", "hide_tier_from_user": false, "id": "64d391eab4dc9f000a122c0d", "is_active": false, "is_default": false, "minimum_points": 5000, "name": "a", "tier_id": "tier_2af1e", "updated_time": "09-Aug-2023 14:24:23" }, { "created_time": "07-May-2021 05:44:16", "description": "1000 points", "hide_tier_from_user": false, "id": "6094d3b084d28f07bbda724d", "is_active": true, "is_default": false, "minimum_points": 14000, "name": "Gold", "tier_id": "zrl_gold", "updated_time": "22-Aug-2023 05:36:00" }, { "created_time": "07-May-2021 05:44:16", "description": "5000 Points", "hide_tier_from_user": false, "id": "6094d3b084d28f07bbda724c", "is_active": true, "is_default": false, "minimum_points": 15000, "name": "Tier 3", "tier_id": "zrl_platinum", "updated_time": "21-Aug-2023 14:14:28" } ] }, "success": true } } }, "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "type": "object", "properties": { "created_time": { "type": "string", "example": "07-May-2021 05:44:16" }, "description": { "type": "string", "example": "This is default Tier" }, "hide_tier_from_user": { "type": "boolean", "example": false, "default": true }, "id": { "type": "string", "example": "6094d3b084d28f07bbda724e" }, "is_active": { "type": "boolean", "example": true, "default": true }, "is_default": { "type": "boolean", "example": true, "default": true }, "minimum_points": { "type": "integer", "example": 0, "default": 0 }, "name": { "type": "string", "example": "Tier 1" }, "tier_id": { "type": "string", "example": "zrl_silver" }, "updated_time": { "type": "string", "example": "09-Aug-2023 14:11:51" } } } } } }, "success": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } } }, "schema": { "type": "object", "properties": { "error_code": { "type": "string", "example": "400" }, "error": { "type": "string", "example": "ERROR_INVALID_PARAMETER" }, "message": { "type": "string", "example": "An invalid value was supplied for {Parameter}." } } } } } } }, "deprecated": false } }, "/loyalty-storefront/eligible-activities": { "get": { "summary": "List Member's Eligible Activities API", "operationId": "retrieve-members-eligible-activities-api", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "count", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "language", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "default": "english", "type": "string" }, "in": "query" }, { "name": "sort_by", "description": "

The response will contain the activities ordered by the rank configured in the TrueLoyal admin console. You can sort the sequence using the following options: \"rank\", \"-rank\", \"created_date\", \"-created_date\", \"last_modified_date\" or \"-last_modified_date\". Additionally, you can combine sorting options, such as \"-rank,created_date\", \"-rank,-created_date\", \"-rank,-last_modified_date\", \"-rank,last_modified_date\", \"rank,created_date\", or \"rank,-created_date\", \"rank,-last_modified_date\", or \"rank,last_modified_date\".

\"-\" signifies the latest activity first.

Note: If no sorting option is specified, the response will default to the saved rank, which is \"rank,-last_modified_date\".

In scenarios where the rank of activities is same, sorting will be based on a second parameter. For example, in \"rank,last_modified_date,\" if the ranks are identical, the sorting will then be determined by the last modified date parameter.

", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-eligible-activities-activity-object" }, "examples": { "Result": { "value": { "data": { "total": 16, "activities": [ { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-08 16:55:20.470000", "metadata": { "Category": "Chocolate Cake" }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "extra_config": {}, "rank": 1, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -10, "activity_id": "tag_on_tiktok", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:51.984000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you tag us on TikTok using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.260000", "activity_name": "Tag on TikTok", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Tiktok handle is required for this activity.", "activity_start_button_text": "Tag", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your TikTok account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you tag {{TIKTOK_HASHTAGS}} on TikTok using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your TikTok handle", "personal_handle_input_text": "Your Tiktok handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Tag on TikTok", "enter_handle_placeholder_text": "Enter your Tiktok handle", "edit_handle_text": "Edit your Tiktok handle", "business_handle_display_text": "Hashtag(s) to be tagged" }, "id": "6756a59120df0f847b212e52", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "rank": -9, "activity_id": "enter_tiktok_handle", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:49.157000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you enter your TikTok handle", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/a795d2552d146126bf853454176d1f30.png", "created_date": "2024-12-09 08:08:49.232000", "activity_name": "Enter TikTok Handle", "extra_config": { "max_award_frequency_error_text": "", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "activity_start_button_text": "Submit", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "thank_you_text": "Thank you for entering your Tiktok handle. You will earn {{POINTS}} points (Limit- Once per lifetime)", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Enter TikTok Handle", "enter_handle_placeholder_text": "Enter your Tiktok handle" }, "id": "6756a59120df0f847b212e4b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -8, "activity_id": "dm_on_instagram", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:46.412000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you DM us on Insta", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/caebf8b59b8ce9f854fef2e908ea7cae.png", "created_date": "2024-12-09 08:08:49.204000", "activity_name": "DM on Instagram", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "DM", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you DM {{BUSINESS_IG}} on Instagram.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "DM on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e44", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -7, "activity_id": "follow_on_instagram_v2", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:43.357000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points by following us and then mentioning or direct messaging us.", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/59f2fb79bcf9f49574a1052177e432de.png", "created_date": "2024-12-09 08:08:49.176000", "activity_name": "Follow on Instagram", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Follow", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you start following {{BUSINESS_IG}} on Instagram and then either mention or DM {{BUSINESS_IG}}", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Follow on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e3d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -6, "activity_id": "mention_on_instagram_story", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:39.524000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you mention us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.142000", "activity_name": "Insta Story Mention", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Mention", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you mention {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Mention on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e36", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -5, "activity_id": "tag_on_instagram_reel", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:35.546000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you tag us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.112000", "activity_name": "Tag on Insta Reel", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Tag", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you tag {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Tag on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e2f", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -4, "activity_id": "mention_on_instagram_reel", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:31.476000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you mention us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.084000", "activity_name": "Insta Reel Mention", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Mention", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you mention {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Mention on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e28", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -3, "activity_id": "mention_on_instagram_post", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:26.655000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you mention us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.041000", "activity_name": "Insta Post Mention", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Mention", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you mention {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Mention on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e21", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -2, "activity_id": "tag_on_instagram_post", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:16.762000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you tag us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:48.975000", "activity_name": "Tag on Insta Post", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Tag", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you tag {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Tag on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59020df0f847b212e1a", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "rank": -1, "activity_id": "enter_instagram_handle", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:12.074000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you enter your Insta handle", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/59f2fb79bcf9f49574a1052177e432de.png", "created_date": "2024-12-09 08:08:48.940000", "activity_name": "Enter Insta Handle", "extra_config": { "max_award_frequency_error_text": "", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "activity_start_button_text": "Submit", "failure_text": "There was an error while following on instagram. Please try again. If this problem persists, please contact your site administrator.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "thank_you_text": "Thank you for entering your Instagram handle. You will earn {{POINTS}} points (Limit- Once per lifetime).", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Enter Instagram Handle", "enter_handle_placeholder_text": "Enter your Instagram handle" }, "id": "6756a59020df0f847b212e13", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "created_an_account", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-06-14 09:03:33.343000", "metadata": {}, "enduser_activity_short_description": "Earn points when you create your loyalty account.", "created_date": "2021-03-15 12:59:39.812000", "activity_name": "Account Creation", "extra_config": {}, "rank": 1, "id": "604f5a3b8152252216f5c19a", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "multiplier": 1 }, "activity_id": "write_a_review", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:13:10.021000", "metadata": {}, "enduser_activity_short_description": "Earn points for writing a review.", "created_date": "2021-03-15 12:59:39.824000", "activity_name": "Write a Review", "extra_config": {}, "rank": 1, "id": "604f5a3b8152252216f5c19c", "activity_benefit_type": "points" }, { "points_config": { "points": 200, "points_computation_type": "fixed_points" }, "activity_id": "anniversary_bonus", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:07:02.905000", "metadata": {}, "enduser_activity_short_description": "Earn points on your anniversary.", "created_date": "2021-03-15 12:59:39.836000", "activity_name": "Anniversary Bonus", "extra_config": {}, "rank": 1, "id": "604f5a3b8152252216f5c19e", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "f00ca_custom_activity", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-17 11:21:50.190000", "metadata": {}, "enduser_activity_short_description": "", "created_date": "2021-05-05 05:29:46.129000", "activity_name": "", "extra_config": {}, "rank": 1, "id": "60922d4abed0d56677192dcf", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "referral", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-12 11:10:12.088000", "metadata": {}, "enduser_activity_short_description": "Award points on referral purchase.", "created_date": "2021-03-22 08:46:18.898000", "activity_name": "Refer a Friend", "extra_config": {}, "rank": 1, "id": "6058595abb711d6fa73fcd36", "activity_benefit_type": "points_and_coupon_code" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "activity_id": "684fc_custom_activity", "is_points_expiry_reset_activity": true, "enduser_activity_description_html": "
", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-04-10 11:47:27.127000", "metadata": {}, "enduser_activity_short_description": "Enter the code on your LD pack and earn points", "created_date": "2021-05-05 11:41:57.738000", "activity_name": "684fc_custom_activity", "extra_config": {}, "rank": 1, "id": "609284851c9396204c8b984b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "a7ee1_custom_activity", "is_points_expiry_reset_activity": true, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-03-08 11:01:06.969000", "metadata": {}, "enduser_activity_short_description": "Reward your users for any activity you want.", "created_date": "2023-01-23 13:52:30.665000", "activity_name": "Custom Activity", "extra_config": {}, "rank": 1, "id": "63ce911ef380d8000b8d7753", "activity_benefit_type": "points" }, { "points_config": { "points": 130, "points_computation_type": "fixed_points" }, "activity_id": "birthday_bonus", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-02-24 07:27:55.290000", "metadata": {}, "enduser_activity_short_description": "Award points on birthday.", "created_date": "2021-03-15 12:59:39.830000", "activity_name": "Birthday Bonus", "extra_config": {}, "rank": 1, "id": "604f5a3b8152252216f5c19d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "upload_photo", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-10-06 10:26:28.835000", "metadata": {}, "enduser_activity_short_description": "Earn points for uploading a photo.", "created_date": "2022-07-28 06:53:03.616000", "activity_name": "Upload a Photo", "extra_config": {}, "rank": 1, "id": "62e2324f23d74243d1c5af29", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "receipt_order_value", "multiplier": 1 }, "activity_id": "submit_a_receipt", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-10-06 09:54:55.183000", "metadata": {}, "enduser_activity_short_description": "Reward users for submitting receipts of their purchases.", "created_date": "2021-03-22 08:56:14.632000", "activity_name": "Submit A Receipt", "extra_config": {}, "rank": 1, "id": "60585baef5a67a16e1871b56", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "activity_id": "share_on_pinterest", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:19.592000", "metadata": {}, "enduser_activity_short_description": "Earn points when you share us on Pinterest.", "created_date": "2021-03-15 12:59:39.873000", "activity_name": "Share on Pinterest", "extra_config": { "pin_post_image": "", "pin_post_description": "Awesome products at great prices. You should really check them out.", "share_current_page_url": false }, "rank": 1, "id": "604f5a3b8152252216f5c1a3", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "activity_id": "share_on_facebook", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-07-14 08:17:00.673000", "metadata": {}, "enduser_activity_short_description": "Reward points to users when they share you on Facebook.", "created_date": "2021-03-15 12:59:39.848000", "activity_name": "Share on Facebook", "extra_config": { "share_current_page_url": false }, "rank": 1, "id": "604f5a3b8152252216f5c1a0", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "f46f4_custom_activity", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-06-14 11:09:16.199000", "metadata": {}, "enduser_activity_short_description": "Reward your users for any activity you want.", "created_date": "2022-03-03 05:30:58.331000", "activity_name": "Quiz form", "extra_config": {}, "rank": 1, "id": "622052924e6d9f1dfd89ed88", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "multiplier": 1 }, "activity_id": "code_submission", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-05-19 10:32:40.318000", "metadata": {}, "enduser_activity_short_description": "Get rewarded for your purchases by submitting the code you received with your purchase.", "created_date": "2022-05-18 10:05:41.642000", "activity_name": "Enter a Code", "extra_config": {}, "rank": 1, "id": "6284c4f5dfa6b7425568ba6d", "activity_benefit_type": "points" } ], "next_cursor": 100, "more": false }, "success": true } }, "Member doesnot exist": { "value": { "reason": "Member does not exist", "error_code": "INVALID_MEMBER", "success": false } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-eligible-activities-failure-object" }, "examples": { "Invalid Language": { "value": { "reason": { "language": "Value must be one of: english; french; italian; german; spanish (not u'Hindi')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Count should be greater than 0": { "value": { "reason": { "count": "Please enter a number that is 1 or greater" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "400" } }, "deprecated": false } }, "/loyalty-storefront/eligible-rewards": { "get": { "summary": "List Member's Eligible Rewards API", "operationId": "retrieve-member-rewards-api", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "count", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "language", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "default": "english", "type": "string" }, "in": "query" }, { "name": "ignore_allowed_redeem_points", "description": "Pass \"true\" in this parameter if you want ineligible rewards to be visible as well. By default it is \"false.\"", "schema": { "type": "boolean" }, "in": "query" }, { "name": "sort_by", "description": "

The response will contain the rewards ordered by the rank configured in the TrueLoyal admin console. You can sort the sequence using the following options: \"rank\", \"-rank\", \"points_to_be_redeemed\", or \"-points_to_be_redeemed\". Additionally, you can combine sorting options, such as \"-rank,points_to_be_redeemed\", \"-rank,-points_to_be_redeemed\", \"rank,points_to_be_redeemed\", or \"rank,-points_to_be_redeemed\".

\"-\" signifies the latest reward first.

Note: If no sorting option is specified, the response will default to the saved rank, which is \"rank,points_to_be_redeemed\".

In scenarios where the rank of rewards is same, sorting will be based on a second parameter. For example, in \"rank,points_to_be_redeemed,\" if the ranks are identical, the sorting will then be determined by the points to be redeemed parameter.

", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-eligible-rewards-response-object" }, "examples": { "example": { "value": { "data": { "total": 1, "rewards": [ { "enable_auto_redemption": false, "reward_name": "$10 Gift Certificate Netsuite", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "reward_value": "5", "last_modified_date": "04/30/2024 09:09:10", "rank": 1, "extra_parameters": { "redemption_confirm_button_text": "Confirm", "points_deduction_text": "{{POINTS}} points have been deducted.", "redeem_button_text": "Redeem", "ineligible_rewards_progress_text": "You need {{POINTS_TO_UNLOCK_REWARD}} more points to unlock this reward." }, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:39", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 100, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3b8152252216f5c1ad", "reward_id": "reward_bc668", "metadata": { "Category": "Limited time", "Brand": "Nescafe" } } ], "next_cursor": 100, "more": false }, "success": true } }, "Member doesnot exist": { "value": { "reason": "Member does not exist", "error_code": "INVALID_MEMBER", "success": false } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-eligible-rewards-failure-object", "properties": { "reason": { "type": "string", "example": "Member does not exist" }, "error_code": { "type": "string", "example": "INVALID_MEMBER" }, "success": { "default": true, "type": "boolean", "example": false } } }, "examples": { "Invalid Request Parameter": { "value": { "reason": { "language": "Value must be one of: english; french; italian; german; spanish (not u'Hindi')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Count should be greater than 0": { "value": { "reason": { "count": "Please enter a number that is 1 or greater" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "400" } }, "deprecated": false } }, "/loyalty-storefront/redeem": { "post": { "summary": "Redeem API", "operationId": "redeem-api", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-redeem-request-body" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-redeem-data-object" }, "examples": { "example": { "value": { "data": { "status": "approved", "transaction_attributes": { "reason": null }, "last_modified_date": "11-Mar-2025 11:27:03", "additional_data": {}, "approved_date": "11-Mar-2025 11:27:03", "reward_info": { "reward_name": "$10 Gift Certificate Netsuite", "points_status": "redeemed", "coupon_code": "41EAE010", "reward_link": null, "reward_id": "reward_bc668", "points": 100 }, "member_id": "pallavi+095@zinrelo.com", "transaction_type": "redeem", "id": "67d01e07adb896d71d81ccdb", "created_date": "11-Mar-2025 11:27:03" }, "success": true } }, "Coupon exhausted": { "value": { "reason": "Reward coupons are exhausted.", "error_code": "COUPON_EXHAUSTED", "success": false } }, "Member doesnot exist": { "value": { "reason": "Member does not exist", "error_code": "INVALID_MEMBER", "success": false } }, "Invalid reward": { "value": { "reason": "This reward is not valid for the user", "error_code": "INVALID_REWARD_FOR_USER", "success": false } }, "Inactive reward": { "value": { "reason": "This reward is inactive and cannot be redeemed", "error_code": "INACTIVE_REWARD", "success": false } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-redeem-failure-object" }, "examples": { "Invalid JSON format": { "value": { "reason": "Invalid JSON format.", "error_code": "INVALID_JSON", "success": false } }, "Invalid Language": { "value": { "reason": { "language": "Value must be one of: english; french; italian; german; spanish (not u'Englih')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "400" } }, "deprecated": false }, "parameters": [ { "examples": { "language": { "value": "english" } }, "name": "language", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "type": "string" }, "in": "query" } ] }, "/loyalty-storefront/member": { "get": { "summary": "Retrieve a Loyalty Member Details API", "operationId": "member-info", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-retrieve-member-member-object" }, "examples": { "Result": { "value": { "data": { "last_name": "Doe", "twitter_handle": "www.twitter.com/john", "lifetime_points_expired": 893, "last_modified_date": "07/14/2023 11:11:04", "available_points": 0, "lifetime_points_earned": 893, "referral_URL": "https://www.zinrelo.com/ref/JOH30AOQ", "member_status": "active", "referral_code": "JOHL30AOQ", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "email_address": "johndoe@gmail.com", "id": "64898298c7f196000b000091", "first_name": "John", "member_tags": [ "memberretrieve", "retrievedmember" ], "tier_info": { "current_period_start": "04/01/2023", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "04/01/2024", "qualified_points": 793 }, "first_purchase_date": "06/14/2023", "lifetime_points_deducted": 0, "phone_number": "+1-65070177596", "points_expiration_schedule": [ { "expiration_date": "5-Mar-2024 8:45:26", "points": 101 } ], "instagram_handle": "www.instagram.com/john", "address": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "" }, "last_purchase_date": "06/29/2023", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 2, "number_of_redemptions": 0, "birthdate": "01/31/1900", "anniversary_date": "07/07/2021", "enrollment_date": "06/14/2023 09:04:24", "member_id": "greatMRT040401", "email_subscription_status": "subscribed" }, "success": true } }, "Member doesnot exist": { "value": { "reason": "Member does not exist", "error_code": "INVALID_MEMBER", "success": false } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-retrieve-member-failure-object" }, "examples": { "Result": { "value": { "reason": "An invalid value was supplied for {Parameter}.", "error_code": "ERROR_INVALID_PARAMETER", "success": false } } } } }, "description": "400" } }, "deprecated": false }, "post": { "summary": "Update Loyalty Member API", "operationId": "member-update", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update-loyalty-member-request-body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-update-loyalty-member-response-body" }, "examples": { "Example": { "value": { "last_name": "Doe", "twitter_handle": "www.twitter.com/john", "lifetime_points_expired": 893, "last_modified_date": "09/01/2023 05:10:16", "available_points": 0, "lifetime_points_earned": 893, "referral_URL": "https://www.zinrelo.com/ref/JOH30AOQ", "member_status": "active", "referral_code": "JOH30AOQ", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "email_address": "johndoe@gmail.com", "id": "64898298c7f196000b000091", "first_name": "John", "member_tags": [ "memberadded", "membercreated" ], "tier_info": { "current_period_start": "03/01/2022", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023", "qualified_points": 1000 }, "first_purchase_date": "06/14/2023", "lifetime_points_deducted": 0, "phone_number": "+1-6507017759", "points_expiration_schedule": [ { "expiration_date": "7-Feb-2024 6:0:4", "points": 10000 } ], "instagram_handle": "www.instagram.com/john", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "last_purchase_date": "06/29/2023", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 2, "number_of_redemptions": 0, "birthdate": "08/26/1900", "anniversary_date": "12/06/2020", "enrollment_date": "06/14/2023 09:04:24", "member_id": "john+11", "email_subscription_status": "subscribed" } }, "Member does not exist": { "value": { "reason": "Member does not exist", "error_code": "INVALID_MEMBER", "success": false } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-update-loyalty-member-failure-object" }, "examples": { "Invalid Parameter": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "Invalid date format": { "value": { "reason": { "anniversary_date": "Invalid date format. Expected MM/DD/YYYY." }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Invalid JSON format": { "value": { "reason": "Invalid JSON format.", "error_code": "INVALID_JSON", "success": false } }, "Invalid Request Parameter": { "value": { "reason": { "email_subscription_status": "Enter a value from: 'unsubscribed'; 'subscribed'" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Invalid Member Status": { "value": { "reason": { "member_status": "Value must be one of: opted_out; active (not u'deleted')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "Bad Request" } }, "deprecated": false } }, "/loyalty-storefront/activity-track-code": { "get": { "summary": "Get Activity Track Codes API", "operationId": "get-activity-track-codes-api", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "parameters": [ { "name": "activity_id", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activity-track-codes-data-object" }, "examples": { "Result": { "value": { "data": { "track_code": "qpqlp5igp9zPoqfJzdCrnKOql86irZmkp5mjprHK0tPh0tDdztDh1NfrrJmgpZKcqKebn5KVoKmvn6imnZqhrp6kopo=" }, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-activity-track-codes-failure-object" }, "examples": { "Missing value": { "value": { "reason": { "count": "Please enter a number that is 1 or greater" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Validation error": { "value": { "error_code": "VALIDATION_ERROR", "reason": { "activity_id": "Value must be one of: share_on_facebook; share_on_twitter; share_on_pinterest (not 'share_facebook')" }, "success": false } } } } }, "description": "400" } }, "deprecated": false } }, "/loyalty-storefront/transactions": { "get": { "summary": "List Member's Transaction API", "operationId": "list-members-transaction-api", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "count", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "approved_date", "description": "

This can be used to filter the list of transactions based on their approved_date in TrueLoyal. Child parameters are:

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: approved_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: approved_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: approved_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: approved_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: approved_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: approved_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "default": "{\"eq\":\"01/21/2022\"}", "type": "string" }, "in": "query" }, { "name": "created_date", "description": "

This can be used to filter the list of transactions based on their created_date in TrueLoyal. Child parameters are

p>To filter dates 'equal to' a particular date, use operator \"eq\". Example: created_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: created_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: created_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: created_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: created_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: created_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "default": "{\"gt\":\"01/21/2022\"}", "type": "string" }, "in": "query" }, { "name": "last_modified_date", "description": "

This can be used to filter the list of transactions based on their last_modified date in TrueLoyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: last_modified_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: last_modified_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: last_modified_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: last_modified_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: last_modified_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: last_modified_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "default": "{\"gte\":\"01/21/2022\"}", "type": "string" }, "in": "query" }, { "name": "points_expiration_date", "description": "

This can be used to filter the list of transactions based on their points_expiration_date in TrueLoyal. Child parameters are:

To filter dates 'equal to' a particular date, use operator \"eq\". Example: points_expiration_date={\"eq\":\"01/21/2022\"}

To filter dates 'greater than' a particular date, use operator \"gt\". Example: points_expiration_date={\"gt\":\"01/21/2022\"}

To filter dates 'greater than or equal to' a particular date, use operator \"gte\". Example: points_expiration_date={\"gte\":\"01/21/2022\"}

To filter dates 'lesser than' a particular date, use operator \"lt\". Example: points_expiration_date={\"lt\":\"01/21/2022\"}

To filter dates 'lesser than or equal to' a particular date, use operator \"lte\". Example: points_expiration_date={\"lte\":\"01/21/2022\"}

To filter dates 'between' a particular date, use operator \"between\". Example: points_expiration_date={\"between\":\"12/01/2021-12/31/2022\"}

Note: Our API records all date and time fields in UTC time.

", "schema": { "default": "{\"lte\":\"01/21/2022\"}", "type": "string" }, "in": "query" }, { "name": "points_status", "description": "

This filter will return the point status.

The value can be passed as:

eq: Accepted values are ‘approved, rejected, pending, redeemed, deducted, expired, redemption_pending, redemption_cancelled, pending_deduction, auto_rejected and auto_approved.' Pass the value of the status to get a list of all transactions with points_status equal to the value passed.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" }, "in": "query" }, { "name": "status", "description": "

This filter will return transaction status.

eq: Accepted values are Approved/ Rejected/ Pending.

For example- {\"eq\":\"approved\"}

in: Pass a single string which may contain one status or multiple statuses separated by comma to get a list of all transactions whose points_status is one of the values passed.

For example- {\"in\":\"approved, rejected\"}

", "schema": { "type": "string" }, "in": "query" }, { "name": "language", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "default": "english", "type": "string" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/list-member-transactions-response-object" }, "examples": { "Result": { "value": { "data": { "total": 10, "next_cursor": 100, "transactions": [ { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:11:20", "award_info": { "activity_id": "winback_bonus", "points": 100, "points_status": "approved", "activity_name": "Winback Bonus" }, "member_id": "johndoe", "points_expiration_date": "13-Sep-2023 00:00:00", "approved_date": "12-Sep-2023 10:11:20", "created_date": "12-Sep-2023 10:11:20", "transaction_type": "award", "transaction_attributes": { "reason": "cartabondoned" }, "id": "65003948ebeffa000ccc6bb8" }, { "status": "approved", "auto_approval_date": "15-Nov-20232 16:10:00", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "upload_photo", "points": 500, "points_status": "expired", "activity_name": "Upload a Photo" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 23:10:55", "approved_date": "12-Sep-2023 10:01:36", "created_date": "12-Sep-2023 10:01:19", "transaction_type": "award", "transaction_attributes": { "reason": "photouploaded" }, "id": "650036efebeffa00099d54ba" }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "submit_a_receipt", "points": 9, "points_status": "expired", "activity_name": "Submit a Receipt" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 23:10:55", "approved_date": "12-Sep-2023 10:00:34", "created_date": "12-Sep-2023 10:00:17", "transaction_type": "award", "transaction_attributes": { "reason": null, "receipt_file_url": [ "https://zinrelo-receipt-uploads.s3.amazonaws.com/c944754e96693d3cce82bc3ebcda9f9e.jpg" ] }, "id": "650036b1c13154000c365f21" }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:29:36", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "member_id": "johndoe", "points_expiration_date": "13-Sep-2023 00:00:00", "approved_date": "12-Sep-2023 10:29:36", "created_date": "12-Sep-2023 00:00:00", "transaction_type": "award", "transaction_attributes": { "order_id": "7587746", "coupon_code": "$5OFFVYZ", "reason": "purchase" }, "id": "65003d91e410b900092ef4e4" }, { "status": "approved", "transaction_attributes": { "reason": null }, "last_modified_date": "08-Aug-2023 06:04:37", "member_id": "johndoe", "approved_date": "08-Aug-2023 06:04:37", "reward_info": { "reward_name": "$5 OFF COUPON", "points_status": "redeemed", "coupon_code": "3193E86A", "reward_link": null, "reward_id": "reward_bc668", "points": 500 }, "transaction_type": "redeem", "id": "64d1daf5339122000c4c3c0a", "created_date": "08-Aug-2023 06:04:37" }, { "status": "approved", "transaction_attributes": { "reason": "Testing" }, "last_modified_date": "05-May-2023 10:05:43", "transaction_type": "deduct", "approved_date": "05-May-2023 10:04:31", "member_id": "johndoe", "created_date": "05-May-2023 10:04:31", "id": "6454d4af3953d5000ccc3c26", "deduct_info": { "points": 10, "points_status": "deducted" } }, { "status": "approved", "transaction_attributes": { "reason": "Testing" }, "last_modified_date": "05-May-2023 10:00:09", "transaction_type": "deduct", "approved_date": "05-May-2023 09:59:28", "member_id": "johndoe", "created_date": "05-May-2023 09:59:28", "id": "6454d38077b86b000d2e555a", "deduct_info": { "points": 10, "points_status": "deducted" } }, { "status": "approved", "transaction_attributes": { "reason": "Testing" }, "last_modified_date": "05-May-2023 10:00:09", "transaction_type": "deduct", "approved_date": "05-May-2023 09:54:10", "member_id": "johndoe", "created_date": "05-May-2023 09:54:10", "id": "6454d2422e7adb000a78f2c5", "deduct_info": { "points": 10, "points_status": "deducted" } }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "expired", "activity_name": "Account Creation" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 23:10:55", "approved_date": "05-May-2023 07:44:43", "created_date": "05-May-2023 07:44:43", "transaction_type": "award", "transaction_attributes": { "reason": null }, "id": "6454b3ebe8d4a8000b15cc77" }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "expired", "activity_name": "Purchase on website" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 23:10:55", "approved_date": "12-Sep-2023 10:11:20", "created_date": "05-Oct-2019 23:10:55", "transaction_type": "award", "transaction_attributes": { "order_id": "758765", "coupon_code": "$5OFFVYZ", "reason": "purchase" }, "id": "65003948ebeffa000ccc6bb7" } ], "more": false }, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-list-member-transactions-failure-object" }, "examples": { "Invalid Parameter": { "value": { "reason": "Extra data: line 1 column 2 - line 1 column 11 (char 1 - 10) because of key approved_date", "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "JSON cannot be decoded": { "value": { "reason": "No JSON object could be decoded because of key points_status", "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Invalid point status": { "value": { "reason": { "points_status": { "eq": "Value must be one of: approved; rejected; pending; redeemed; deducted; expired; redemption_pending; redemption_cancelled; pending_deduction; auto_rejected; auto_approved; exhausted (not u'blocekd')" } }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Invalid Language": { "value": { "reason": { "language": "Value must be one of: english; french; italian; german; spanish (not u'Engligh')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "400" } }, "deprecated": false } }, "/loyalty-storefront/perform-activity": { "post": { "summary": "Perform an Activity API", "operationId": "perform-activity-api", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ui-perform-an-activity-request-body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perform-an-activity-data-object" }, "examples": { "Result": { "value": { "data": {}, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/perform-an-activity-failure" }, "examples": { "Result": { "value": { "reason": "Internal server error.", "error_code": "INTERNAL_SERVER_ERROR", "success": false } }, "Invalid JSON format": { "value": { "reason": "Invalid JSON format.", "error_code": "INVALID_JSON", "success": false } }, "Invalid Parameter": { "value": { "reason": { "activity_id": "Value must be one of: code_submission; share_on_twitter; share_on_pinterest; share_on_facebook; upload_photo; referral; submit_a_receipt; follow_on_instagram (not u'share')", "transaction_attributes": "Missing value" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Missing value": { "value": { "reason": { "transaction_attributes": "Missing value" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Receipt- Field not expected": { "value": { "reason": { "transaction_attributes": "The input field u'receipt_files' was not expected." }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Code- Field not expected": { "value": { "reason": { "transaction_attributes": "The input field u'code' was not expected." }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Dict-like input": { "value": { "reason": { "transaction_attributes": "The input must be dict-like (not a : u'{\\n\\n\"image_file\": [\"\"]\\n\\n}\\n\\nRefer')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Image file not expected": { "value": { "reason": { "transaction_attributes": "The input field u'image_file' was not expected." }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "to_addresses not expected": { "value": { "reason": { "transaction_attributes": "The input field u'to_addresses' was not expected." }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "400" } }, "deprecated": false } }, "/loyalty-storefront/transactions/reject": { "post": { "summary": "Reject a pending redemption", "operationId": "uiRejectAPendingRedemption", "tags": [ "ui" ], "security": [ { "access_token": [], "partner_id": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reject-pending-redemption-request-body" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reject-pending-redemption-data-object" }, "examples": { "Success": { "value": { "data": { "approved_date": "05-Jan-2024 12:50:45", "created_date": "05-Jan-2024 12:50:45", "id": "6597fb251f1bee000df19dc3", "last_modified_date": "05-Jan-2024 12:51:20", "member_id": "j.buitenhuis@alumio.com", "reward_info": { "coupon_code": "82E68FBD", "points": 500, "points_status": "redemption_cancelled", "reward_id": "reward_bc668", "reward_name": "$10 Gift Certificate Netsuite" }, "status": "rejected", "transaction_attributes": { "reason": "Shopify in-cart redemption failed" }, "transaction_type": "redeem" }, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reject-pending-redemption-failure-object" }, "examples": { "Invalid Parameter": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "Validation error": { "value": { "error_code": "VALIDATION_ERROR", "reason": { "coupon_code": "Missing value", "reward_id": "Value must be one of: reward_55ad1; reward_62a01; reward_6c806; reward_72869; reward_73e6e; reward_7c6c2; reward_8880b; reward_916d9; reward_9c350; reward_a1e91; reward_bc668; reward_c2b88; reward_cfc23; reward_d8954; reward_de7b4; reward_dea68; reward_efece; reward_f005e (not 'fewgwr')" }, "success": false } }, "Invalid coupon": { "value": { "error_code": "INVALID_COUPON", "reason": "Coupon code does not exist", "success": false } } } } }, "description": "400" } } }, "summary": "Reject Pending Redemption API", "description": "" }, "/loyalty-storefront/get-potential-points": { "get": { "summary": "Get potential points", "operationId": "uiGetPotentialPoints", "tags": [ "ui", "guest" ], "security": [ { "access_token": [], "partner_id": [] }, { "partner_id": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fetch-potential-points-data-object" }, "examples": { "Success": { "value": { "data": { "potential_points": 160, "potential_promotion_points": 135, "potential_promotion_points_breakdown": [ { "campaign_id": "campaign_c8fd9", "end_date": null, "potential_points": 75 }, { "campaign_id": "campaign_ch7j3", "end_date": null, "potential_points": 60 } ] }, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fetch-potential-points-failure-object" }, "examples": { "Array of products": { "value": { "reason": { "product_list": "The 'product_list' value must be an array of products." }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Invalid JSON format": { "value": { "error_code": "INVALID_JSON", "reason": "Invalid JSON format.", "success": false } } } } }, "description": "400" } } }, "summary": "Fetch Potential Points API", "description": "", "parameters": [ { "name": "product_list", "description": "

To display potential points to members on the checkout page, it is mandatory to include the \"product_id\" parameter, which specifies the product for which potential points will be presented. Additionally, you have the option to include the optional fields like \"price,\" \"quantity,\" and \"category\" to provide more context.

The code format is as follows:

[{

\"product_id\": \"product_five\",

\"price\": 20,

\"quantity\": \"1\",

\"category\": \"cups\"

},

{

\"product_id\": \"product_six\",

\"price\": 20.00,

\"quantity\": \"3\",

\"category\": \"butter\"

}]

", "schema": { "format": "json", "type": "string" }, "in": "query" } ] }, "/loyalty-storefront/activities": { "get": { "summary": "EUD Guest Activities API", "description": "This page will help you get started with Guest Member API.", "operationId": "eud-guest-activities-api", "tags": [ "guest" ], "security": [ { "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "count", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "language", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "default": "english", "type": "string" }, "in": "query" }, { "name": "sort_by", "description": "

The response will contain the activities ordered by the rank configured in the TrueLoyal admin console. You can sort the sequence using the following options: \"rank\", \"-rank\", \"created_date\", \"-created_date\", \"last_modified_date\" or \"-last_modified_date\". Additionally, you can combine sorting options, such as \"-rank,created_date\", \"-rank,-created_date\", \"-rank,-last_modified_date\", \"-rank,last_modified_date\", \"rank,created_date\", or \"rank,-created_date\", \"rank,-last_modified_date\", or \"rank,last_modified_date\".

\"-\" signifies the latest activity first.

Note: If no sorting option is specified, the response will default to the saved rank, which is \"rank,-last_modified_date\".

In scenarios where the rank of activities is same, sorting will be based on a second parameter. For example, in \"rank,last_modified_date,\" if the ranks are identical, the sorting will then be determined by the last modified date parameter.

", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/guest-guest-activities-response-object" }, "examples": { "Result": { "value": { "data": { "total": 16, "activities": [ { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-08 16:55:20.470000", "metadata": { "Category": "Chocolate Cake" }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "extra_config": {}, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -10, "activity_id": "tag_on_tiktok", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:51.984000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you tag us on TikTok using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.260000", "activity_name": "Tag on TikTok", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Tiktok handle is required for this activity.", "activity_start_button_text": "Tag", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your TikTok account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you tag {{TIKTOK_HASHTAGS}} on TikTok using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your TikTok handle", "personal_handle_input_text": "Your Tiktok handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Tag on TikTok", "enter_handle_placeholder_text": "Enter your Tiktok handle", "edit_handle_text": "Edit your Tiktok handle", "business_handle_display_text": "Hashtag(s) to be tagged" }, "id": "6756a59120df0f847b212e52", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "rank": -9, "activity_id": "enter_tiktok_handle", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:49.157000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you enter your TikTok handle", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/a795d2552d146126bf853454176d1f30.png", "created_date": "2024-12-09 08:08:49.232000", "activity_name": "Enter TikTok Handle", "extra_config": { "max_award_frequency_error_text": "", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "activity_start_button_text": "Submit", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "thank_you_text": "Thank you for entering your Tiktok handle. You will earn {{POINTS}} points (Limit- Once per lifetime)", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Enter TikTok Handle", "enter_handle_placeholder_text": "Enter your Tiktok handle" }, "id": "6756a59120df0f847b212e4b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -8, "activity_id": "dm_on_instagram", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:46.412000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you DM us on Insta", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/caebf8b59b8ce9f854fef2e908ea7cae.png", "created_date": "2024-12-09 08:08:49.204000", "activity_name": "DM on Instagram", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "DM", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you DM {{BUSINESS_IG}} on Instagram.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "DM on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e44", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -7, "activity_id": "follow_on_instagram_v2", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:43.357000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points by following us and then mentioning or direct messaging us.", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/59f2fb79bcf9f49574a1052177e432de.png", "created_date": "2024-12-09 08:08:49.176000", "activity_name": "Follow on Instagram", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Follow", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you start following {{BUSINESS_IG}} on Instagram and then either mention or DM {{BUSINESS_IG}}", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Follow on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e3d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -6, "activity_id": "mention_on_instagram_story", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:39.524000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you mention us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.142000", "activity_name": "Insta Story Mention", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Mention", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you mention {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Mention on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e36", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -5, "activity_id": "tag_on_instagram_reel", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:35.546000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you tag us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.112000", "activity_name": "Tag on Insta Reel", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Tag", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you tag {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Tag on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e2f", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -4, "activity_id": "mention_on_instagram_reel", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:31.476000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you mention us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.084000", "activity_name": "Insta Reel Mention", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Mention", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you mention {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Mention on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e28", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -3, "activity_id": "mention_on_instagram_post", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:26.655000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you mention us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:49.041000", "activity_name": "Insta Post Mention", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Mention", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you mention {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Mention on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59120df0f847b212e21", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "rank": -2, "activity_id": "tag_on_instagram_post", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:16.762000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you tag us on Insta using your public account", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/cdc1aa97b1e7d0388da9778419444317.png", "created_date": "2024-12-09 08:08:48.975000", "activity_name": "Tag on Insta Post", "extra_config": { "max_award_frequency_error_text": "", "personal_handle_edit_button_text": "Edit", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "personal_handle_submit_button_text": "Submit", "handle_required_alert_text": "Your Instagram handle is required for this activity.", "activity_start_button_text": "Tag", "failure_text": "Error- Please try again. If this problem persists, contact your site administrator.", "reward_instruction_text": "Your Instagram account needs to be Public to earn points", "thank_you_text": "Thank you. You will earn {{POINTS}} points as soon as you tag {{BUSINESS_IG}} on Instagram using your public account.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "enter_handle_prompt_text": "Enter your Instagram handle", "personal_handle_input_text": "Your Instagram handle", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Tag on Instagram", "enter_handle_placeholder_text": "Enter your Instagram handle", "edit_handle_text": "Edit your Instagram handle", "business_handle_display_text": "Our business handle(s)" }, "id": "6756a59020df0f847b212e1a", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "rank": -1, "activity_id": "enter_instagram_handle", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-12-09 08:09:12.074000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you enter your Insta handle", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/59f2fb79bcf9f49574a1052177e432de.png", "created_date": "2024-12-09 08:08:48.940000", "activity_name": "Enter Insta Handle", "extra_config": { "max_award_frequency_error_text": "", "duplicate_handle_error_text": "This handle is already used. Please enter another handle.", "activity_start_button_text": "Submit", "failure_text": "There was an error while following on instagram. Please try again. If this problem persists, please contact your site administrator.", "cancel_button_text": "Cancel", "excluded_transaction_error_text": "", "thank_you_text": "Thank you for entering your Instagram handle. You will earn {{POINTS}} points (Limit- Once per lifetime).", "blocked_handle_error_text": "This handle cannot be used. Please enter another handle.", "name_header_text": "Enter Instagram Handle", "enter_handle_placeholder_text": "Enter your Instagram handle" }, "id": "6756a59020df0f847b212e13", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "rank": 1, "activity_id": "share_on_twitter", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-05-23 12:08:09.653000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points when you share us on Twitter.", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/55ad6cd681d4e73bc752cbdfedac826e.png", "created_date": "2021-03-15 12:59:39.857000", "activity_name": "Share on Twitter", "extra_config": { "max_award_frequency_error_text": "Max number of allowed transactions exceeded for this activity. Please try again after a few days", "tweet_message": "Loving this site! Check it out", "reward_text": "You will be awarded {{POINTS}} points immediately after a friend clicks on the shared link.", "excluded_transaction_error_text": "You are prohibited from performing this action. Please contact customer support for more details.", "thank_you_text": "Thank you for sharing us! You will earn {{POINTS}} points when any of your friends click on your link.", "share_button_text": "Share", "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a1", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "rank": 4, "activity_id": "made_a_purchase", "is_points_expiry_reset_activity": true, "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2024-06-27 10:50:48.220000", "metadata": { "Category": "Chocolate Cake" }, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points for every dollar you spend in purchasesyes.", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ebc58958ab6e0dd44248441cf0dc6dde.png", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Purchase", "extra_config": { "max_award_frequency_error_text": "Max number of allowed transactions exceeded for this activity. Please try again after a few days", "excluded_transaction_error_text": "You are prohibited from performing this action. Please contact customer support for more details." }, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, { "points_config": { "points": 200, "points_computation_type": "fixed_points" }, "rank": 7, "activity_id": "anniversary_bonus", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-12-25 06:16:36.670000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Earn points on your anniversary.", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/2819f34c74586cddbc195a17aab639cc.png", "created_date": "2021-03-15 12:59:39.836000", "activity_name": "Anniversary Bonus", "extra_config": { "max_award_frequency_error_text": "Max number of allowed transactions exceeded for this activity. Please try again after a few days", "save_button_text": "Save", "is_year_required": true, "reward_text": "

Enter your anniversary date to earn {{POINTS}} points on your anniversary

", "excluded_transaction_error_text": "You are prohibited from performing this action. Please contact customer support for more details.", "thank_you_text": "

Thanks for sharing your anniversary! We’ll celebrate you by gifting you {{POINTS}} points on your special day.

" }, "id": "604f5a3b8152252216f5c19e", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "rank": 9, "activity_id": "share_on_facebook", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": null, "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-07-14 08:17:00.673000", "metadata": {}, "earnpoints_button_label": "Earn {{POINTS}} points", "enduser_activity_short_description": "Reward points to users when they share you on Facebook.", "icon_image_url": "https://d1qbqkkh49kht1.cloudfront.net/24f391223d888e50111465f593129cc3.png", "created_date": "2021-03-15 12:59:39.848000", "activity_name": "Share on Facebook", "extra_config": { "max_award_frequency_error_text": "Max number of allowed transactions exceeded for this activity. Please try again after a few days", "reward_text": "You will be awarded {{POINTS}} points immediately after a friend clicks on the shared link.", "excluded_transaction_error_text": "You are prohibited from performing this action. Please contact customer support for more details.", "thank_you_text": "Thank you for sharing us! You will earn {{POINTS}} points when any of your friends click on your link.", "share_button_text": "Share", "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a0", "activity_benefit_type": "points" }, { "points_config": { "points": 1000, "points_computation_type": "fixed_points" }, "activity_id": "follow_on_instagram", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-10-30 07:09:02.212000", "metadata": {}, "enduser_activity_short_description": "Earn points when you follow us on Instagram.", "created_date": "2021-03-15 12:59:39.886000", "activity_name": "Follow on Instagram", "extra_config": { "business_instagram_username": "pallavi" }, "id": "604f5a3b8152252216f5c1a4", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "created_an_account", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-06-14 09:03:33.343000", "metadata": {}, "enduser_activity_short_description": "Earn points when you create your loyalty account.", "created_date": "2021-03-15 12:59:39.812000", "activity_name": "Account Creation", "extra_config": {}, "id": "604f5a3b8152252216f5c19a", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "multiplier": 1 }, "activity_id": "write_a_review", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:13:10.021000", "metadata": {}, "enduser_activity_short_description": "Earn points for writing a review.", "created_date": "2021-03-15 12:59:39.824000", "activity_name": "Write a Review", "extra_config": {}, "id": "604f5a3b8152252216f5c19c", "activity_benefit_type": "points" }, { "points_config": { "points": 200, "points_computation_type": "fixed_points" }, "activity_id": "anniversary_bonus", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:07:02.905000", "metadata": {}, "enduser_activity_short_description": "Earn points on your anniversary.", "created_date": "2021-03-15 12:59:39.836000", "activity_name": "Anniversary Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19e", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "f00ca_custom_activity", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-17 11:21:50.190000", "metadata": {}, "enduser_activity_short_description": "", "created_date": "2021-05-05 05:29:46.129000", "activity_name": "", "extra_config": {}, "id": "60922d4abed0d56677192dcf", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "referral", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-12 11:10:12.088000", "metadata": {}, "enduser_activity_short_description": "Award points on referral purchase.", "created_date": "2021-03-22 08:46:18.898000", "activity_name": "Refer a Friend", "extra_config": {}, "id": "6058595abb711d6fa73fcd36", "activity_benefit_type": "points_and_coupon_code" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "activity_id": "684fc_custom_activity", "is_points_expiry_reset_activity": true, "enduser_activity_description_html": "
", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-04-10 11:47:27.127000", "metadata": {}, "enduser_activity_short_description": "Enter the code on your LD pack and earn points", "created_date": "2021-05-05 11:41:57.738000", "activity_name": "684fc_custom_activity", "extra_config": {}, "id": "609284851c9396204c8b984b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "a7ee1_custom_activity", "is_points_expiry_reset_activity": true, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-03-08 11:01:06.969000", "metadata": {}, "enduser_activity_short_description": "Reward your users for any activity you want.", "created_date": "2023-01-23 13:52:30.665000", "activity_name": "Custom Activity", "extra_config": {}, "id": "63ce911ef380d8000b8d7753", "activity_benefit_type": "points" }, { "points_config": { "points": 130, "points_computation_type": "fixed_points" }, "activity_id": "birthday_bonus", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-02-24 07:27:55.290000", "metadata": {}, "enduser_activity_short_description": "Award points on birthday.", "created_date": "2021-03-15 12:59:39.830000", "activity_name": "Birthday Bonus", "extra_config": {}, "id": "604f5a3b8152252216f5c19d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "upload_photo", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-10-06 10:26:28.835000", "metadata": {}, "enduser_activity_short_description": "Earn points for uploading a photo.", "created_date": "2022-07-28 06:53:03.616000", "activity_name": "Upload a Photo", "extra_config": {}, "id": "62e2324f23d74243d1c5af29", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "receipt_order_value", "multiplier": 1 }, "activity_id": "submit_a_receipt", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-10-06 09:54:55.183000", "metadata": {}, "enduser_activity_short_description": "Reward users for submitting receipts of their purchases.", "created_date": "2021-03-22 08:56:14.632000", "activity_name": "Submit A Receipt", "extra_config": {}, "id": "60585baef5a67a16e1871b56", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "activity_id": "share_on_pinterest", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:19.592000", "metadata": {}, "enduser_activity_short_description": "Earn points when you share us on Pinterest.", "created_date": "2021-03-15 12:59:39.873000", "activity_name": "Share on Pinterest", "extra_config": { "pin_post_image": "", "pin_post_description": "Awesome products at great prices. You should really check them out.", "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a3", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "activity_id": "share_on_facebook", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-07-14 08:17:00.673000", "metadata": {}, "enduser_activity_short_description": "Reward points to users when they share you on Facebook.", "created_date": "2021-03-15 12:59:39.848000", "activity_name": "Share on Facebook", "extra_config": { "share_current_page_url": false }, "id": "604f5a3b8152252216f5c1a0", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "f46f4_custom_activity", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-06-14 11:09:16.199000", "metadata": {}, "enduser_activity_short_description": "Reward your users for any activity you want.", "created_date": "2022-03-03 05:30:58.331000", "activity_name": "Quiz form", "extra_config": {}, "id": "622052924e6d9f1dfd89ed88", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "multiplier": 1 }, "activity_id": "code_submission", "is_points_expiry_reset_activity": false, "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-05-19 10:32:40.318000", "metadata": {}, "enduser_activity_short_description": "Get rewarded for your purchases by submitting the code you received with your purchase.", "created_date": "2022-05-18 10:05:41.642000", "activity_name": "Enter a Code", "extra_config": {}, "id": "6284c4f5dfa6b7425568ba6d", "activity_benefit_type": "points" } ], "next_cursor": 100, "more": false }, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/guest-guest-activities-failure-object" }, "examples": { "Result": { "value": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "Invalid Language": { "value": { "reason": { "language": "Value must be one of: english; french; italian; german; spanish (not u'Eng')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "Invalid Parameter": { "value": { "reason": { "count": "Please enter a number that is 1000 or smaller" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "400" } }, "deprecated": false } }, "/loyalty-storefront/rewards": { "get": { "summary": "EUD Guest Rewards API", "operationId": "eud-guest-rewards-api", "tags": [ "guest" ], "security": [ { "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "count", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "language", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "default": "english", "type": "string" }, "in": "query" }, { "name": "sort_by", "description": "

The response will contain the rewards ordered by the rank configured in the TrueLoyal admin console. You can sort the sequence using the following options: \"rank\", \"-rank\", \"points_to_be_redeemed\", or \"-points_to_be_redeemed\". Additionally, you can combine sorting options, such as \"-rank,points_to_be_redeemed\", \"-rank,-points_to_be_redeemed\", \"rank,points_to_be_redeemed\", or \"rank,-points_to_be_redeemed\".

\"-\" signifies the latest reward first.

Note: If no sorting option is specified, the response will default to the saved rank, which is \"rank,points_to_be_redeemed\".

In scenarios where the rank of rewards is same, sorting will be based on a second parameter. For example, in \"rank,points_to_be_redeemed,\" if the ranks are identical, the sorting will then be determined by the points to be redeemed parameter.

", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/guest-guest-rewards-response-object" }, "examples": { "example": { "value": { "data": { "total": 3, "rewards": [ { "enable_auto_redemption": false, "reward_name": "$10 Gift Certificate Netsuite", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "reward_value": "5", "last_modified_date": "04/30/2024 09:09:10", "rank": 1, "extra_parameters": { "redemption_confirm_button_text": "Confirm", "points_deduction_text": "{{POINTS}} points have been deducted.", "redeem_button_text": "Redeem", "ineligible_rewards_progress_text": "You need {{POINTS_TO_UNLOCK_REWARD}} more points to unlock this reward." }, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:39", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 100, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3b8152252216f5c1ad", "reward_id": "reward_bc668", "metadata": { "Category": "Limited time", "Brand": "Nescafe" } }, { "enable_auto_redemption": false, "reward_name": "$10 OFF COUPON Miva", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "reward_value": "10", "last_modified_date": "07/07/2023 10:49:43", "rank": 1, "extra_parameters": { "redemption_confirm_button_text": "Confirm", "points_deduction_text": "{{POINTS}} points have been deducted.", "redeem_button_text": "Redeem", "ineligible_rewards_progress_text": "You need {{POINTS_TO_UNLOCK_REWARD}} more points to unlock this reward." }, "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:41", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1000, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3d8152252216f5c1b0", "reward_id": "reward_a1e91", "metadata": { "Category": "Miva", "Brand": "Nescafe", "Products Eligible": "A,B,C" } }, { "enable_auto_redemption": false, "reward_name": "$15 OFF COUPON", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "reward_value": "10", "last_modified_date": "07/06/2023 05:20:05", "rank": 1, "extra_parameters": { "redemption_confirm_button_text": "Confirm", "points_deduction_text": "{{POINTS}} points have been deducted.", "redeem_button_text": "Redeem", "ineligible_rewards_progress_text": "You need {{POINTS_TO_UNLOCK_REWARD}} more points to unlock this reward." }, "reward_sub_type": "Percentage Discount", "created_date": "03/15/2021 12:59:42", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1400, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3e8152252216f5c1b3", "reward_id": "reward_9c350", "metadata": {} } ], "next_cursor": 100, "more": false }, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/guest-rewards-failure-object" }, "examples": { "Merchant doesn't exist": { "value": { "error_code": 400, "message": "Merchant does not exist.", "error": "MERCHANT_DOES_NOT_EXIST" } }, "Invalid Language": { "value": { "reason": { "language": "Value must be one of: english; french; italian; german; spanish (not u'Engligh')" }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } } } } }, "description": "400" } }, "deprecated": false } }, "/loyalty-storefront/tiers": { "get": { "summary": "EUD Guest Tiers API", "operationId": "eud-guest-tiers-api", "tags": [ "guest" ], "security": [ { "partner_id": [] } ], "parameters": [ { "name": "start_cursor", "description": "Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "count", "description": "Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.", "schema": { "format": "int32", "type": "integer" }, "in": "query" }, { "name": "language", "description": "One of the store languages, for example english/ italian/ german, etc.", "schema": { "default": "english", "type": "string" }, "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/guest-guest-tiers-tier-object" }, "examples": { "Result": { "value": { "data": { "tiers": [ { "created_time": "07-May-2021 05:44:16", "description": "This is default Tier", "id": "6094d3b084d28f07bbda724e", "is_default": true, "minimum_points": 0, "name": "Silver", "tier_id": "zrl_silver", "updated_time": "26-Jul-2023 05:04:04" }, { "created_time": "07-May-2021 05:44:16", "description": "1000 points", "id": "6094d3b084d28f07bbda724d", "is_default": false, "minimum_points": 14000, "name": "Gold", "tier_id": "zrl_gold", "updated_time": "26-Jul-2023 05:04:15" }, { "created_time": "07-May-2021 05:44:16", "description": "5000 Points", "id": "6094d3b084d28f07bbda724c", "is_default": false, "minimum_points": 15000, "name": "Platinum", "tier_id": "zrl_platinum", "updated_time": "26-Jul-2023 05:04:31" } ] }, "success": true } } } } }, "description": "200" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/guest-tiers-failure-object" }, "examples": { "Merchant doesn't exist": { "value": { "error_code": 400, "message": "Merchant does not exist.", "error": "MERCHANT_DOES_NOT_EXIST" } }, "Start cursor not expected": { "value": { "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "reason": "The input field 'start_cursor' was not expected.", "success": false } }, "Input field count not expected": { "value": { "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "reason": "The input field 'count' was not expected.", "success": false } }, "Invalid Language": { "value": { "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "reason": "language: Value must be one of: english; french; italian; german; spanish (not 'Engligh')", "success": false } } } } }, "description": "400" } }, "deprecated": false } } }, "webhooks": { "event_member_enrol": { "post": { "summary": "event_member_enrol", "description": "The User Enrollment event occurs whenever a new user enrolls in the TrueLoyal loyalty program.", "operationId": "eventMemberEnrolWebhook", "tags": [ "loyalty_member_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_enrol" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6332aec45fd7d2000d77b8a2", "total_count": 1, "events": [ { "id": "6332aec49fe239670bc1bcde", "event_type": "event_member_enrol", "data": { "member_info": { "id": "6332aec45fd7d2000d77b89e", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "johndoe21", "member_status": "active", "member_tags": [ "memberenrolled", "memberadded" ], "number_of_purchases": 10, "number_of_redemptions": 1, "birthdate": "08/26/1989 00:00:00", "churn_status": "not_available", "enrollment_date": "09/27/2022 00:00:00", "last_modified_date": "09/27/2022 00:00:00", "first_purchase_date": "10/26/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "12/29/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "12/29/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 500, "loyalty_tier_id": "zrl_silver", "current_period_end": "12/29/2023 00:00:00" }, "lifetime_points_earned": 10, "lifetime_points_expired": 0, "available_points": 100, "points_onhold": 10, "lifetime_points_deducted": 50, "lifetime_points_redeemed": 70, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/JOH6FWL5", "custom_attributes": { "Nationality": "Indian" }, "revenue": 200, "aov": 10, "deleted_date": null } } } ], "created_date": "09/27/2022 08:05:24" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_member_update": { "post": { "summary": "event_member_update", "description": "This event will occur when the member's attributes are changed.", "operationId": "eventMemberUpdateWebhook", "tags": [ "loyalty_member_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_update" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6332b7ea700381000c191cd6", "total_count": 1, "events": [ { "id": "6332b7eb673e44cc09b78c0e", "event_type": "event_member_update", "data": { "member_info": { "id": "632c66dbf4dc13000bed3f3b", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "jd", "member_status": "active", "member_tags": [ "ab1", "ab2" ], "number_of_purchases": 4, "number_of_redemptions": 0, "birthdate": "09/09/1900 00:00:00", "churn_status": "not_available", "enrollment_date": "09/22/2022 00:00:00", "last_modified_date": "09/27/2022 00:00:00", "first_purchase_date": "09/26/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "09/27/2022 00:00:00", "anniversary_date": "02/11/2020 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "tier_info": { "tier_qualification_units": 100, "current_period_start": "01/01/2022 00:00:00", "loyalty_tier_name": "Gold", "qualified_points": 0, "loyalty_tier_id": "zrl_gold", "current_period_end": "12/31/2022 23:59:59" }, "deprecated_fields": { "user_id": "abgjdyo2" }, "lifetime_points_earned": 0, "lifetime_points_expired": 0, "available_points": 1060, "points_onhold": 10, "lifetime_points_deducted": 100, "lifetime_points_redeemed": 0, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/JOH81EEI", "custom_attributes": { "traveled destination": "Europe" }, "revenue": 106, "aov": 1.2, "deleted_date": null } } } ], "created_date": "09/27/2022 08:44:26" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_member_delete": { "post": { "summary": "event_member_delete", "description": "The member delete event occurs whenever a user or users are deleted from the admin console.", "operationId": "eventMemberDeleteWebhook", "tags": [ "loyalty_member_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_delete" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "68073012ebf4bb22b8927d10", "total_count": 2, "events": [ { "id": "68073013bf994f7fc6f1a565", "event_type": "event_member_delete", "data": { "member_info": { "id": "68072c5a1f244ec971c69a8c", "member_id": "johndoe@gmail.com", "email_address": "johndoe@gmail.com", "phone_number": "+216-2345678765", "member_status": "deleted" } } }, { "id": "68073013bf994f7fc6f1a566", "event_type": "event_member_delete", "data": { "member_info": { "id": "68072fea1f244ec971c69d41", "member_id": "annasmith@zinrelo.com", "email_address": "annasmith@zinrelo.com", "phone_number": "+91-1234567890", "member_status": "deleted" } } } ], "created_date": "04/22/2025 05:58:42" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_member_tierupgrade": { "post": { "summary": "event_member_tierupgrade", "description": "The tier upgrade event occurs whenever a customer earns enough points to move up to a higher tier. The tier upgrade is processed immediately, and the webhook is triggered at the time of the upgrade.", "operationId": "eventMemberTierupgradeWebhook", "tags": [ "loyalty_member_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_tierupgrade" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6332b666700381000d0dc366", "total_count": 1, "events": [ { "id": "6332b669673e44cc09b78c0c", "event_type": "event_member_tierupgrade", "data": { "member_info": { "id": "632c66dbf4dc13000bed3f3b", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john_doe", "member_status": "active", "member_tags": [ "ab1", "ab2" ], "number_of_purchases": 4, "number_of_redemptions": 0, "birthdate": "09/09/1900 00:00:00", "enrollment_date": "09/22/2022 00:00:00", "last_modified_date": "09/27/2022 00:00:00", "first_purchase_date": "09/26/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "09/27/2022 00:00:00", "anniversary_date": "02/11/2020 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "01/01/2022 00:00:00", "loyalty_tier_name": "Gold", "qualified_points": 1000, "loyalty_tier_id": "zrl_gold", "current_period_end": "12/31/2022 23:59:59" }, "lifetime_points_earned": 0, "lifetime_points_expired": 0, "available_points": 1060, "points_onhold": 10, "lifetime_points_deducted": 100, "lifetime_points_redeemed": 0, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/JOH81EEI", "custom_attributes": { "Favourite Destination": "London" }, "revenue": 106, "aov": 1.5, "deleted_date": null } } } ], "created_date": "09/27/2022 08:37:58" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_member_tierdowngrade": { "post": { "summary": "event_member_tierdowngrade", "description": "The tier downgrade event occurs whenever a customer is downgraded to a lower tier for not having enough points to stay on the current tier. The tier downgrade criteria are evaluated at the end of a \"Tier Evaluation Period\" and also when points are deducted.", "operationId": "eventMemberTierdowngradeWebhook", "tags": [ "loyalty_member_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_tierdowngrade" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "63340d3ab63c5d000b65ab31", "total_count": 1, "events": [ { "id": "63340d3b561d49af9f5ce4c0", "event_type": "event_member_tierdowngrade", "data": { "member_info": { "id": "6333fba90ae9d6000b38e518", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john_doe", "member_status": "active", "member_tags": [ "member1", "member2" ], "number_of_purchases": 7, "number_of_redemptions": 0, "birthdate": "08/26/1989 00:00:00", "enrollment_date": "09/28/2022 00:00:00", "last_modified_date": "09/28/2022 00:00:00", "first_purchase_date": "09/28/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "09/28/2022 00:00:00", "anniversary_date": "12/06/1989 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "09/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 0, "loyalty_tier_id": "zrl_silver", "current_period_end": "09/30/2022 23:59:59" }, "lifetime_points_earned": 900, "lifetime_points_expired": 0, "available_points": 900, "points_onhold": 10, "lifetime_points_deducted": 6200, "lifetime_points_redeemed": 0, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/JOH1L48L", "custom_attributes": { "Last traveled": "London" }, "revenue": 700, "aov": 7, "deleted_date": null } } } ], "created_date": "09/28/2022 09:00:42" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_member_otp_generation": { "post": { "summary": "event_member_otp_generation", "description": "The member_otp_generation event occurs whenever a user requests an OTP for user authentication into the TrueLoyal loyalty program.", "operationId": "eventMemberOtpGenerationWebhook", "tags": [ "loyalty_member_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_otp_generation" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "otp_info": { "$ref": "#/components/schemas/OtpInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "638706a8f9e076000d6c61f5", "total_count": 1, "events": [ { "id": "638706a987c5ca4b159b837b", "event_type": "event_member_otp_generation", "data": { "member_info": { "id": "63805bc5d34967000d6a2c7f", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": "memberotp", "number_of_purchases": 13, "number_of_redemptions": 4, "birthdate": "08/26/1986 00:00:00", "enrollment_date": "11/25/2022 00:00:00", "last_modified_date": "11/30/2022 00:00:00", "first_purchase_date": "11/25/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "11/30/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 13, "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "TES7GQL4", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "lifetime_points_earned": 514116, "lifetime_points_expired": 0, "available_points": 485762, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 28354, "referral_URL": "https://zinrelo.com/ref/TES7GQL4", "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Business", "Age_In_Years": "35", "Gender_Identity": "Male", "Graduation_Date": "03/12/2000 00:00:00" }, "revenue": 13, "aov": 0.7, "deleted_date": null }, "otp_info": { "otp": "470393", "minutes_valid": 5, "valid_till": "11/30/2022, 07:35:48" } } } ], "created_date": "11/30/2022 07:30:48" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_points_earned": { "post": { "summary": "event_points_earned", "description": "The Points Awarded event occurs when a user or users are awarded loyalty points. In the case of activities where moderation is required, the event occurs once the points have been approved.\n\n**Note:** In the case of \"submit_a_receipt\" activity, the response will show \"receipt_uid\" in the \"additional_data\" field.", "operationId": "eventPointsEarnedWebhook", "tags": [ "loyalty_transaction_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_points_earned" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "transaction_info": { "$ref": "#/components/schemas/TransactionInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "638706181f4a31001225c480", "total_count": 2, "events": [ { "id": "6387061987c5ca4b159b8377", "event_type": "event_points_earned", "data": { "member_info": { "id": "63805bc5d34967000d6a2c7f", "first_name": "Anna", "last_name": "Scott", "email_address": "annascott286@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017134", "member_id": "annascott46778", "member_status": "active", "member_tags": "earnedpoints", "number_of_purchases": 13, "number_of_redemptions": 4, "birthdate": "07/16/1986 00:00:00", "enrollment_date": "11/25/2022 00:00:00", "last_modified_date": "11/30/2022 00:00:00", "first_purchase_date": "11/25/2022 00:00:00", "instagram_handle": "www.instagram.com/anna", "last_purchase_date": "11/30/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/anna", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualifid_points": 13, "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "TES7GQL4", "lifetime_points_earned": 514116, "lifetime_points_expired": 0, "available_points": 485762, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 28354, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/TES7GQL4", "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "45", "Gender_Identity": "Female", "Graduation_Date": "15/12/1989 00:00:00" }, "revenue": 13, "aov": null, "deleted_date": null }, "transaction_info": { "id": "63805bc7d34967000c755c8d", "transaction_type": "award", "member_id": "annascott46778", "transaction_attributes": { "order_id": "order11990845", "coupon_code": "3199", "reason": "earnedpoints", "tags": "pointsawarded", "products": [ { "product_id": "prod21", "product_price": "10", "product_title": "Shoes", "product_category": "Puma,shkoes,adi!@#", "product_quantity": "1", "product_url": "http://www.website.com/product1.html", "is_excluded": false, "bonus_multiplier": 0, "product_points_per_quantity": 10, "product_image_url": "https://nyoobserver.files.wordpress.com/2014/03/walking-stick.jpg" }, { "product_id": "prod1m", "product_price": "10", "product_title": "Stick", "product_category": "mugs,cups,sale", "product_quantity": "1", "product_url": "http://www.website.com/product1.html", "is_excluded": false, "bonus_multiplier": 0, "product_points_per_quantity": 10, "product_image_url": "https://nyoobserver.files.wordpress.com/2014/04/walking-stick.jpg" }, { "product_id": "prod2m", "product_price": "10", "product_title": "Stick", "product_category": "mugs,cups,sale, floor, refresh", "product_quantity": "1", "product_url": "http://www.website.com/product1.html", "is_excluded": false, "bonus_multiplier": 0, "product_points_per_quantity": 10, "product_image_url": "https://nyoobserver.files.wordpress.com/2014/03/walking-stick.jpg" } ] }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "11/30/2022 07:28:23", "last_modified_date": "11/30/2022 07:28:23", "created_date": "11/30/2022 06:08:07", "award_info": { "activity_id": "made_a_purchase", "activity_name": "Purchase on website", "points_status": "approved", "points": 1 }, "points_expiration_date": "12/07/2022 14:54:58", "auto_approval_date": "" } } }, { "id": "6387061987c5ca4b159b8378", "event_type": "event_points_earned", "data": { "member_info": { "id": "63805bc5d34967000d6a2c7f", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "537 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94307" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": "pointsawarded", "number_of_purchases": 13, "number_of_redemptions": 4, "birthdate": "08/26/1986 00:00:00", "enrollment_date": "11/25/2022 00:00:00", "last_modified_date": "11/30/2022 00:00:00", "first_purchase_date": "11/25/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "11/30/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 13, "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "TES7GQL4", "lifetime_points_earned": 514116, "lifetime_points_expired": 0, "available_points": 485762, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 28354, "referral_URL": "https://zinrelo.com/ref/TES7GQL4", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Business", "Age_In_Years": "35", "Gender_Identity": "Male", "Graduation_Date": "03/12/2000 00:00:00" }, "revenue": 13, "aov": 1.8, "deleted_date": null }, "transaction_info": { "id": "63805f2b04d91e0012341d8f", "transaction_type": "award", "member_id": "john.doe23", "transaction_attributes": { "reason": "pointearned", "tags": [] }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "11/30/2022 07:28:23", "last_modified_date": "11/30/2022 07:28:23", "created_date": "11/25/2022 06:22:35", "award_info": { "activity_id": "referral", "activity_name": "Refer a Friend", "points_status": "approved", "points": 9999 }, "points_expiration_date": "12/07/2022 14:54:58", "auto_approval_date": "" } } } ], "created_date": "11/30/2022 07:28:24" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_points_redeemed": { "post": { "summary": "event_points_redeemed", "description": "The Points Redeemed event occurs whenever a user redeems his loyalty points.", "operationId": "eventPointsRedeemedWebhook", "tags": [ "loyalty_transaction_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_points_redeemed" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "transaction_info": { "$ref": "#/components/schemas/TransactionInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6332b104700381000ae573bd", "total_count": 1, "events": [ { "id": "6332b106fab4f0e2bf7cef24", "event_type": "event_points_redeemed", "data": { "member_info": { "id": "6329aced6d6081000a596007", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john_doe", "member_status": "active", "member_tags": [ "redemption1", "redemption2" ], "number_of_purchases": 17, "number_of_redemptions": 1, "birthdate": "08/26/1989 00:00:00", "enrollment_date": "09/20/2022 00:00:00", "last_modified_date": "09/27/2022 00:00:00", "first_purchase_date": "09/20/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "09/26/2022 00:00:00", "anniversary_date": "02/11/2020 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "12/29/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 500, "loyalty_tier_id": "zrl_silver", "current_period_end": "12/29/2023 00:00:00" }, "lifetime_points_earned": 0, "lifetime_points_expired": 0, "available_points": 4752, "points_onhold": 10, "lifetime_points_deducted": 28, "lifetime_points_redeemed": 500, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/JOH350RU", "custom_attributes": { "Nationality": "American" }, "revenue": 500, "aov": 120, "deleted_date": null }, "transaction_info": { "id": "6332b103700381000ae573bb", "transaction_type": "redeem", "member_id": "john_doe", "transaction_attributes": { "tags": [ "pointsredeemed", "redemptionmade" ], "reason": "purchasemade", "source_of_redemption": "manual" }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "11/27/2022 08:14:59", "last_modified_date": "11/27/2022 08:14:59", "created_date": "11/27/2022 08:14:59", "reward_info": { "reward_id": "reward_5c45d", "reward_name": "$5 OFF COUPON", "points_status": "redeemed", "points": 500, "coupon_code": "500DSRM", "reward_link": null } } } } ], "created_date": "09/27/2022 08:15:00" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_points_deducted": { "post": { "summary": "event_points_deducted", "description": "The Points Deducted event occurs whenever points are deducted from a user’s loyalty point balance. The points can be deducted from the TrueLoyal store or by using API calls.", "operationId": "eventPointsDeductedWebhook", "tags": [ "loyalty_transaction_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_points_deducted" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "transaction_info": { "$ref": "#/components/schemas/TransactionInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6332b44fa9f094000beae74e", "total_count": 1, "events": [ { "id": "6332b44f6810fce4d056292c", "event_type": "event_points_deducted", "data": { "member_info": { "id": "6332aec45fd7d2000d77b89e", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "johndoe21", "member_status": "active", "member_tags": [ "deduction1", "deduction2" ], "number_of_purchases": 1, "number_of_redemptions": 0, "birthdate": "08/26/1989 00:00:00", "enrollment_date": "09/27/2022 00:00:00", "last_modified_date": "09/27/2022 00:00:00", "first_purchase_date": "09/27/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "09/27/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "01/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 60000, "loyalty_tier_id": "zrl_silver", "current_period_end": "12/31/2022 23:59:59" }, "lifetime_points_earned": 0, "lifetime_points_expired": 0, "available_points": 54100, "points_onhold": 10, "lifetime_points_deducted": 6000, "lifetime_points_redeemed": 0, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/JOH6FWL5", "custom_attributes": { "Number of purchases": 1 }, "revenue": 6000, "aov": 100, "deleted_date": null }, "transaction_info": { "id": "6332b44fa9f094000beae74c", "transaction_type": "deduct", "member_id": "johndoe21", "transaction_attributes": { "reason": "return", "tags": [ "deductionmade", "pointsdeducted" ] }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "11/27/2022 08:29:03", "last_modified_date": "11/27/2022 08:29:03", "created_date": "11/27/2022 08:29:03", "deduct_info": { "points_status": "deducted", "points": 6000 } } } } ], "created_date": "09/27/2022 08:29:03" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_points_expired": { "post": { "summary": "event_points_expired", "description": "The Points Expired event occurs whenever loyalty points in a customer's loyalty account balance expire. This event is triggered as soon as the status of the points is marked as expired.", "operationId": "eventPointsExpiredWebhook", "tags": [ "loyalty_transaction_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_points_expired" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "transaction_info": { "$ref": "#/components/schemas/TransactionInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "63341215563aef00174f73a7", "total_count": 1, "events": [ { "id": "6334121b4f113d58b2ed3ef5", "event_type": "event_points_expired", "data": { "member_info": { "id": "6329aeaddee54a000cbce5ec", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john_doe", "member_status": "active", "member_tags": [ "member1", "member2" ], "number_of_purchases": 10, "number_of_redemptions": 0, "birthdate": "09/21/1900 00:00:00", "enrollment_date": "09/20/2022 00:00:00", "last_modified_date": "09/28/2022 00:00:00", "first_purchase_date": "09/20/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "09/21/2022 00:00:00", "anniversary_date": "09/21/1900 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "09/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 10390, "loyalty_tier_id": "zrl_silver", "current_period_end": "09/30/2022 23:59:59" }, "lifetime_points_earned": 11034, "lifetime_points_expired": 11034, "available_points": 0, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/JOH7EI9V", "custom_attributes": { "Gender": "Male", "Number of purchases": 1, "List of favourite place": [ "London", "Paris" ], "Review date": "12/10/2022 00:00:00" }, "revenue": 1000, "aov": 10, "deleted_date": null }, "transaction_info": { "id": "632acf6cdee54a000b092934", "transaction_type": "award", "member_id": "john_doe", "expiry_info": { "points_status": "expired", "points": 1000 }, "approved_date": "09/21/2022 08:46:36", "approver_details": { "approver_id": null, "approver_name": "System" }, "last_modified_date": "09/28/2022 09:10:17", "created_date": "09/21/2022 08:46:35" } } } ], "created_date": "09/28/2022 09:21:24" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_points_rejected": { "post": { "summary": "event_points_rejected", "description": "This event will occur whenever a user's or users pending points are rejected in moderation.", "operationId": "eventPointsRejectedWebhook", "tags": [ "loyalty_transaction_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_points_rejected" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "transaction_info": { "$ref": "#/components/schemas/TransactionInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "638705ba3541f8000e30bd4d", "total_count": 2, "events": [ { "id": "638705bb87c5ca4b159b8373", "event_type": "event_points_rejected", "data": { "member_info": { "id": "63805f96d34967000b5111ed", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": [ "rejected", "pushedback", "purchaserejected" ], "number_of_purchases": 0, "number_of_redemptions": 0, "birthdate": "01/31/1900 00:00:00", "enrollment_date": "11/25/2022 00:00:00", "last_modified_date": "11/25/2022 00:00:00", "first_purchase_date": "11/25/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "11/25/2022 00:00:00", "anniversary_date": "11/25/2022 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 0, "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "K1718C2A", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "lifetime_points_earned": 100, "lifetime_points_expired": 0, "available_points": 100, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "referral_URL": "https://zinrelo.com/ref/K1718C2A", "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Business", "Age_In_Years": "35", "Gender_Identity": "Male", "Graduation_Date": "03/12/2000 00:00:00" }, "revenue": 0, "aov": 0, "deleted_date": null }, "transaction_info": { "id": "63806091d34967000a27a8c0", "transaction_type": "award", "member_id": "john.doe23", "transaction_attributes": { "order_id": "N17987314111q1ewy28971", "coupon_code": "A1346BC", "reason": "THird", "tags": [ "purchasereturned", "rejected" ], "pow_01": null, "products": [ { "product_id": "9801198", "product_price": "50", "product_title": "RelaxedFitSweatshirt-Mintgreen", "product_category": "Essentials", "product_quantity": "1", "product_url": null, "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" }, { "product_id": "98012", "product_price": "25", "product_title": "Sweatshirt", "product_category": "Sale", "product_quantity": "2", "product_url": null, "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" } ], "order_subtotal": 1, "order_total": 110, "coupons": "a", "currency": "$" }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "", "last_modified_date": "11/30/2022 07:26:50", "created_date": "11/25/2022 06:28:32", "award_info": { "activity_id": "made_a_purchase", "activity_name": "Purchase on website", "points_status": "rejected", "points": 1 }, "points_expiration_date": "12/05/2022 06:28:32", "auto_approval_date": "" } } }, { "id": "638705bb87c5ca4b159b8374", "event_type": "event_points_rejected", "data": { "member_info": { "id": "63805f2ad34967000b5111e2", "first_name": "Anna", "last_name": "Scott", "email_address": "annascott286@gmail.com", "address": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "15702" }, "phone_number": "+82-1234567890", "member_id": "anna.scott286", "member_status": "active", "member_tags": [ "maderejected", "rejected" ], "number_of_purchases": 0, "number_of_redemptions": 0, "birthdate": "01/31/1900 00:00:00", "enrollment_date": "11/25/2022 00:00:00", "last_modified_date": "11/25/2022 00:00:00", "first_purchase_date": "11/25/2022 00:00:00", "instagram_handle": "www.instagram.com/anna", "last_purchase_date": "12/12/2022 00:00:00", "anniversary_date": "11/25/2022 00:00:00", "twitter_handle": "www.twitter.com/anna", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 0, "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "K171XD9M", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "lifetime_points_earned": 100, "lifetime_points_expired": 0, "available_points": 100, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "referral_URL": "https://zinrelo.com/ref/K171XD9M", "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "45", "Gender_Identity": "Female", "Graduation_Date": "15/12/1989 00:00:00" }, "revenue": 0, "aov": 0, "deleted_date": null }, "transaction_info": { "id": "638060e7d34967000a27a8d9", "transaction_type": "award", "member_id": "anna.scott286", "transaction_attributes": { "order_id": "N17987314111q1eswy28971", "coupon_code": "a", "reason": "THird", "tags": [ "reject", "rejectionmade" ], "pow_01": null, "products": [ { "product_id": "9801198", "product_price": "50", "product_title": "RelaxedFitSweatshirt-Mintgreen", "product_category": "Essentials", "product_quantity": "1", "product_url": null, "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" }, { "product_id": "98012", "product_price": "25", "product_title": "Sweatshirt", "product_category": "Sale", "product_quantity": "2", "product_url": null, "product_image_url": "https://cdn.shopify.com/s/files/1/1617/6377/products/220px-Far_Cry_5_boxshot_1024x1024@2x.jpg?v=1528970252" } ], "order_subtotal": 1, "order_total": 110, "coupons": "a", "currency": "$" }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "", "last_modified_date": "11/30/2022 07:26:50", "created_date": "11/25/2022 06:29:59", "award_info": { "activity_id": "made_a_purchase", "activity_name": "Purchase on website", "points_status": "rejected", "points": 1 }, "points_expiration_date": "12/05/2022 06:29:59", "auto_approval_date": "" } } } ], "created_date": "11/30/2022 07:26:50" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_friend_incentive_request": { "post": { "summary": "event_friend_incentive_request", "description": "This event occurs when a friend clicks on the referral link shared by a user and enters their email to claim a reward. This event is related to the \"Refer a Friend\" activity. This event is triggered as soon as the coupon is dispatched to the friend's email address.", "operationId": "eventFriendIncentiveRequestWebhook", "tags": [ "loyalty_referral_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_friend_incentive_request" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "friend_info": { "$ref": "#/components/schemas/FriendInfo" }, "incentive_info": { "$ref": "#/components/schemas/IncentiveInfo" } } } } } } } }, "examples": { "example1": { "summary": "New friend", "value": { "request_id": "6333fb9e1ddab5000ba5e74a", "total_count": 1, "events": [ { "id": "6333fba0fa6dbb793c3ecb73", "event_type": "event_friend_incentive_request", "data": { "friend_info": { "email_address": "annascott286@gmail.com" }, "incentive_info": { "coupon": "FRIEND10", "referrer_info": { "referral_link": "https://zinrelo.com/ref/WEB7AMEU", "member_id": "anna598", "id": "63b3ec0a4df04512da0882d3" } } } } ], "created_date": "09/28/2022 07:45:34" } }, "example2": { "summary": "Friend already enrolled", "value": { "request_id": "6336e12cca5ac5000af2805e", "total_count": 1, "events": [ { "id": "6336e12eeecc0c196e9e50d7", "event_type": "event_friend_incentive_request", "data": { "friend_info": { "id": "633689b8fe0c0000093bc10a", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "johndoe55", "member_status": "active", "member_tags": [ "member1", "member2" ], "number_of_purchases": 1, "number_of_redemptions": 0, "birthdate": "08/26/1989 00:00:00", "enrollment_date": "09/30/2022 00:00:00", "last_modified_date": "09/30/2022 00:00:00", "first_purchase_date": "09/30/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "09/30/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "tier_info": { "tier_qualification_units": 100, "current_period_start": "09/01/2022 00:00:00", "loyalty_tier_name": "Gold", "qualified_points": 1000, "loyalty_tier_id": "zrl_gold", "current_period_end": "09/30/2022 23:59:59" }, "lifetime_points_earned": 1100, "lifetime_points_expired": 0, "available_points": 1100, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "referral_URL": "zinrelo.com/ref/JOH1HQK8", "custom_attributes": { "Gender": [ "Male", "Female" ], "Number of purchases": 1, "List of favourite place": [ "London", "Paris" ], "Review date": "12/10/2022 00:00:00" }, "revenue": 100, "aov": 1.7, "deleted_date": null } } } ], "created_date": "09/30/2022 12:29:32" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_referral_link_share": { "post": { "summary": "event_referral_link_share", "description": "This event will occur when the referral link is shared through email or via social channels. Only the shared_event will change to email or Twitter; the rest of the payload will be the same.\n\n**Note:** When the referral is shared through social channels, the email_share_info will not be in the payload.", "operationId": "eventReferralLinkShareWebhook", "tags": [ "loyalty_referral_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_referral_link_share" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "share_info": { "$ref": "#/components/schemas/ShareInfo" }, "email_share_info": { "$ref": "#/components/schemas/EmailShareInfo" } } } } } } } }, "examples": { "example1": { "summary": "Shared by email", "value": { "request_id": "635f612657041f0011f38144", "total_count": 1, "events": [ { "data": { "member_info": { "last_name": "Scott", "twitter_handle": "www.twitter.cpm/anna", "revenue": 0, "lifetime_points_expired": 0, "last_modified_date": "10/17/2022 00:00:00", "available_points": 3400, "points_onhold": 10, "lifetime_points_earned": 3400, "referral_URL": "https://zinrelo.com/ref/ANNA2Q49X", "member_status": "active", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "email_address": "annascott286@gmail.com", "id": "632c664bf860bf0516e2d26f", "first_name": "Anna", "member_tags": [ "referralshared", "referralapproved" ], "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "12/20/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 1000, "loyalty_tier_id": "zrl_silver", "current_period_end": null }, "custom_attributes": { "Number of purchases": 2 }, "first_purchase_date": "10/20/2022 00:00:00", "lifetime_points_deducted": 0, "phone_number": "+1-6507017756", "instagram_handle": "www.instagram.com/anna", "aov": 20, "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "deleted_date": null, "last_purchase_date": "12/18/2022 00:00:00", "lifetime_points_redeemed": 100, "preferred_language": "English", "number_of_purchases": 4, "number_of_redemptions": 1, "birthdate": "10/31/1987 00:00:00", "anniversary_date": "10/29/2022 00:00:00", "enrollment_date": "09/22/2022 00:00:00", "member_id": "anna.scott234" }, "share_info": { "channel_shared": "email" }, "email_share_info": { "friend_email": [ "johndoe@gmail.com", "jack.bryant@gmail.com", "jason.reese@aol.com" ] } }, "event_type": "event_referral_link_share", "id": "634d3789f21e109d10119c57" } ], "created_date": "10/31/2022 05:46:14" } }, "example2": { "summary": "Shared on a social channel", "value": { "request_id": "635f612657041f0011f38144", "total_count": 1, "events": [ { "data": { "member_info": { "last_name": "Scott", "twitter_handle": "www.twitter.com/anna", "revenue": 0, "lifetime_points_expired": 0, "last_modified_date": "10/17/2022 00:00:00", "available_points": 3400, "points_onhold": 10, "lifetime_points_earned": 3400, "referral_URL": "https://zinrelo.com/ref/ANNA2Q49X", "member_status": "active", "email_address": "annascott286@gmail.com", "id": "632c664bf860bf0516e2d26f", "first_name": "Anna", "member_tags": [ "referralshared", "referralapproved" ], "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "12/20/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 0, "loyalty_tier_id": "zrl_silver", "current_period_end": "12/20/2023 00:00:00" }, "custom_attributes": { "Preferences": "T-shirt" }, "first_purchase_date": "10/20/2022 00:00:00", "lifetime_points_deducted": 0, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "phone_number": "+1-6507017756", "instagram_handle": "www.instagram.com/anna", "aov": 5, "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "deleted_date": null, "last_purchase_date": "12/18/2022 00:00:00", "lifetime_points_redeemed": 100, "preferred_language": "English", "number_of_purchases": 4, "number_of_redemptions": 1, "birthdate": "10/31/1987 00:00:00", "anniversary_date": "10/29/2022 00:00:00", "enrollment_date": "09/22/2022 00:00:00", "member_id": "anna.scott234" }, "share_info": { "channel_shared": "twitter" } }, "event_type": "event_referral_link_share", "id": "634d3789f21e109d10119c57" } ], "created_date": "10/31/2022 05:46:14" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_referral_success": { "post": { "summary": "event_referral_success", "description": "This event will occur when the referred friend clicks on the referral link and makes his first purchase.\n\n**Note:** The order_info field will be null for all activities other than purchase activities.\n\nIf a guest makes a purchase and is not enrolled in the loyalty program, the friend info in payload will appear as follows:\n\n```json\n \"friend_info\": {\n \"email_address\": \"annascott286@gmail.com\",\n \"member_id\": \"anna.scott286\"\n }\n```", "operationId": "eventReferralSuccessWebhook", "tags": [ "loyalty_referral_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_referral_success" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "friend_info": { "$ref": "#/components/schemas/FriendInfo" }, "referrer_info": { "$ref": "#/components/schemas/ReferrerInfo" }, "referral_success_activity_info": { "$ref": "#/components/schemas/ReferralSuccessActivityInfo" }, "referrer_reward_info": { "$ref": "#/components/schemas/ReferrerRewardInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "638718fdf9e076000ab268f6", "total_count": 1, "events": [ { "id": "638718ff5efcad6bb4286b36", "event_type": "event_referral_success", "data": { "friend_info": { "id": "638718faf9e07600094f239c", "first_name": "Anna", "last_name": "Scott", "email_address": "annascott286@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017756", "member_id": "anna.scott286", "member_status": "active", "member_tags": [ "referral", "referredfriend" ], "number_of_purchases": 1, "number_of_redemptions": 0, "birthdate": "10/31/1987 00:00:00", "enrollment_date": "11/30/2022 00:00:00", "last_modified_date": "11/30/2022 00:00:00", "first_purchase_date": "11/30/2022 00:00:00", "instagram_handle": "www.instagram.com/anna", "last_purchase_date": "11/30/2022 00:00:00", "anniversary_date": "10/29/2022 00:00:00", "twitter_handle": "www.twitter.com/anna", "preferred_language": "English", "tier_info": { "tier_qualification_units": 100, "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 1190, "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "TES855D6", "lifetime_points_earned": 1200, "lifetime_points_expired": 0, "available_points": 1200, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "referral_URL": "https://shopsocially.com/ref/TES855D6", "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Service", "Age_In_Years": "45", "Gender_Identity": "Female", "Graduation_Date": "15/12/1989 00:00:00" }, "revenue": 1190, "aov": 20, "deleted_date": null }, "referrer_info": { "id": "63870ad3f9e076000b1ab907", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": [ "referrer", "referred" ], "number_of_purchases": 2, "number_of_redemptions": 2, "birthdate": "08/26/1989 00:00:00", "enrollment_date": "11/30/2022 00:00:00", "last_modified_date": "11/30/2022 00:00:00", "first_purchase_date": "11/30/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "11/30/2022 00:00:00", "anniversary_date": "05/03/2021 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "tier_info": { "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Max-Pro", "qualified_points": 2380, "loyalty_tier_id": "tier_cb4b5", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "SAM02XIU", "lifetime_points_earned": 38035, "lifetime_points_expired": 0, "available_points": 12681, "points_onhold": 100, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 25354, "referral_URL": "https://shopsocially.com/ref/SAM02XIU", "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Business", "Age_In_Years": "35", "Gender_Identity": "Male", "Graduation_Date": "03/12/2000 00:00:00" }, "revenue": 2380, "aov": null, "deleted_date": null }, "referral_success_activity_info": { "activity_id": "made_a_purchase", "activity_name": "Purchase on website", "order_info": { "order_total": "600", "currency": "USD", "order_id": "order13401703", "order_subtotal": "1190", "reason": "reference", "device_type": "desktop", "coupons": "3199" } }, "referrer_reward_info": [ { "id": "638718fcf9e076000ab268e4", "transaction_type": "award", "member_id": "johndoe55", "transaction_attributes": { "reason": "referredafriend", "tags": [] }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "11/30/2022 08:49:00", "last_modified_date": "11/30/2022 08:49:00", "created_date": "11/30/2022 08:49:00", "award_info": { "activity_id": "referral", "activity_name": "Refer a Friend", "points_status": "approved", "points": 35645 }, "points_expiration_date": "12/10/2022 08:49:00", "auto_approval_date": "" }, { "id": "638718fdf9e076000ab268f1", "transaction_type": "coupon_award", "member_id": "john.doe23", "transaction_attributes": { "reason": "reference", "tags": [] }, "approver_details": { "approver_id": null, "approver_name": "System" }, "approved_date": "11/30/2022 08:49:01", "last_modified_date": "11/30/2022 08:49:01", "created_date": "11/30/2022 08:49:01", "award_info": { "coupon_code": "34", "activity_id": "referral", "points": 0, "points_status": "approved", "activity_name": "Refer a Friend" } } ] } } ], "created_date": "11/30/2022 08:49:01" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_winback_offer": { "post": { "summary": "event_winback_offer", "description": "The winback offer occurs when a user has been inactive for an extended period of time.", "operationId": "eventWinbackOfferWebhook", "tags": [ "loyalty_system_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_winback_offer" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "offer_info": { "$ref": "#/components/schemas/OfferInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "638729c94f8f0345970b6d96", "total_count": 1, "events": [ { "id": "63872a654f8f0345970b6d99", "event_type": "event_winback_offer", "data": { "member_info": { "id": "john286", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": "winbackmember", "number_of_purchases": 7, "number_of_redemptions": 3, "birthdate": "08/26/1986 00:00:00", "enrollment_date": "02/05/2022 00:00:00", "last_modified_date": "12/10/2022 00:00:00", "first_purchase_date": "02/05/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "12/10/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 1000, "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "ERGH12309", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "lifetime_points_earned": 5000, "lifetime_points_expired": 0, "available_points": 5000, "points_onhold": 10, "lifetime_points_deducted": 100, "lifetime_points_redeemed": 1000, "referral_URL": "https://zinrelo.com/ref/ERGH12309", "custom_attributes": { "Subscription Plan": "Basic", "Active Camera": 2 }, "revenue": 2000, "aov": 20, "deleted_date": null }, "offer_info": { "offer_valid_till": "11/30/2022, 15:30:41", "bonus_points": 100, "activity_to_complete": { "id": "63206d4d19da5f27de385ead", "activity_id": "made_a_purchase", "metadata": { "Category": "T-Shirt", "Location": "London", "Gender": "Male" }, "activity_name": "Purchase on website", "is_active": true, "approval_method": "immediate", "show_on_guest_dashboard": true, "activity_card_background_image_url": "", "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "enduser_activity_description_html": "", "last_modified_date": "11/23/2022 10:29:40", "created_date": "09/13/2022 11:45:17", "is_qualified_for_tier_upgrade": true, "rules_config": [ { "rule_type": "Fixed Points", "rule_value": 123, "is_active": false, "conditions_matching_policy": "match_all", "conditions": [ { "operator": "Contain any of", "attribute": "Transaction Tags", "value": [ "winback", "sendoffer" ] } ] } ], "activity_benefit_type": "points", "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 } } } } } ], "created_date": "11/30/2022 10:00:41" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_available_rewards_reminder": { "post": { "summary": "event_available_rewards_reminder", "description": "The available rewards reminder event occurs when the user earns enough points to redeem rewards.", "operationId": "eventAvailableRewardsReminderWebhook", "tags": [ "loyalty_system_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_available_rewards_reminder" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "reward_info": { "$ref": "#/components/schemas/RewardInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "638715523541f8001030bd4d", "total_count": 1, "events": [ { "id": "638715525efcad6bb4286b21", "event_type": "event_available_rewards_reminder", "data": { "member_info": { "id": "63871549f9e07600094f2310", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": [], "number_of_purchases": 2, "number_of_redemptions": 0, "birthdate": "08/26/1986 00:00:00", "enrollment_date": "11/30/2022 00:00:00", "last_modified_date": "11/30/2022 00:00:00", "first_purchase_date": "11/30/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "11/30/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "11/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 700, "loyalty_tier_id": "zrl_silver", "current_period_end": "11/30/2022 23:59:59" }, "referral_code": "RES3FQN9", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "lifetime_points_earned": 700, "lifetime_points_expired": 0, "available_points": 700, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "referral_URL": "https://zinrelo.com/ref/RES3FQN9", "custom_attributes": { "Gender": "Male", "Number of purchases": 1, "List of favourite place": [ "London", "Paris" ], "Review date": "12/10/2022 00:00:00" }, "revenue": 200, "aov": 5, "deleted_date": null }, "reward_info": { "count": 1, "rewards": [ { "reward_name": "$5 OFF COUPON", "enduser_reward_confirmation_html": "
_COUPON_CODE_
A copy of the code has been emailed to _USER_EMAIL_.
", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "enduser_reward_post_confirmation_html": "Go to the product page and add this product to cart. Apply the coupon code at checkout", "show_on_guest_dashboard": false, "last_modified_date": "11/17/2022 11:40:31", "is_active": true, "product_url": "https://john-mystore.myshopify.com/products/battlefield", "reward_sub_type": "Product Redemption", "eligible_tiers_list": [ "zrl_platinum", "zrl_gold", "zrl_silver" ], "created_date": "09/13/2022 11:06:54", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 500, "reward_type": "Coupon Based Rewards", "redemption_eligibility_criteria": "Tier Based", "id": "6320644e3ef462000ccca295", "reward_id": "reward_e562f", "product_id": "prod-01", "metadata": { "Category": "T-Shirt", "Location": "London", "Gender": "Male" } } ] } } } ], "created_date": "11/30/2022 08:33:22" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_points_expiration_reminder": { "post": { "summary": "event_points_expiration_reminder", "description": "The points expiration reminder occurs whenever a user's points are about to expire.", "operationId": "eventPointsExpirationReminderWebhook", "tags": [ "loyalty_system_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_points_expiration_reminder" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "expiry_info": { "$ref": "#/components/schemas/ExpiryInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "637cc4a7e332e9d94de7fd95", "total_count": 1, "events": [ { "id": "637cc4a8f674a0b9d34dcaed", "event_type": "event_points_expiration_reminder", "data": { "member_info": { "id": "637bb8ca6191c1000df60a78", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": "pointsexpiration", "number_of_purchases": 3, "number_of_redemptions": 0, "birthdate": "08/26/1986 00:00:00", "enrollment_date": "11/21/2022 00:00:00", "last_modified_date": "11/22/2022 00:00:00", "first_purchase_date": "11/21/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "11/22/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "11/01/2022 00:00:00", "loyalty_tier_name": "Gold", "qualified_points": 1600, "loyalty_tier_id": "zrl_gold", "current_period_end": "11/30/2022 23:59:59" }, "lifetime_points_earned": 3100, "lifetime_points_expired": 0, "available_points": 3100, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "number_of_referral_purchase": 0, "number_of_referral_share": 0, "referral_URL": "https://zinrelo.com/ref/UPD0ZJGL", "custom_attributes": { "Gender": "Male", "Number of purchases": 1, "List of favourite place": [ "London", "Paris" ], "Review date": "12/10/2022 00:00:00" }, "revenue": 300, "aov": 3.5, "deleted_date": null }, "expiry_info": { "expiration_date": "11/24/2022 00:00:00", "points": 3100, "days_to_expire": 2 } } } ], "created_date": "11/22/2022 12:46:31" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_rewards_within_reach_reminder": { "post": { "summary": "event_rewards_within_reach_reminder", "description": "The rewards within reach reminder event occurs whenever a user earns 80% of the required points to redeem the reward.", "operationId": "eventRewardsWithinReachReminderWebhook", "tags": [ "loyalty_system_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_rewards_within_reach_reminder" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "reward_info": { "$ref": "#/components/schemas/RewardInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "64880b23c111d90011ee4eb9", "total_count": 1, "events": [ { "id": "64880b2594832e4e92d871ae", "event_type": "event_rewards_within_reach_reminder", "data": { "member_info": { "id": "64880b215a684b000d281e1c", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "john.doe23", "member_status": "active", "member_tags": [ "rewardsreminder", "remindingrewards" ], "number_of_purchases": 1, "number_of_redemptions": 0, "birthdate": "08/26/1986 00:00:00", "enrollment_date": "06/13/2023 06:22:25", "last_modified_date": "06/13/2023 06:22:27", "first_purchase_date": "06/13/2023 06:22:26", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "06/13/2023 06:22:26", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "03/01/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 500, "loyalty_tier_id": "tier_silver", "current_period_end": "02/28/2023 23:59:59" }, "referral_code": "KES1HX1E", "lifetime_points_earned": 600, "lifetime_points_expired": 0, "available_points": 600, "points_onhold": 10, "lifetime_points_deducted": 0, "lifetime_points_redeemed": 0, "referral_URL": "https://zinrelo.com/ref/SAM02XIU", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "custom_attributes": { "City_Name": "Paris", "Marital_Status": "Married", "Income_Source": "Business", "Age_In_Years": "35", "Gender_Identity": "Male", "Graduation_Date": "03/12/2000 00:00:00" }, "revenue": 50, "aov": 70.2, "deleted_date": null }, "reward_info": { "count": 1, "rewards": [ { "enduser_reward_post_confirmation_html": "Go to the product page and add this product to cart. Apply the coupon code at checkout", "earning_period_operator": "Lifetime", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/86d0f83a4a99cc52c5cb04c4a4509bc2.jpeg", "implementation_type": "coupon_code", "is_active": true, "show_on_guest_dashboard": false, "last_modified_date": "11/29/2022 08:36:05", "points_earned": 1, "reward_name": "₹5 OFF COUPON", "id": "62e90f019396a278eb9baf66", "reward_sub_type": "Fixed Amount Discount", "created_date": "08/02/2022 11:48:17", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1500, "reward_type": "Coupon Based Rewards", "redemption_eligibility_criteria": "Points Based", "points_earned_operator": "Greater Than", "reward_id": "reward_c852d", "reward_value": "5", "metadata": { "Category": "T-Shirt", "Location": "London", "Gender": "Male" } } ] } } } ], "created_date": "06/13/2023 06:22:27" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_campaign_entered": { "post": { "summary": "event_campaign_entered", "description": "This event will occur when a member or members enter a campaign.", "operationId": "eventCampaignEnteredWebhook", "tags": [ "loyalty_campaign_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_campaign_entered" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "campaign_info": { "$ref": "#/components/schemas/CampaignInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "63be6cba1caba8442643bc17", "total_count": 1, "events": [ { "id": "63be6cba707f85cbe5b874e3", "event_type": "event_campaign_entered", "data": { "member_info": { "id": "6385e0e96c3148000beb356b", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "johndoe21", "member_status": "active", "member_tags": [ "incampaign", "entrycampaign" ], "number_of_purchases": 10, "number_of_redemptions": 1, "birthdate": "08/26/1989 00:00:00", "enrollment_date": "09/27/2022 00:00:00", "last_modified_date": "09/27/2022 00:00:00", "first_purchase_date": "10/26/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "12/29/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "12/29/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 500, "loyalty_tier_id": "zrl_silver", "current_period_end": "12/29/2023 00:00:00" }, "referral_code": "Anna286", "lifetime_points_earned": 10, "lifetime_points_expired": 0, "available_points": 100, "points_onhold": 10, "lifetime_points_deducted": 50, "lifetime_points_redeemed": 70, "referral_URL": "https://zinrelo.com/ref/JOH6FWL5", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "custom_attributes": { "Nationality": "Indian" }, "revenue": 115, "aov": null, "deleted_date": null }, "campaign_info": { "event_name": "Campaign Entries", "event_ID": "campaign_entry2457", "delay_in_days": 0, "campaign_name": "runningcampaign", "campaign_ID": "campaign_7744b", "promotion_info": { "promotion_id": "63bb91fcc88247000c83a868", "promotion_type": "no_action", "configuration_settings": null } } } } ] } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_campaign_exited": { "post": { "summary": "event_campaign_exited", "description": "This event will occur when a member or members exit a campaign.\n\n> **Note:**\n>\n> Currently, the \"tier_qualification_units\" field is not available for Salesforce Commerce Cloud (SFCC) plugin.", "operationId": "eventCampaignExitedWebhook", "tags": [ "loyalty_campaign_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_campaign_exited" ] }, "data": { "type": "object", "description": "The event's data.", "properties": { "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "campaign_info": { "$ref": "#/components/schemas/CampaignInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "63be6dfb071e220010516de6", "total_count": 1, "events": [ { "id": "63be6dfda74c1ca07736e435", "event_type": "event_campaign_exited", "data": { "member_info": { "id": "6385e0e96c3148000beb356b", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "phone_number": "+1-6507017759", "member_id": "johndoe21", "member_status": "active", "member_tags": [ "outofcampaign", "exitcampaign" ], "number_of_purchases": 10, "number_of_redemptions": 1, "birthdate": "08/26/1989 00:00:00", "enrollment_date": "09/27/2022 00:00:00", "last_modified_date": "09/27/2022 00:00:00", "first_purchase_date": "10/26/2022 00:00:00", "instagram_handle": "www.instagram.com/john", "last_purchase_date": "12/29/2022 00:00:00", "anniversary_date": "12/06/2014 00:00:00", "twitter_handle": "www.twitter.com/john", "preferred_language": "English", "deprecated_fields": { "user_id": "abgjdyo2" }, "tier_info": { "tier_qualification_units": 100, "current_period_start": "12/29/2022 00:00:00", "loyalty_tier_name": "Silver", "qualified_points": 500, "loyalty_tier_id": "zrl_silver", "current_period_end": "12/29/2023 00:00:00" }, "referral_code": "Anna286", "number_of_referral_purchase": 0, "number_of_referral_share": 0, "lifetime_points_earned": 10, "lifetime_points_expired": 0, "available_points": 100, "points_onhold": 10, "lifetime_points_deducted": 50, "lifetime_points_redeemed": 70, "referral_URL": "https://zinrelo.com/ref/JOH6FWL5", "custom_attributes": { "Nationality": "Indian" }, "revenue": 115, "aov": null, "deleted_date": null }, "campaign_info": { "delay_in_days": 0, "event_name": "exit", "campaign_ID": "campaign_7744b", "promotion_info": { "promotion_type": "no_action", "promotion_id": "63bb91fcc88247000c83a868", "configuration_settings": null }, "event_ID": "campaign_exited247", "campaign_name": "Exit Campaign" } } } ] } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_member_import_success": { "post": { "summary": "event_member_import_success", "description": "The Member Import Success event occurs when every row of a member import file was imported.", "operationId": "eventMemberImportSuccessWebhook", "tags": [ "loyalty_import_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_import_success" ] }, "data": { "type": "object", "description": "The event's data.", "required": [ "file_info" ], "properties": { "file_info": { "$ref": "#/components/schemas/FileInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_member_import_success", "data": { "file_info": { "file_name": "members_20260101.csv", "status": "success", "total_count": 10, "success_count": 10, "error_count": 0, "inserted_count": 6, "updated_count": 4, "erroneous_file_url": null, "processed_at": "01/01/2026 10:15:00" } } } ], "created_date": "01/01/2026 10:15:01" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_member_import_failure": { "post": { "summary": "event_member_import_failure", "description": "The Member Import Failure event occurs when a member import file finished processing with at least one row that couldn't be imported.", "operationId": "eventMemberImportFailureWebhook", "tags": [ "loyalty_import_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_member_import_failure" ] }, "data": { "type": "object", "description": "The event's data.", "required": [ "file_info" ], "properties": { "file_info": { "$ref": "#/components/schemas/FileInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_member_import_failure", "data": { "file_info": { "file_name": "members_20260101.csv", "status": "failure", "total_count": 10, "success_count": 7, "error_count": 3, "inserted_count": 5, "updated_count": 2, "erroneous_file_url": "https://example.com/imports/members_20260101_errors.csv", "processed_at": "01/01/2026 10:15:00" } } } ], "created_date": "01/01/2026 10:15:01" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_transaction_import_success": { "post": { "summary": "event_transaction_import_success", "description": "The Transaction Import Success event occurs when every row of a transaction import (batch) file was processed.", "operationId": "eventTransactionImportSuccessWebhook", "tags": [ "loyalty_import_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_transaction_import_success" ] }, "data": { "type": "object", "description": "The event's data.", "required": [ "file_info" ], "properties": { "file_info": { "$ref": "#/components/schemas/FileInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_transaction_import_success", "data": { "file_info": { "file_name": "transactions_20260101.csv", "status": "success", "total_count": 250, "success_count": 250, "error_count": 0, "erroneous_file_url": null, "processed_at": "01/01/2026 10:15:00" } } } ], "created_date": "01/01/2026 10:15:01" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_transaction_import_failure": { "post": { "summary": "event_transaction_import_failure", "description": "The Transaction Import Failure event occurs when a transaction import (batch) file finished processing with at least one row that couldn't be processed.", "operationId": "eventTransactionImportFailureWebhook", "tags": [ "loyalty_import_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_transaction_import_failure" ] }, "data": { "type": "object", "description": "The event's data.", "required": [ "file_info" ], "properties": { "file_info": { "$ref": "#/components/schemas/FileInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_transaction_import_failure", "data": { "file_info": { "file_name": "transactions_20260101.csv", "status": "failure", "total_count": 250, "success_count": 247, "error_count": 3, "erroneous_file_url": "https://example.com/imports/transactions_20260101_errors.csv", "processed_at": "01/01/2026 10:15:00" } } } ], "created_date": "01/01/2026 10:15:01" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_bulk_job_success": { "post": { "summary": "event_bulk_job_success", "description": "The Bulk Job Success event occurs when every record of a bulk job was processed.", "operationId": "eventBulkJobSuccessWebhook", "tags": [ "loyalty_job_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_bulk_job_success" ] }, "data": { "type": "object", "description": "The event's data.", "required": [ "job_info" ], "properties": { "job_info": { "$ref": "#/components/schemas/JobInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_bulk_job_success", "data": { "job_info": { "job_id": "6f1c2b7e-3f5a-4c1d-9b2e-0a8d7c6e5f41", "schema_slug": "purchases", "action": "create", "payload_type": "csv", "result_file_urls": [ "https://example.com/jobs/6f1c2b7e/results_1.csv" ], "status": "success", "started_at": "2026-07-17T12:00:00+00:00", "completed_at": "2026-07-17T12:00:05+00:00" } } } ], "created_date": "07/17/2026 12:00:05" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_bulk_job_failure": { "post": { "summary": "event_bulk_job_failure", "description": "The Bulk Job Failure event occurs when a bulk job completed with at least one record that couldn't be processed.", "operationId": "eventBulkJobFailureWebhook", "tags": [ "loyalty_job_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_bulk_job_failure" ] }, "data": { "type": "object", "description": "The event's data.", "required": [ "job_info" ], "properties": { "job_info": { "$ref": "#/components/schemas/JobInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_bulk_job_failure", "data": { "job_info": { "job_id": "6f1c2b7e-3f5a-4c1d-9b2e-0a8d7c6e5f41", "schema_slug": "purchases", "action": "create", "payload_type": "csv", "result_file_urls": [ "https://example.com/jobs/6f1c2b7e/results_1.csv" ], "status": "failure", "started_at": "2026-07-17T12:00:00+00:00", "completed_at": "2026-07-17T12:00:05+00:00" } } } ], "created_date": "07/17/2026 12:00:05" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_workflow_run_failure": { "post": { "summary": "event_workflow_run_failure", "description": "The Workflow Run Failure event occurs when a run of a workflow fails.", "operationId": "eventWorkflowRunFailureWebhook", "tags": [ "loyalty_workflow_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_workflow_run_failure" ] }, "data": { "type": "object", "description": "The event's data.", "required": [ "workflow_run_info" ], "properties": { "workflow_run_info": { "$ref": "#/components/schemas/WorkflowRunInfo" } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_workflow_run_failure", "data": { "workflow_run_info": { "workflow_id": "wf_8d2a6c1e", "workflow_run_id": "log_4b9e7f20", "status": "failed", "failed_at": "2026-07-17T12:00:00.123456+00:00", "errors": [ { "node_id": "node_3", "error": "Member not found" } ] } } } ], "created_date": "07/17/2026 12:00:05" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } }, "event_workflow_event": { "post": { "summary": "event_workflow_event", "description": "The Workflow event is sent by the webhook step of a workflow, to the webhooks chosen in that step, with the data configured in it.", "operationId": "eventWorkflowEventWebhook", "tags": [ "loyalty_workflow_events" ], "security": [], "parameters": [ { "$ref": "#/components/parameters/signature" }, { "$ref": "#/components/parameters/nonce" } ], "requestBody": { "required": true, "description": "A batch of one or more events of this type.", "content": { "application/json": { "schema": { "type": "object", "required": [ "request_id", "total_count", "created_date", "events" ], "properties": { "request_id": { "$ref": "#/components/schemas/WebhookRequestId" }, "total_count": { "$ref": "#/components/schemas/WebhookTotalCount" }, "created_date": { "$ref": "#/components/schemas/WebhookCreatedDate" }, "events": { "type": "array", "description": "The events in this batch.", "items": { "type": "object", "required": [ "id", "event_type", "data" ], "properties": { "id": { "$ref": "#/components/schemas/WebhookEventId" }, "event_type": { "type": "string", "description": "The type of event.", "enum": [ "event_workflow_event" ] }, "data": { "type": "object", "description": "The event's data: the member the workflow ran for, and the data and metadata configured in the workflow's webhook step, filled in with the values of that run.", "required": [ "event_type", "member_info", "event_data" ], "properties": { "event_type": { "type": "string", "enum": [ "event_workflow_event" ] }, "member_info": { "$ref": "#/components/schemas/MemberInfo" }, "event_data": { "type": "object", "description": "The data configured in the workflow's webhook step, with its placeholders replaced.", "additionalProperties": true }, "event_metadata": { "type": [ "object", "null" ], "description": "The metadata configured in the workflow's webhook step, if any, with its placeholders replaced.", "additionalProperties": true } } } } } } } }, "examples": { "example1": { "summary": "Payload", "value": { "request_id": "6a0f2c1e4f8f0345970b6d96", "total_count": 1, "events": [ { "id": "6a0f2c1e4f8f0345970b6d99", "event_type": "event_workflow_event", "data": { "event_type": "event_workflow_event", "member_info": { "id": "john286", "first_name": "John", "last_name": "Doe", "email_address": "johndoe@gmail.com", "member_id": "john.doe23", "member_status": "active", "available_points": 5000 }, "event_data": { "first_name": "John", "points": 100, "workflow_path": "online_purchase" }, "event_metadata": { "hook_type": "Online Purchase", "unique_id": "Online_purchase_1" } } } ], "created_date": "07/17/2026 12:00:05" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/acknowledged" }, "default": { "$ref": "#/components/responses/retried" } } } } }, "components": { "securitySchemes": { "api_key": { "type": "apiKey", "in": "header", "name": "api-key", "description": "An API key of your program. Admin API only." }, "access_token": { "type": "apiKey", "in": "header", "name": "access-token", "description": "A JSON Web Token (JWT) signed with an API key, identifying the logged-in member. UI API only." }, "partner_id": { "type": "apiKey", "in": "header", "name": "partner-id", "description": "Your program's partner ID." } }, "schemas": { "ui-eligible-activities-points-config-object": { "description": "The points configuration setup for the activity.", "type": "object", "properties": { "points_computation_type": { "description": "

Points computation provides information about how the base points for various activities within our program are calculated, encompassing multiple fields within the points config.

\r\n

 

\r\n

For certain activities like 'Share On Facebook' and 'Write a Review' within our program, a fixed set of points is allocated upon completion. In these instances, the points computation type is designated as \"fixed.\" The points configuration includes an additional field specifying the exact number of fixed points awarded upon successful activity completion. For instance:

\r\n

{
 \"points\": 100,
 \"points_computation_typ\": “fixed_points”
 }

\r\n

Conversely, some activities such as  'Purchase on Website' and 'Submit a Receipt' within our program grant points based on multiples of a particular value. For instance, when a purchase is made on the website, points are awarded in multiples of the order subtotal. This scenario falls under the points computation type \"multiplier_based.\" The points configuration contains a \"multiplier\" field and attribute, utilized to multiply the awarded points based on the specified value.

\r\n

{
 \"multiplier\": 2,
 “attribute_to_multiply”: “order_subtotal”
 \"points_computation_type\": “multiplier_based”
 }

\r\n

However, certain activities within the program do not provide any points. These instances occur when the benefit type solely involves coupons. In such cases, the points configuration remains empty, rendering points computation unavailable.

", "type": "string" }, "attribute_to_multiply": { "description": "If points_computation_type is multiplier based then points config will have attribute_to_multiply and multiplier field along with points_computation_type.\r\nAttribute to multiply can have different fields based on activity id. For example-\r\n- made_a_purchase actvity will have order_subtotal\r\n- submit_a_receipt activity will have receipt_order_value\r\n\r\nFor referral activity based on referrer_payoff_type attribute will have different attribute to multiply fields such as:\r\n\r\n- percent_purchase_points referrer payoff type will have purchase_points\r\n- percent_order_value referrer payoff type will have order_value\r\n\r\n\r\n\r\n", "type": "string" }, "multiplier": { "format": "int32", "description": "The digit that will be multiplied.", "type": "integer" } }, "example": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 } }, "eligible-activities-extra-config-object": { "description": "", "type": "object", "properties": { "share_current_page_url": { "description": "The shared url for Facebook/ Pinterest.", "type": "boolean" }, "pin_post_image": { "description": "The image for a Pinterest post. This can be uploaded through the admin console on the Activity Setting page by using the 'Post Image' feature.", "type": "string" }, "pin_post_description": { "description": "The description for 'Share on Pinterest' can be set within the admin console by adjusting the text within the 'Post Description' text box.", "type": "string" }, "max_award_frequency_error_text": { "description": "The error message displayed when a member exceeds the defined frequency limit.", "type": "string" }, "personal_handle_edit_button_text": { "description": "The text displayed on the button for editing the personal handle.", "type": "string" }, "duplicate_handle_error_text": { "description": "The message shown when a member attempts to submit a duplicate handle for Instagram or TikTok.", "type": "string" }, "personal_handle_submit_button_text": { "description": "The text displayed on the button for submit the personal handle.", "type": "string" }, "handle_required_alert_text": { "description": "The alert message displayed when an Instagram or TikTok handle is required but has not been provided.", "type": "string" }, "activity_start_button_text": { "description": "The text displayed on the start button for Instagram or TikTok activities.", "type": "string" }, "failure_text": { "description": "The message displayed when an issue occurs or an operation fails.", "type": "string" }, "thank_you_text": { "description": "The thank message including details about the points a member will earn.", "type": "string" }, "cancel_button_text": { "description": "The text displayed on the cancel button for Instagram or TikTok activities.", "type": "string" }, "excluded_transaction_error_text": { "description": "The text displayed on exclusion rule for Instagram or TikTok activities.", "type": "string" }, "enter_handle_prompt_text": { "description": "The description text to enter Instagram or TikTok handle.", "type": "string" }, "personal_handle_input_text": { "description": "The input text for Instagram or TikTok handle.", "type": "string" }, "blocked_handle_error_text": { "description": "The message displayed when a blocked Instagram or TikTok handle is submitted.", "type": "string" }, "name_header_text": { "description": "The activity header text displayed in end user dashboard for Instagram or TikTok activities. ", "type": "string" }, "enter_handle_placeholder_text": { "description": "The placeholder text to enter the TikTok or Instagram.", "type": "string" }, "edit_handle_text": { "description": "The text displayed on end user dashboard to edit Instagram or TikTok handle.", "type": "string" }, "business_handle_display_text": { "description": "The display text for business handle.", "type": "string" }, "business_instagram_username": { "description": "The username of the Instagram user.", "type": "string" } }, "example": { "share_current_page_url": false, "pin_post_image": "", "pin_post_description": "Awesome products at great prices. You should really check them out.", "business_instagram_username": "pallavi" } }, "ui-eligible-activities-activity-object": { "description": "", "type": "object", "properties": { "points_config": { "$ref": "#/components/schemas/ui-eligible-activities-points-config-object" }, "activity_id": { "description": "The unique ID of the activity assigned by TrueLoyal. ", "type": "string" }, "enduser_activity_description_html": { "description": "\"Points earning description HTML\" configuration in TrueLoyal admin console.", "type": "string" }, "activity_card_background_image_url": { "description": "\"Activity Tile Image\" configuration in TrueLoyal admin console.", "type": "string" }, "is_qualified_for_tier_upgrade": { "description": "The activity qualifies for a tier upgrade. ", "type": "boolean" }, "last_modified_date": { "description": "The most recent date on which a transaction was updated.", "type": "string" }, "metadata": { "description": "The metadata associated with an activity.", "type": "object", "properties": { "Category": { "type": "string" } } }, "enduser_activity_short_description": { "description": "\"Description\" configuration in TrueLoyal admin console.", "type": "string" }, "created_date": { "description": "The date and time on which the transaction was created.", "type": "string" }, "activity_name": { "description": "The activity name stored with TrueLoyal.", "type": "string" }, "is_points_expiry_reset_activity": { "description": "The activity which resets expiry. To check and configure it, navigate to Program Settings>> Points Expiration.", "type": "boolean" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "activity_benefit_type": { "description": "Activity benefit type is based on activity_type”\r\n\r\n- For 'fixed' activity types, the benefit type is 'points.'\r\n- For 'fixed and coupon-based' activity types, the benefit type is 'points_and_coupon_code.'\r\n- When the activity type is 'bonus_multiplier,' the benefit type is 'points.'\r\n- For 'bonus and coupon-based' activity types, the benefit type is 'points_and_coupon_code.'\r\n- For 'coupon-based' activity types, the benefit type is 'coupon_based.'\"\r\n\r\nPlease Note: For coupon_based activity, the points_config will be empty.", "type": "string" }, "extra_config": { "$ref": "#/components/schemas/eligible-activities-extra-config-object" } } }, "ui-eligible-activities-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "eligible-rewards-reward-object": { "description": "", "type": "object", "properties": { "reward_name": { "description": "The reward name stored with TrueLoyal.", "type": "string" }, "enduser_reward_confirmation_html": { "description": "\"Redemption Confirmation Text\" configuration in TrueLoyal admin console.", "type": "string" }, "reward_card_background_image_url": { "description": "\"Reward Tile Image\" configuration in TrueLoyal admin console.", "type": "string" }, "implementation_type": { "description": "By default, all our rewards are coupon-based. However, we also support add-to-cart rewards.", "type": "string" }, "reward_value": { "description": "The reward value configured in TrueLoyal.", "type": "string" }, "last_modified_date": { "description": "The recent date and time on which the reward configuration was updated.", "type": "string" }, "reward_sub_type": { "description": "These are the reward types we offer: Fixed amount discount, Free shipping, Product redemption, and Percentage discount.", "type": "string" }, "created_date": { "description": "The date and time on which the reward was created.", "type": "string" }, "enduser_reward_short_description": { "description": "\"End User Reward Description\" configuration in TrueLoyal admin console.", "type": "string" }, "points_to_be_redeemed": { "format": "int32", "description": "The points to be deducted when the reward is redeemed.", "type": "integer" }, "reward_type": { "description": "All our rewards are coupon-based.", "type": "string" }, "enduser_reward_post_confirmation_html": { "description": "\"Post Redemption HTML\" configuration in TrueLoyal admin console.", "type": "string" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "reward_id": { "description": "The unique ID of the reward assigned by TrueLoyal. ", "type": "string" }, "metadata": { "description": "The metadata associated with the reward.", "type": "object", "properties": { "Category": { "type": "string" }, "Brand": { "type": "string" } } } }, "example": { "reward_name": "$10 Gift Certificate Netsuite", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "5", "last_modified_date": "07/07/2023 10:49:41", "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:39", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 500, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3b8152252216f5c1ad", "reward_id": "reward_bc668", "metadata": { "Category": "Limited time", "Brand": "Nescafe" } } }, "ui-eligible-rewards-response-object": { "description": "", "type": "object", "properties": { "total": { "format": "int32", "description": "The total number of eligible rewards.", "type": "integer" }, "next_cursor": { "format": "int32", "description": "This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "type": "integer" }, "more": { "type": "boolean" }, "rewards": { "$ref": "#/components/schemas/eligible-rewards-reward-object", "description": "" } }, "example": { "total": 4, "rewards": [ { "reward_name": "$10 Gift Certificate Netsuite", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "5", "last_modified_date": "07/07/2023 10:49:41", "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:39", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 500, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3b8152252216f5c1ad", "reward_id": "reward_bc668", "metadata": { "Category": "Limited time", "Brand": "Nescafe" } }, { "reward_name": "$10 OFF COUPON Miva", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "10", "last_modified_date": "07/07/2023 10:49:43", "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:41", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1000, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3d8152252216f5c1b0", "reward_id": "reward_a1e91", "metadata": { "Category": "Miva", "Brand": "Nescafe", "Products Eligible": "Shirt, T-Shirt, Pants" } }, { "reward_name": "Points Adjustment", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "5", "last_modified_date": "05/23/2023 12:30:11", "reward_sub_type": "Custom Reward", "created_date": "03/08/2022 05:26:27", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1000, "reward_type": "Flexible Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "6226e90399b4e16ce3af0320", "reward_id": "reward_916d9", "metadata": {} }, { "reward_name": "$15 OFF COUPON", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "10", "last_modified_date": "07/06/2023 05:20:05", "reward_sub_type": "Percentage Discount", "created_date": "03/15/2021 12:59:42", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1400, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3e8152252216f5c1b3", "reward_id": "reward_9c350", "metadata": {} } ], "next_cursor": 100, "more": false } }, "ui-eligible-rewards-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "ui-redeem-request-body": { "description": "Unique ID that identifies a reward in TrueLoyal. This is the ID of the reward against which the redemption transaction has to be recorded.", "required": [ "reward_id" ], "type": "object", "properties": { "reward_id": { "description": "Unique ID that identifies a reward in TrueLoyal. This is the ID of the reward against which the redemption transaction has to be recorded.", "type": "string" }, "points_to_be_redeemed": { "description": "REQUIRED: only for flexible redemption. This is the number of points to be redeemed.", "type": "integer" }, "status": { "description": "Pass the redemption status—approved or pending. If no entry is passed, the transaction will be redeemed, and its status will be approved.\n Note: This feature is applicable only for Shopify supported stores." } } }, "redeem-transaction-attributes-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason for making transaction.", "type": "string" } }, "example": { "reason": "pointsredeemed" } }, "ui-redeem-reward-info-object": { "description": "", "type": "object", "properties": { "reward_name": { "description": "The name of the reward stored in TrueLoyal.", "type": "string" }, "points_status": { "description": "The status of the points- 'redeemed,' redemption_pending' or 'redemption_cancelled.'", "type": "string" }, "coupon_code": { "description": "The coupon code used for redemption.", "type": "string" }, "reward_link": { "description": "The link to flexi reward. Instead of asking members to choose from a fixed set of rewards, loyalty points can be used as a currency and members can redeem any number of points they have from their account for a corresponding discount on their transactions. ", "type": "string" }, "reward_id": { "description": "The unique reward ID assigned by TrueLoyal. ", "type": "string" }, "points": { "format": "int32", "description": "The number of points redeemed by the member.", "type": "integer" } }, "example": { "reward_name": "$5 OFF COUPON", "points_status": "redeemed", "coupon_code": "3193E86A", "reward_id": "reward_bc668", "points": 500 } }, "ui-redeem-response-object": { "description": "", "type": "object", "properties": { "status": { "description": "The redemption status- approved or pending. ", "type": "string" }, "transaction_attributes": { "$ref": "#/components/schemas/redeem-transaction-attributes-object" }, "last_modified_date": { "description": "The recent date on which the reward configuration was updated.", "type": "string" }, "member_id": { "description": "The unique identifier of the member defined by an Admin.", "type": "string" }, "approved_date": { "description": "The date on which the reward was approved.", "type": "string" }, "reward_info": { "$ref": "#/components/schemas/ui-redeem-reward-info-object" }, "transaction_type": { "description": "The type of transaction.", "type": "string" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "created_date": { "description": "The date on which the reward was created.", "type": "string" } }, "example": { "status": "approved", "transaction_attributes": { "reason": "pointsredeemed" }, "last_modified_date": "08-Aug-2023 06:04:37", "member_id": "johndoe@gmail.com", "approved_date": "08-Aug-2023 06:04:37", "reward_info": { "reward_name": "$5 OFF COUPON", "points_status": "redeemed", "coupon_code": "3193E86A", "reward_id": "reward_bc668", "points": 500 }, "transaction_type": "redeem", "id": "64d1daf5339122000c4c3c0a", "created_date": "08-Aug-2023 06:04:37" } }, "ui-redeem-data-object": { "description": "", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ui-redeem-response-object" }, "success": { "type": "boolean" } }, "example": { "data": { "status": "approved", "transaction_attributes": { "reason": null }, "last_modified_date": "11-Mar-2025 11:27:03", "additional_data": {}, "approved_date": "11-Mar-2025 11:27:03", "reward_info": { "reward_name": "$10 Gift Certificate Netsuite", "points_status": "redeemed", "coupon_code": "41EAE010", "reward_link": null, "reward_id": "reward_bc668", "points": 100 }, "member_id": "pallavi+095@zinrelo.com", "transaction_type": "redeem", "id": "67d01e07adb896d71d81ccdb", "created_date": "11-Mar-2025 11:27:03" }, "success": true } }, "ui-redeem-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "retrieve-member-tier-objects": { "description": "", "type": "object", "properties": { "current_period_start": { "description": "The start date of the current tier cycle.", "type": "string" }, "loyalty_tier_name": { "description": "The name of the current tier.", "type": "string" }, "loyalty_tier_id": { "description": "The unique tier ID stored in TrueLoyal.", "type": "string" }, "current_period_end": { "description": "The end date of current tier cycle.", "type": "string" }, "qualified_points": { "format": "int32", "description": "The qualified points for tier calculation.", "type": "integer" } }, "example": { "current_period_start": "04/01/2023", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "04/01/2024", "qualified_points": 793 } }, "retrieve-member-points-expiration-schedule": { "description": "", "type": "object", "properties": { "expiration_date": { "description": "The expiration date of the available points.", "type": "string" }, "points": { "format": "int32", "description": "The total number of points that will expire.", "type": "integer" } }, "example": { "expiration_date": "5-Mar-2024 00:00:00", "points": 101 } }, "retrieve-member-address-object": { "description": "", "type": "object", "properties": { "city": { "description": "Member's city.", "type": "string" }, "country": { "description": "Member's country.", "type": "string" }, "line2": { "description": "The member address.", "type": "string" }, "line1": { "description": "The member address.", "type": "string" }, "state": { "description": "Member's state.", "type": "string" }, "postal_code": { "description": "Member's postal code.", "type": "string" } }, "example": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "" } }, "ui-retrieve-member-member-object": { "description": "", "type": "object", "properties": { "last_name": { "description": "The last name of the member.", "type": "string" }, "twitter_handle": { "description": "The twitter handle of the member.", "type": "string" }, "lifetime_points_expired": { "format": "int32", "description": "The total points expired from a member's account since he joined the program.", "type": "integer" }, "last_modified_date": { "description": "The most recent date on which a member's profile was updated.", "type": "string" }, "available_points": { "format": "int32", "description": "The avaliable points of the member.", "type": "integer" }, "pending_points": { "format": "int32", "description": "The pending points of the member.", "type": "integer" }, "lifetime_points_earned": { "format": "int32", "description": "The total points earned in a member's account since he joined the program.", "type": "integer" }, "referral_URL": { "description": "The unique referral url of the member.", "type": "string" }, "member_status": { "description": "The current status of the member- ‘active’ , ‘blocked’, ‘opted_out’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program. ", "type": "string" }, "referral_code": { "description": "The unique referral code of the member.", "type": "string" }, "email_address": { "description": "The email address of the member.", "type": "string" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "first_name": { "description": "The first name of the member.", "type": "string" }, "member_tags": { "description": "The tags assocaited with a member.", "type": "array", "items": { "type": "string" } }, "tier_info": { "$ref": "#/components/schemas/retrieve-member-tier-objects" }, "first_purchase_date": { "description": "The first purchase date of the member.", "type": "string" }, "lifetime_points_deducted": { "format": "int32", "description": "The total points deducted from a member's account since he joined the program.", "type": "integer" }, "phone_number": { "description": "The phone number of the member.", "type": "string" }, "points_expiration_schedule": { "type": "array", "items": { "$ref": "#/components/schemas/retrieve-member-points-expiration-schedule" } }, "instagram_handle": { "description": "The instagram handle of the member.", "type": "string" }, "address": { "$ref": "#/components/schemas/retrieve-member-address-object" }, "last_purchase_date": { "description": "The last purchase made by a member.", "type": "string" }, "lifetime_points_redeemed": { "format": "int32", "description": "The total points redeemed from a member's account since he joined the program.", "type": "integer" }, "preferred_language": { "description": "The preferred language of the member.", "type": "string" }, "number_of_purchases": { "format": "int32", "description": "The number of purchases made by a member.", "type": "integer" }, "number_of_redemptions": { "format": "int32", "description": "The number of redemptions made by a member.", "type": "integer" }, "birthdate": { "description": "Birthdate of the loyalty member. \r\nExpected date format: MM/DD/YYYY or MM/DD\r\nIrrespective of the year passed, 1904 will be set as a default value. \r\n", "type": "string" }, "anniversary_date": { "description": "The anniversary date of the member. Expected date format: MM/DD/YYYY or MM/DD\r\nIn case, where a year has not been passed the default year will be set as 1904.\r\n", "type": "string" }, "enrollment_date": { "description": "The date on which the member joined the loyalty program.", "type": "string" }, "member_id": { "description": "The unique identifier of the member defined by an Admin.", "type": "string" }, "email_subscription_status": { "description": "The subscription status of the email. If ‘unsubscribed’, the member will not receive any email notifications triggered by TrueLoyal. Default value is ‘subscribed’.", "type": "string" } }, "example": { "last_name": "Doe", "twitter_handle": "www.twitter.com/john", "lifetime_points_expired": 893, "last_modified_date": "07/14/2023 11:11:04", "available_points": 0, "pending_points": 200, "lifetime_points_earned": 893, "referral_URL": "https://www.zinrelo.com/ref/JOH30AOQ", "member_status": "active", "referral_code": "JOHL30AOQ", "email_address": "johndoe@gmail.com", "id": "64898298c7f196000b000091", "first_name": "John", "member_tags": [ "memberretrieve", "retrievedmember" ], "tier_info": { "current_period_start": "04/01/2023", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "04/01/2024", "qualified_points": 793 }, "first_purchase_date": "06/14/2023", "lifetime_points_deducted": 0, "phone_number": "+1-65070177596", "points_expiration_schedule": [ { "expiration_date": "5-Mar-2024 00:00:00", "points": 101 } ], "instagram_handle": "www.instagram.com/john", "address": { "city": "Superior", "country": "US", "line2": "", "line1": "1000 S. McCaslin Blvd., Suite 301", "state": "CO", "postal_code": "" }, "last_purchase_date": "06/29/2023", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 2, "number_of_redemptions": 0, "birthdate": "01/31/1900", "anniversary_date": "07/07/2021", "enrollment_date": "06/14/2023 09:04:24", "member_id": "greatMRT040401", "email_subscription_status": "subscribed" } }, "ui-retrieve-member-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "update-loyalty-member-request-body": { "description": "", "type": "object", "properties": { "birthdate": { "description": "Birthdate of the loyalty member. Format : \nNote: Our API records all date and time fields in UTC time.", "type": "string", "example": "08/26/1979" }, "anniversary_date": { "description": "Wedding anniversary date of the loyalty member. Format : \r\n\r\nNote: Our API records all date and time fields in UTC time.", "type": "string", "example": "12/06/2020" }, "twitter_handle": { "description": "Twitter username of the loyalty member.", "type": "string" }, "instagram_handle": { "description": "Instagram username of the loyalty member.", "type": "string" }, "email_subscription_status": { "description": "Values can be ‘subscribed’ or ‘unsubscribed’ . If ‘unsubscribed’, this member will not receive any email notifications triggered by TrueLoyal.", "type": "string" }, "member_status": { "description": "Accepted values in the request are ‘active’ and ‘opted_out’. Default is ‘active’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program. \r\n\r\nopted_out member can become active by passing member_status as 'active'." } } }, "update-loyalty-member-tier-info-object": { "description": "", "type": "object", "properties": { "current_period_start": { "description": "The start date of the current tier cycle.", "type": "string" }, "loyalty_tier_name": { "description": "The name of the current tier.", "type": "string" }, "loyalty_tier_id": { "description": "The unique tier ID stored in TrueLoyal.", "type": "string" }, "current_period_end": { "description": "The end date of current tier cycle.", "type": "string" }, "qualified_points": { "format": "int32", "description": "The qualified points for tier calculation.", "type": "integer" } }, "example": { "current_period_start": "03/01/2022", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023", "qualified_points": 1000 } }, "update-loyalty-member-points-expiration-object": { "description": "", "type": "object", "properties": { "expiration_date": { "description": "The expiration date of the available points.", "type": "string" }, "points": { "format": "int32", "description": "The total number of points that will expire.", "type": "integer" } }, "example": { "expiration_date": "5-Mar-2024 00:00:00", "points": 101 } }, "update-loyalty-member-address-object": { "description": "", "type": "object", "properties": { "city": { "description": "Member's city.", "type": "string" }, "country": { "description": "Member's country.", "type": "string" }, "line2": { "description": "The member address.", "type": "string" }, "line1": { "description": "The member address.", "type": "string" }, "state": { "description": "Member's state.", "type": "string" }, "postal_code": { "description": "Member's postal code.", "type": "string" } }, "example": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" } }, "ui-update-loyalty-member-response-body": { "description": "", "type": "object", "properties": { "last_name": { "description": "The last name of the member.", "type": "string" }, "twitter_handle": { "description": "The twitter handle of the member.", "type": "string" }, "lifetime_points_expired": { "format": "int32", "description": "The total points expired from a member's account since he joined the program.", "type": "integer" }, "last_modified_date": { "description": "The most recent date on which a member's profile was updated.", "type": "string" }, "available_points": { "format": "int32", "description": "The avaliable points of the member.", "type": "integer" }, "pending_points": { "format": "int32", "description": "The pending points of the member.", "type": "integer" }, "lifetime_points_earned": { "format": "int32", "description": "The total points earned in a member's account since he joined the program.", "type": "integer" }, "referral_URL": { "description": "The unique referral url of the member.", "type": "string" }, "member_status": { "description": "The current status of the member- ‘active’ , ‘blocked’, ‘opted_out’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program. ", "type": "string" }, "referral_code": { "description": "The unique referral code of the member.", "type": "string" }, "email_address": { "description": "The email address of the member.", "type": "string" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "first_name": { "description": "The first name of the member.", "type": "string" }, "member_tags": { "description": "The tags assocaited with a member.", "type": "array", "items": { "type": "string" } }, "tier_info": { "$ref": "#/components/schemas/update-loyalty-member-tier-info-object" }, "first_purchase_date": { "description": "The first purchase date of the member.", "type": "string" }, "lifetime_points_deducted": { "format": "int32", "description": "The total points deducted from a member's account since he joined the program.", "type": "integer" }, "phone_number": { "description": "The phone number of the member.", "type": "string" }, "points_expiration_schedule": { "type": "array", "items": { "$ref": "#/components/schemas/update-loyalty-member-points-expiration-object" } }, "instagram_handle": { "description": "The instagram handle of the member.", "type": "string" }, "address": { "$ref": "#/components/schemas/update-loyalty-member-address-object" }, "last_purchase_date": { "description": "The last purchase made by a member.", "type": "string" }, "lifetime_points_redeemed": { "format": "int32", "description": "The total points redeemed from a member's account since he joined the program.", "type": "integer" }, "preferred_language": { "description": "The preferred language of the member.", "type": "string" }, "number_of_purchases": { "format": "int32", "description": "The number of purchases made by a member.", "type": "integer" }, "number_of_redemptions": { "format": "int32", "description": "The number of redemptions made by a member.", "type": "integer" }, "birthdate": { "description": "Birthdate of the loyalty member. \r\nExpected date format: MM/DD/YYYY or MM/DD\r\nIrrespective of the year passed, 1904 will be set as a default value. \r\n", "type": "string" }, "anniversary_date": { "description": "The anniversary date of the member. Expected date format: MM/DD/YYYY or MM/DD\r\nIn case, where a year has not been passed the default year will be set as 1904.\r\n", "type": "string" }, "enrollment_date": { "description": "The date on which the member joined the loyalty program.", "type": "string" }, "member_id": { "description": "The unique identifier of the member defined by an Admin.", "type": "string" }, "email_subscription_status": { "description": "The subscription status of the email. If ‘unsubscribed’, the member will not receive any email notifications triggered by TrueLoyal. Default value is ‘subscribed’.", "type": "string" } }, "example": { "last_name": "Doe", "twitter_handle": "www.twitter.com/john", "lifetime_points_expired": 893, "last_modified_date": "09/01/2023 05:10:16", "available_points": 0, "pending_points": 0, "lifetime_points_earned": 893, "referral_URL": "https://www.zinrelo.com/ref/JOH30AOQ", "member_status": "active", "referral_code": "JOH30AOQ", "email_address": "johndoe@gmail.com", "id": "64898298c7f196000b000091", "first_name": "John", "member_tags": [ "memberadded", "membercreated" ], "tier_info": { "current_period_start": "03/01/2022", "loyalty_tier_name": "Silver", "loyalty_tier_id": "zrl_silver", "current_period_end": "02/28/2023", "qualified_points": 1000 }, "first_purchase_date": "06/14/2023", "lifetime_points_deducted": 0, "phone_number": "+1-6507017759", "points_expiration_schedule": [ { "expiration_date": "7-Feb-2024 00:00:00", "points": 10000 } ], "instagram_handle": "www.instagram.com/john", "address": { "city": "Palo Alto", "country": "US", "line2": "530 Lytton Ave", "line1": "Suite #200", "state": "CA", "postal_code": "94301" }, "last_purchase_date": "06/29/2023", "lifetime_points_redeemed": 0, "preferred_language": "english", "number_of_purchases": 2, "number_of_redemptions": 0, "birthdate": "08/26/1900", "anniversary_date": "12/06/2020", "enrollment_date": "06/14/2023 09:04:24", "member_id": "john+11", "email_subscription_status": "subscribed" } }, "ui-update-loyalty-member-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "activity-track-codes-response-object": { "description": "", "type": "object", "properties": { "track_code": { "description": "To track the source of the content shared on social sites like Instagram, Facebook, Twitter, and Pinterest.", "type": "string" } }, "example": { "track_code": "qpqlp5igp9zPoqfJzdCrnKOql86irZmkp5mjprHK0tPh0tDdztDh1NfrrJmgpZKcqKebn5KVoKmvn6imnZqhrp6kopo=" } }, "activity-track-codes-data-object": { "description": "", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/activity-track-codes-response-object" }, "success": { "type": "boolean" } }, "example": { "data": { "track_code": "qpqlp5igp9zPoqfJzdCrnKOql86irZmkp5mjprHK0tPh0tDdztDh1NfrrJmgpZKcqKebn5KVoKmvn6imnZqhrp6kopo=" }, "success": true } }, "ui-activity-track-codes-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "list-member-transactions-award-info": { "description": "These data are system-defined for award transactions.", "type": "object", "properties": { "activity_id": { "description": "The unique ID of the activity assigned by TrueLoyal. ", "type": "string" }, "points": { "format": "int32", "description": "The number of points awarded for performing the activity.", "type": "integer" }, "points_status": { "description": "The status of the points- 'pending', 'approved', 'rejected', 'auto_approved', 'auto_rejected', 'expired' or 'exhausted.'", "type": "string" }, "activity_name": { "description": "The activity name stored with TrueLoyal.", "type": "string" } }, "example": { "activity_id": "winback_bonus", "points": 100, "points_status": "approved", "activity_name": "Winback Bonus" } }, "list-member-transactions-transaction-attributes": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason for making transaction.", "type": "string" }, "order_id": { "description": "The unique ID associated with the placed order. This is system defined transaction attribute for \"made_a_purchase\" activity.", "type": "string" }, "coupon_code": { "description": "The coupon code used for the purchase of the product. This is system defined transaction attribute for \"made_a_purchase\" activity.", "type": "string" }, "receipt_file_url": { "description": "The url of the uploaded receipt. This is system defined field for \"submit_a_receipt\" activity. ", "type": "array", "items": { "type": "string" } } }, "example": { "reason": "cartabondoned", "order_id": "7587746", "coupon_code": "$5OFFVYZ", "receipt_file_url": [ "https://zinrelo-receipt-uploads.s3.amazonaws.com/c944754e96693d3cce82bc3ebcda9f9e.jpg" ] } }, "list-member-transactions-deduct-info": { "description": "These data are system-defined for deduct transactions.", "type": "object", "properties": { "points": { "format": "int32", "description": "The number of points deducted from the available points.", "type": "integer" }, "points_status": { "description": "The status of the points- 'deducted' or 'pending_deduction.'", "type": "string" } }, "example": { "points": 10, "points_status": "deducted" } }, "list-member-transactions-reward-info": { "description": "These data are system-defined for reward transactions.", "type": "object", "properties": { "reward_name": { "description": "The name of the reward stored in TrueLoyal.", "type": "string" }, "points_status": { "description": "The status of the points- 'redemption_pending' or 'redemption_cancelled.'", "type": "string" }, "coupon_code": { "description": "The coupon code used for redemption.", "type": "string" }, "reward_link": { "description": "The link to flexi reward. Instead of asking members to choose from a fixed set of rewards, loyalty points can be used as a currency and members can redeem any number of points they have from their account for a corresponding discount on their transactions. ", "type": "string" }, "reward_id": { "description": "The unique reward ID assigned by TrueLoyal. ", "type": "string" }, "points": { "format": "int32", "description": "The number of points redeemed by the member.", "type": "integer" } }, "example": { "reward_name": "$5 OFF COUPON", "points_status": "redeemed", "coupon_code": "3193E86A", "reward_id": "reward_bc668", "points": 500 } }, "list-member-transactions-transaction-object": { "description": "", "type": "object", "properties": { "status": { "description": "The transaction status- approved/ rejected/ pending.", "type": "string" }, "auto_approval_date": { "description": "The date and time on which the transaction will be auto-approved. It can be configured through the Admin Console > Activities > Settings > Approval Type. This is a system-defined field for award transactions.", "type": "string" }, "last_modified_date": { "description": "The most recent date on which a transaction was updated.", "type": "string" }, "award_info": { "$ref": "#/components/schemas/list-member-transactions-award-info", "description": "These data are system-defined for award transactions." }, "member_id": { "description": "The unique identifier of the member defined by an Admin.", "type": "string" }, "points_expiration_date": { "description": "The date and time when points expire.", "type": "string" }, "approved_date": { "description": "The date and time on which the transaction will be approved. ", "type": "string" }, "created_date": { "description": "The date and time on which the transaction was created.", "type": "string" }, "transaction_type": { "description": "The type of transaction- award, redeem or deduct.", "type": "string" }, "transaction_attributes": { "$ref": "#/components/schemas/list-member-transactions-transaction-attributes" }, "id": { "description": "The unique internal ID generated by TrueLoyal.", "type": "string" }, "deduct_info": { "$ref": "#/components/schemas/list-member-transactions-deduct-info", "description": "These data are system-defined for deduct transactions." }, "reward_info": { "$ref": "#/components/schemas/list-member-transactions-reward-info", "description": "These data are system-defined for reward transactions." } }, "example": { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:11:20", "award_info": { "activity_id": "winback_bonus", "points": 100, "points_status": "approved", "activity_name": "Winback Bonus" }, "member_id": "johndoe", "points_expiration_date": "13-Sep-2023 00:00:00", "approved_date": "12-Sep-2023 10:11:20", "created_date": "12-Sep-2023 10:11:20", "transaction_type": "award", "transaction_attributes": { "reason": "cartabondoned" }, "id": "65003948ebeffa000ccc6bb8" } }, "list-member-transactions-response-object": { "description": "", "type": "object", "properties": { "total": { "format": "int32", "description": "The total number of member's transactions.", "type": "integer" }, "next_cursor": { "format": "int32", "description": "This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "type": "integer" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/list-member-transactions-transaction-object" } }, "more": { "type": "boolean" } }, "example": { "total": 10, "next_cursor": 100, "transactions": [ { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:11:20", "award_info": { "activity_id": "winback_bonus", "points": 100, "points_status": "approved", "activity_name": "Winback Bonus" }, "member_id": "johndoe", "points_expiration_date": "13-Sep-2023 00:00:00", "approved_date": "12-Sep-2023 10:11:20", "created_date": "12-Sep-2023 10:11:20", "transaction_type": "award", "transaction_attributes": { "reason": "cartabondoned" }, "id": "65003948ebeffa000ccc6bb8" }, { "status": "approved", "auto_approval_date": "15-Nov-20232 16:10:00", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "upload_photo", "points": 500, "points_status": "expired", "activity_name": "Upload a Photo" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 00:00:00", "approved_date": "12-Sep-2023 10:01:36", "created_date": "12-Sep-2023 10:01:19", "transaction_type": "award", "transaction_attributes": { "reason": "photouploaded" }, "id": "650036efebeffa00099d54ba" }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "submit_a_receipt", "points": 9, "points_status": "expired", "activity_name": "Submit a Receipt" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 00:00:00", "approved_date": "12-Sep-2023 10:00:34", "created_date": "12-Sep-2023 10:00:17", "transaction_type": "award", "transaction_attributes": { "receipt_file_url": [ "https://zinrelo-receipt-uploads.s3.amazonaws.com/c944754e96693d3cce82bc3ebcda9f9e.jpg" ] }, "id": "650036b1c13154000c365f21" }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:29:36", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "approved", "activity_name": "Purchase on website" }, "member_id": "johndoe", "points_expiration_date": "13-Sep-2023 00:00:00", "approved_date": "12-Sep-2023 10:29:36", "created_date": "12-Sep-2023 00:00:00", "transaction_type": "award", "transaction_attributes": { "order_id": "7587746", "coupon_code": "$5OFFVYZ", "reason": "purchase" }, "id": "65003d91e410b900092ef4e4" }, { "status": "approved", "transaction_attributes": {}, "last_modified_date": "08-Aug-2023 06:04:37", "member_id": "johndoe", "approved_date": "08-Aug-2023 06:04:37", "reward_info": { "reward_name": "$5 OFF COUPON", "points_status": "redeemed", "coupon_code": "3193E86A", "reward_id": "reward_bc668", "points": 500 }, "transaction_type": "redeem", "id": "64d1daf5339122000c4c3c0a", "created_date": "08-Aug-2023 06:04:37" }, { "status": "approved", "transaction_attributes": { "reason": "Testing" }, "last_modified_date": "05-May-2023 10:05:43", "transaction_type": "deduct", "approved_date": "05-May-2023 10:04:31", "member_id": "johndoe", "created_date": "05-May-2023 10:04:31", "id": "6454d4af3953d5000ccc3c26", "deduct_info": { "points": 10, "points_status": "deducted" } }, { "status": "approved", "transaction_attributes": { "reason": "Testing" }, "last_modified_date": "05-May-2023 10:00:09", "transaction_type": "deduct", "approved_date": "05-May-2023 09:59:28", "member_id": "johndoe", "created_date": "05-May-2023 09:59:28", "id": "6454d38077b86b000d2e555a", "deduct_info": { "points": 10, "points_status": "deducted" } }, { "status": "approved", "transaction_attributes": { "reason": "Testing" }, "last_modified_date": "05-May-2023 10:00:09", "transaction_type": "deduct", "approved_date": "05-May-2023 09:54:10", "member_id": "johndoe", "created_date": "05-May-2023 09:54:10", "id": "6454d2422e7adb000a78f2c5", "deduct_info": { "points": 10, "points_status": "deducted" } }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "created_an_account", "points": 10000, "points_status": "expired", "activity_name": "Account Creation" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 00:00:00", "approved_date": "05-May-2023 07:44:43", "created_date": "05-May-2023 07:44:43", "transaction_type": "award", "transaction_attributes": {}, "id": "6454b3ebe8d4a8000b15cc77" }, { "status": "approved", "auto_approval_date": "", "last_modified_date": "12-Sep-2023 10:14:18", "award_info": { "activity_id": "made_a_purchase", "points": 1000, "points_status": "expired", "activity_name": "Purchase on website" }, "member_id": "johndoe", "points_expiration_date": "06-Oct-2019 00:00:00", "approved_date": "12-Sep-2023 10:11:20", "created_date": "05-Oct-2019 23:10:55", "transaction_type": "award", "transaction_attributes": { "order_id": "758765", "coupon_code": "$5OFFVYZ", "reason": "purchase" }, "id": "65003948ebeffa000ccc6bb7" } ], "more": false } }, "ui-list-member-transactions-failure-object": { "description": "", "type": "object", "properties": { "error_code": { "description": "The reason behind the error encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "error": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "ui-perform-an-activity-request-body": { "description": "", "required": [ "activity_id" ], "type": "object", "properties": { "activity_id": { "description": "Enter activity_id.", "type": "string" }, "transaction_attributes": { "format": "json", "type": "string", "description": "

You have to pass different transaction_attributes for different activities:

\r\n

Share on Facebook/ Twitter/ Pinterest

\r\n

Activity ID: share_on_facebook/ share_on_twitter/ share_on_pinterest

\r\n

Transaction attributes:

\r\n

{

\r\n

\"track_code\":\"\"

\r\n

}

\r\n

Note: You can obtain the track code of sharing activities using Get Activity Track Codes API.

\r\n

Submit a receipt activity

\r\n

Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.

\r\n

Activity ID: submit_a_receipt

\r\n

Transaction attributes:

\r\n

{

\r\n

\"receipt_files\": [\"\"]

\r\n

}

\r\n

Code submission activity

\r\n

Activity ID: code_submission

\r\n

Transaction attributes:

\r\n

{

\r\n

\"code\": \"\"

\r\n

}

\r\n

Follow on instagram

\r\n

Activity ID: follow_on_instagram

\r\n

Transaction attributes:

\r\n

{}

\r\n


Upload a photo activity

\r\n

Expected data is a list of images/pdfs encoded in base64 format. To convert an image to base64 format, click here.

\r\n

Activity ID: upload_photo

\r\n

Transaction attributes:

\r\n

{

\r\n

\"image_file\": [\"\"]

\r\n

}

\r\n

Refer to a friend

\r\n

Activity ID: referral

\r\n

Transaction attributes:

\r\n

{

\r\n

\"share_network\": \"mail\",

\r\n

\"to_addresses\":[\"user1@zinrelo.com\",\"user2@zinrelo.com\"]

\r\n

}

\r\n

In share_network, pass the source of referral- mail, twitter or facebook. And in to_addresses, you have to pass email address of the referral. 

\r\n

It's important to note that passing email addresses is mandatory only when \"mail\" is selected as the \"share_network.\" For other share networks like \"twitter\" or \"facebook,\" email addresses are not required.

" } } }, "perform-an-activity-data-object": { "description": "", "type": "object", "properties": { "data": { "type": "object" }, "success": { "type": "boolean" } }, "example": { "data": {}, "success": true } }, "perform-an-activity-failure": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "reason": "Internal server error.", "error_code": "INTERNAL_SERVER_ERROR", "success": false } }, "reject-pending-redemption-request-body": { "description": "", "type": "object", "properties": { "reward_id": { "description": "Unique ID that identifies a reward in TrueLoyal. This is the ID of the reward against which the redemption transaction has to be recorded.", "type": "string", "example": "reward_bc668" }, "coupon_code": { "description": "Pass the coupon code for which you want to reject the pending redemption.", "type": "string", "example": "82E69FBD" } } }, "reject-pending-redemption-reward-info-object": { "description": "", "type": "object", "properties": { "coupon_code": { "description": "The coupon code used for redemption.", "type": "string" }, "points": { "format": "int32", "description": "The number of points redeemed by the member.", "type": "integer" }, "points_status": { "description": "The point status of the Reject a Pending API will always be \"redemption_cancelled.\"", "type": "string" }, "reward_id": { "description": "The unique reward ID assigned by TrueLoyal. ", "type": "string" }, "reward_link": { "description": "The link to flexi reward. Instead of asking members to choose from a fixed set of rewards, loyalty points can be used as a currency and members can redeem any number of points they have from their account for a corresponding discount on their transactions. ", "type": "string" }, "reward_name": { "description": "The name of the reward stored in TrueLoyal.", "type": "string" } }, "example": { "coupon_code": "82E68FBD", "points": 500, "points_status": "redemption_cancelled", "reward_id": "reward_bc668", "reward_name": "$10 Gift Certificate Netsuite" } }, "reject-pending-redemption-transaction-attributes-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason associated with the transaction.", "type": "string" } }, "example": { "reason": "Shopify in-cart redemption failed" } }, "reject-pending-redemption-response-object": { "description": "", "type": "object", "properties": { "approved_date": { "description": "The date on which the transaction was approved.", "type": "string" }, "created_date": { "description": "The date and time on which the transaction was created.", "type": "string" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "last_modified_date": { "description": "The most recent date on which a transaction was updated.", "type": "string" }, "member_id": { "description": "The unique identifier of the member defined by an Admin.", "type": "string" }, "reward_info": { "$ref": "#/components/schemas/reject-pending-redemption-reward-info-object" }, "status": { "description": "The status of the Reject a Pending Redemption API will always be \"rejected.\"", "type": "string" }, "transaction_attributes": { "$ref": "#/components/schemas/reject-pending-redemption-transaction-attributes-object" }, "transaction_type": { "description": "The transaction type of the Reject a Pending Redemption API will always be \"redeem.\"", "type": "string" } }, "example": { "approved_date": "05-Jan-2024 12:50:45", "created_date": "05-Jan-2024 12:50:45", "id": "6597fb251f1bee000df19dc3", "last_modified_date": "05-Jan-2024 12:51:20", "member_id": "j.buitenhuis@alumio.com", "reward_info": { "coupon_code": "82E68FBD", "points": 500, "points_status": "redemption_cancelled", "reward_id": "reward_bc668", "reward_name": "$10 Gift Certificate Netsuite" }, "status": "rejected", "transaction_attributes": { "reason": "Shopify in-cart redemption failed" }, "transaction_type": "redeem" } }, "reject-pending-redemption-data-object": { "description": "", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/reject-pending-redemption-response-object" }, "success": { "type": "boolean" } }, "example": { "data": { "approved_date": "05-Jan-2024 12:50:45", "created_date": "05-Jan-2024 12:50:45", "id": "6597fb251f1bee000df19dc3", "last_modified_date": "05-Jan-2024 12:51:20", "member_id": "j.buitenhuis@alumio.com", "reward_info": { "coupon_code": "82E68FBD", "points": 500, "points_status": "redemption_cancelled", "reward_id": "reward_bc668", "reward_name": "$10 Gift Certificate Netsuite" }, "status": "rejected", "transaction_attributes": { "reason": "Shopify in-cart redemption failed" }, "transaction_type": "redeem" }, "success": true } }, "reject-pending-redemption-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the failure.", "type": "string" }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "error": { "description": "The reason behind the failure.", "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "fetch-potential-points-response-object": { "description": "", "type": "object", "properties": { "potential_points": { "format": "int32", "description": "The total points a member can earn when making a purchase, calculated based on both base points and applicable business rules.", "type": "integer" } }, "example": { "potential_points": 200 } }, "fetch-potential-points-data-object": { "description": "", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/fetch-potential-points-response-object" }, "success": { "type": "boolean" } }, "example": { "data": { "potential_points": 160, "potential_promotion_points": 135, "potential_promotion_points_breakdown": [ { "campaign_id": "campaign_c8fd9", "end_date": null, "potential_points": 75 }, { "campaign_id": "campaign_ch7j3", "end_date": null, "potential_points": 60 } ] }, "success": true } }, "fetch-potential-points-failure-object": { "description": "", "type": "object", "properties": { "reason": { "description": "The reason behind the failure.", "type": "object", "properties": { "product_list": { "type": "string" } } }, "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "reason": { "product_list": "The 'product_list' value must be an array of products." }, "error_code": "INVALID_REQUEST_PARAMETER_VALUES", "success": false } }, "guest-guest-activities-points-config-object": { "description": "", "type": "object", "properties": { "points_computation_type": { "description": "

Points computation provides information about how the base points for various activities within our program are calculated, encompassing multiple fields within the points config.

\r\n

 

\r\n

For certain activities like 'Share On Facebook' and 'Write a Review' within our program, a fixed set of points is allocated upon completion. In these instances, the points computation type is designated as \"fixed.\" The points configuration includes an additional field specifying the exact number of fixed points awarded upon successful activity completion. For instance:

\r\n

{
 \"points\": 100,
 \"points_computation_typ\": “fixed_points”
 }

\r\n

Conversely, some activities such as  'Purchase on Website' and 'Submit a Receipt' within our program grant points based on multiples of a particular value. For instance, when a purchase is made on the website, points are awarded in multiples of the order subtotal. This scenario falls under the points computation type \"multiplier_based.\" The points configuration contains a \"multiplier\" field and attribute, utilized to multiply the awarded points based on the specified value.

\r\n

{
 \"multiplier\": 2,
 “attribute_to_multiply”: “order_subtotal”
 \"points_computation_type\": “multiplier_based”
 }

\r\n

However, certain activities within the program do not provide any points. These instances occur when the benefit type solely involves coupons. In such cases, the points configuration remains empty, rendering points computation unavailable.

", "type": "string" }, "attribute_to_multiply": { "description": "If points_computation_type is multiplier based then points config will have attribute_to_multiply and multiplier field along with points_computation_type.\r\nAttribute to multiply can have different fields based on activity id. For example-\r\n- made_a_purchase actvity will have order_subtotal\r\n- submit_a_receipt activity will have receipt_order_value\r\n\r\nFor referral activity based on referrer_payoff_type attribute will have different attribute to multiply fields such as:\r\n\r\n- percent_purchase_points referrer payoff type will have purchase_points\r\n- percent_order_value referrer payoff type will have order_value\r\n\r\n\r\n\r\n", "type": "string" }, "multiplier": { "format": "int32", "description": "The digit that will be multiplied.", "type": "integer" } }, "example": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 } }, "guest-activities-extra-config-object": { "description": "", "type": "object", "properties": { "share_current_page_url": { "description": "The shared url for Facebook/ Pinterest.", "type": "boolean" }, "pin_post_image": { "description": "The image for a Pinterest post. This can be uploaded through the admin console on the Activity Setting page by using the 'Post Image' feature.", "type": "string" }, "pin_post_description": { "description": "The description for 'Share on Pinterest' can be set within the admin console by adjusting the text within the 'Post Description' text box.", "type": "string" }, "max_award_frequency_error_text": { "description": "The error message displayed when a member exceeds the defined frequency limit.", "type": "string" }, "personal_handle_edit_button_text": { "description": "The text displayed on the button for editing the personal handle.", "type": "string" }, "duplicate_handle_error_text": { "description": "The message shown when a member attempts to submit a duplicate handle for Instagram or TikTok.", "type": "string" }, "personal_handle_submit_button_text": { "description": "The text displayed on the button for submit the personal handle.", "type": "string" }, "handle_required_alert_text": { "description": "The alert message displayed when an Instagram or TikTok handle is required but has not been provided.", "type": "string" }, "activity_start_button_text": { "description": "The text displayed on the start button for Instagram or TikTok activities.", "type": "string" }, "failure_text": { "description": "The message displayed when an issue occurs or an operation fails.", "type": "string" }, "thank_you_text": { "description": "The thank message including details about the points a member will earn.", "type": "string" }, "cancel_button_text": { "description": "The text displayed on the cancel button for Instagram or TikTok activities.", "type": "string" }, "excluded_transaction_error_text": { "description": "The text displayed on exclusion rule for Instagram or TikTok activities.", "type": "string" }, "enter_handle_prompt_text": { "description": "The description text to enter Instagram or TikTok handle.", "type": "string" }, "personal_handle_input_text": { "description": "The input text for Instagram or TikTok handle.", "type": "string" }, "blocked_handle_error_text": { "description": "The message displayed when a blocked Instagram or TikTok handle is submitted.", "type": "string" }, "name_header_text": { "description": "The activity header text displayed in end user dashboard for Instagram or TikTok activities. ", "type": "string" }, "enter_handle_placeholder_text": { "description": "The placeholder text to enter the TikTok or Instagram.", "type": "string" }, "edit_handle_text": { "description": "The text displayed on end user dashboard to edit Instagram or TikTok handle.", "type": "string" }, "business_handle_display_text": { "description": "The display text for business handle.", "type": "string" }, "business_instagram_username": { "description": "The username of the Instagram user.", "type": "string" } }, "example": { "share_current_page_url": false, "pin_post_image": "", "pin_post_description": "Awesome products at great prices. You should really check them out.", "business_instagram_username": "pallavi" } }, "guest-guest-activities-activities-object": { "description": "", "type": "object", "properties": { "activity_id": { "description": "The unique ID of the activity assigned by TrueLoyal. ", "type": "string" }, "enduser_activity_description_html": { "description": "\"Points earning description HTML\" configuration in TrueLoyal admin console.", "type": "string" }, "activity_card_background_image_url": { "description": "\"Activity Tile Image\" configuration in TrueLoyal admin console.", "type": "string" }, "is_qualified_for_tier_upgrade": { "description": "The activity qualifies for a tier upgrade.", "type": "boolean" }, "last_modified_date": { "description": "The most recent date on which a transaction was updated.", "type": "string" }, "metadata": { "description": "The metadata associated with an activity.", "type": "object", "properties": { "Category": { "type": "string" } } }, "enduser_activity_short_description": { "description": "\"Description\" configuration in TrueLoyal admin console.", "type": "string" }, "created_date": { "description": "The date on which the activity was created.", "type": "string" }, "activity_name": { "description": "The activity name stored with TrueLoyal.", "type": "string" }, "is_points_expiry_reset_activity": { "description": "The activity which resets expiry. To check and configure it, navigate to Program Settings>> Points Expiration.", "type": "boolean" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "activity_benefit_type": { "description": "Activity benefit type is based on activity_type. Like for example: \n- fixed activity type- points activity benefit type\n- fixed_and_coupon_based activity type- points_and_coupon_code activity benefit type\n- bonus_multiplier activity type- points activity benefit type\n- bonus_and_coupon_based activity type- points_and_coupon_code activity benefit type\n- coupon_based activity type- coupon_based activity benefit type\n\n", "type": "string" }, "points_config": { "$ref": "#/components/schemas/guest-guest-activities-points-config-object" }, "extra_config": { "$ref": "#/components/schemas/guest-activities-extra-config-object" } }, "example": { "activity_id": "made_a_purchase", "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2023-07-07 04:59:56.825000", "metadata": { "Category": "Chocolate Cake" }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "is_points_expiry_reset_activity": true, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" } }, "guest-guest-activities-response-object": { "description": "", "type": "object", "properties": { "total": { "format": "int32", "description": "The total number of eligible activities.", "type": "integer" }, "next_cursor": { "format": "int32", "description": "This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "type": "integer" }, "more": { "type": "boolean" }, "activities": { "$ref": "#/components/schemas/guest-guest-activities-activities-object", "description": "" } }, "example": { "total": 16, "activities": [ { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "order_subtotal", "multiplier": 1 }, "activity_id": "made_a_purchase", "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2023-07-07 04:59:56.825000", "metadata": { "Category": "Chocolate Cake" }, "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.", "created_date": "2021-03-15 12:59:39.818000", "activity_name": "Loan Installment Payment", "is_points_expiry_reset_activity": true, "id": "604f5a3b8152252216f5c19b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "created_an_account", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-06-14 09:03:33.343000", "metadata": {}, "enduser_activity_short_description": "Earn points when you create your loyalty account.", "created_date": "2021-03-15 12:59:39.812000", "activity_name": "Account Creation", "is_points_expiry_reset_activity": false, "id": "604f5a3b8152252216f5c19a", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "multiplier": 1 }, "activity_id": "write_a_review", "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:13:10.021000", "metadata": {}, "enduser_activity_short_description": "Earn points for writing a review.", "created_date": "2021-03-15 12:59:39.824000", "activity_name": "Write a Review", "is_points_expiry_reset_activity": false, "id": "604f5a3b8152252216f5c19c", "activity_benefit_type": "points" }, { "points_config": { "points": 200, "points_computation_type": "fixed_points" }, "activity_id": "anniversary_bonus", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-22 10:07:02.905000", "metadata": {}, "enduser_activity_short_description": "Earn points on your anniversary.", "created_date": "2021-03-15 12:59:39.836000", "activity_name": "Anniversary Bonus", "is_points_expiry_reset_activity": false, "id": "604f5a3b8152252216f5c19e", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "f00ca_custom_activity", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-17 11:21:50.190000", "metadata": {}, "enduser_activity_short_description": "", "created_date": "2021-05-05 05:29:46.129000", "activity_name": "", "is_points_expiry_reset_activity": false, "id": "60922d4abed0d56677192dcf", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "referral", "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-05-12 11:10:12.088000", "metadata": {}, "enduser_activity_short_description": "Award points on referral purchase.", "created_date": "2021-03-22 08:46:18.898000", "activity_name": "Refer a Friend", "is_points_expiry_reset_activity": false, "id": "6058595abb711d6fa73fcd36", "activity_benefit_type": "points_and_coupon_code" }, { "points_config": { "points": 500, "points_computation_type": "fixed_points" }, "activity_id": "684fc_custom_activity", "enduser_activity_description_html": "
", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-04-10 11:47:27.127000", "metadata": {}, "enduser_activity_short_description": "Enter the code on your LD pack and earn points", "created_date": "2021-05-05 11:41:57.738000", "activity_name": "684fc_custom_activity", "is_points_expiry_reset_activity": true, "id": "609284851c9396204c8b984b", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "a7ee1_custom_activity", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-03-08 11:01:06.969000", "metadata": {}, "enduser_activity_short_description": "Reward your users for any activity you want.", "created_date": "2023-01-23 13:52:30.665000", "activity_name": "Custom Activity", "is_points_expiry_reset_activity": true, "id": "63ce911ef380d8000b8d7753", "activity_benefit_type": "points" }, { "points_config": { "points": 130, "points_computation_type": "fixed_points" }, "activity_id": "birthday_bonus", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2023-02-24 07:27:55.290000", "metadata": {}, "enduser_activity_short_description": "Award points on birthday.", "created_date": "2021-03-15 12:59:39.830000", "activity_name": "Birthday Bonus", "is_points_expiry_reset_activity": false, "id": "604f5a3b8152252216f5c19d", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "upload_photo", "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-10-06 10:26:28.835000", "metadata": {}, "enduser_activity_short_description": "Earn points for uploading a photo.", "created_date": "2022-07-28 06:53:03.616000", "activity_name": "Upload a Photo", "is_points_expiry_reset_activity": false, "id": "62e2324f23d74243d1c5af29", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "attribute_to_multiply": "receipt_order_value", "multiplier": 1 }, "activity_id": "submit_a_receipt", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": true, "last_modified_date": "2022-10-06 09:54:55.183000", "metadata": {}, "enduser_activity_short_description": "Reward users for submitting receipts of their purchases.", "created_date": "2021-03-22 08:56:14.632000", "activity_name": "Submit A Receipt", "is_points_expiry_reset_activity": false, "id": "60585baef5a67a16e1871b56", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "follow_on_instagram", "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:25.289000", "metadata": {}, "enduser_activity_short_description": "Earn points when you follow us on Instagram.", "created_date": "2021-03-15 12:59:39.886000", "activity_name": "Follow on Instagram", "is_points_expiry_reset_activity": false, "id": "604f5a3b8152252216f5c1a4", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "activity_id": "share_on_pinterest", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:19.592000", "metadata": {}, "enduser_activity_short_description": "Earn points when you share us on Pinterest.", "created_date": "2021-03-15 12:59:39.873000", "activity_name": "Share on Pinterest", "is_points_expiry_reset_activity": false, "id": "604f5a3b8152252216f5c1a3", "activity_benefit_type": "points" }, { "points_config": { "points": 50, "points_computation_type": "fixed_points" }, "activity_id": "share_on_facebook", "enduser_activity_description_html": "", "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-07-14 08:17:00.673000", "metadata": {}, "enduser_activity_short_description": "Reward points to users when they share you on Facebook.", "created_date": "2021-03-15 12:59:39.848000", "activity_name": "Share on Facebook", "is_points_expiry_reset_activity": false, "id": "604f5a3b8152252216f5c1a0", "activity_benefit_type": "points" }, { "points_config": { "points": 100, "points_computation_type": "fixed_points" }, "activity_id": "f46f4_custom_activity", "enduser_activity_description_html": "", "activity_card_background_image_url": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-06-14 11:09:16.199000", "metadata": {}, "enduser_activity_short_description": "Reward your users for any activity you want.", "created_date": "2022-03-03 05:30:58.331000", "activity_name": "Quiz form", "is_points_expiry_reset_activity": false, "id": "622052924e6d9f1dfd89ed88", "activity_benefit_type": "points" }, { "points_config": { "points_computation_type": "multiplier_based", "multiplier": 1 }, "activity_id": "code_submission", "enduser_activity_description_html": "", "is_qualified_for_tier_upgrade": false, "last_modified_date": "2022-05-19 10:32:40.318000", "metadata": {}, "enduser_activity_short_description": "Get rewarded for your purchases by submitting the code you received with your purchase.", "created_date": "2022-05-18 10:05:41.642000", "activity_name": "Enter a Code", "is_points_expiry_reset_activity": false, "id": "6284c4f5dfa6b7425568ba6d", "activity_benefit_type": "points" } ], "next_cursor": 100, "more": false } }, "guest-guest-activities-failure-object": { "description": "", "type": "object", "properties": { "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "reason": "Member does not exist", "error_code": "INVALID_MEMBER", "success": false } }, "guest-rewards-rewards-object": { "description": "", "type": "object", "properties": { "reward_name": { "description": "The reward name stored with TrueLoyal.", "type": "string" }, "enduser_reward_confirmation_html": { "description": "\"Redemption Confirmation Text\" configuration in TrueLoyal admin console.", "type": "string" }, "reward_card_background_image_url": { "description": "\"Reward Tile Image\" configuration in TrueLoyal admin console.", "type": "string" }, "implementation_type": { "description": "By default, all our rewards are coupon-based. However, we also support add-to-cart rewards.", "type": "string" }, "reward_value": { "description": "The reward value configured in TrueLoyal.", "type": "string" }, "last_modified_date": { "description": "The recent date and time on which the reward configuration was updated.", "type": "string" }, "reward_sub_type": { "description": "These are the reward types we offer: Fixed amount discount, Free shipping, Product redemption, and Percentage discount.", "type": "string" }, "created_date": { "description": "The date and time on which the reward was created.", "type": "string" }, "enduser_reward_short_description": { "description": "\"End User Reward Description\" configuration in TrueLoyal admin console.", "type": "string" }, "points_to_be_redeemed": { "format": "int32", "description": "The points to be deducted when the reward is redeemed.", "type": "integer" }, "reward_type": { "description": "All our rewards are coupon-based.", "type": "string" }, "enduser_reward_post_confirmation_html": { "description": "\"Post Redemption HTML\" configuration in TrueLoyal admin console.", "type": "string" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "reward_id": { "description": "The unique ID of the reward assigned by TrueLoyal. ", "type": "string" }, "metadata": { "description": "The metadata associated with the reward.", "type": "object", "properties": { "Category": { "type": "string" }, "Brand": { "type": "string" } } } }, "example": { "reward_name": "$10 Gift Certificate Netsuite", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "5", "last_modified_date": "07/07/2023 10:49:41", "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:39", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 500, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3b8152252216f5c1ad", "reward_id": "reward_bc668", "metadata": { "Category": "Limited time", "Brand": "Nescafe" } } }, "guest-guest-rewards-response-object": { "description": "", "type": "object", "properties": { "total": { "format": "int32", "description": "The total number of eligible rewards.", "type": "integer" }, "next_cursor": { "format": "int32", "description": "This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.", "type": "integer" }, "more": { "type": "boolean" }, "rewards": { "$ref": "#/components/schemas/guest-rewards-rewards-object", "description": "" } }, "example": { "total": 3, "rewards": [ { "reward_name": "$10 Gift Certificate Netsuite", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "5", "last_modified_date": "07/07/2023 10:49:41", "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:39", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 500, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "id": "604f5a3b8152252216f5c1ad", "reward_id": "reward_bc668", "metadata": { "Category": "Limited time", "Brand": "Nescafe" } }, { "reward_name": "$10 OFF COUPON Miva", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png", "implementation_type": "coupon_code", "reward_value": "10", "last_modified_date": "07/07/2023 10:49:43", "reward_sub_type": "Fixed Amount Discount", "created_date": "03/15/2021 12:59:41", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1000, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "rank": 1, "id": "604f5a3d8152252216f5c1b0", "reward_id": "reward_a1e91", "metadata": { "Category": "Miva", "Brand": "Nescafe", "Products Eligible": "A,B,C" } }, { "reward_name": "$15 OFF COUPON", "enduser_reward_confirmation_html": "{{POINTS}} Points WILL be deducted from your account balance. Do you wish to redeem this reward?", "reward_card_background_image_url": "", "implementation_type": "coupon_code", "reward_value": "10", "last_modified_date": "07/06/2023 05:20:05", "reward_sub_type": "Percentage Discount", "created_date": "03/15/2021 12:59:42", "enduser_reward_short_description": "For {{POINTS}} points", "points_to_be_redeemed": 1400, "reward_type": "Coupon Based Rewards", "enduser_reward_post_confirmation_html": "Here is your coupon code.", "rank": 1, "id": "604f5a3e8152252216f5c1b3", "reward_id": "reward_9c350", "metadata": {} } ], "next_cursor": 100, "more": false } }, "guest-rewards-failure-object": { "description": "", "type": "object", "properties": { "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "guest-guest-tiers-tier-object": { "description": "", "type": "object", "properties": { "created_time": { "description": "The date on which the tier was created.", "type": "string" }, "description": { "description": "\"Tier Description\" text configuration in tier settings in the admin console.", "type": "string" }, "id": { "description": "The internal ID generated by TrueLoyal.", "type": "string" }, "is_default": { "description": "Specifies if the mentioned tier is the default tier or not.", "type": "boolean" }, "minimum_points": { "format": "int32", "description": "The minimum points required to be in the tier.", "type": "integer" }, "name": { "description": "The tier name.", "type": "string" }, "tier_id": { "description": "The unique ID associated with the tier.", "type": "string" }, "updated_time": { "description": "The recent date and time on which tier was updated.", "type": "string" } }, "example": { "created_time": "07-May-2021 05:44:16", "description": "1000 points", "id": "6094d3b084d28f07bbda724d", "is_default": false, "minimum_points": 14000, "minimum_qualification_units": 500, "name": "Gold", "tier_id": "zrl_gold", "updated_time": "26-Jul-2023 05:04:15" } }, "guest-tiers-failure-object": { "description": "", "type": "object", "properties": { "error_code": { "description": "The generic error message given when an unexpected condition is encountered. For detailed understanding refer to the document- https://help.trueloyal.com/reference/status-code ", "type": "string" }, "reason": { "description": "The reason behind the error encountered. ", "type": "string" }, "success": { "type": "boolean" } }, "example": { "error_code": "400", "error": "ERROR_INVALID_PARAMETER", "message": "An invalid value was supplied for {Parameter}." } }, "WebhookRequestId": { "type": "string", "description": "A unique identifier of this webhook request.", "example": "6332aec45fd7d2000d77b8a2" }, "WebhookTotalCount": { "type": "integer", "description": "The number of events in the batch (`events`).", "example": 1 }, "WebhookCreatedDate": { "type": "string", "description": "When the webhook request was created, as `MM/DD/YYYY HH:MM:SS`.", "example": "09/27/2022 08:05:24" }, "WebhookEventId": { "type": "string", "description": "The unique identifier of the event. Use it to detect events you already processed.", "example": "6332aec49fe239670bc1bcde" }, "MemberInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "The internal ID generated by TrueLoyal." }, "first_name": { "type": "string", "description": "The first name of the member." }, "last_name": { "type": "string", "description": "The last name of the member." }, "email_address": { "type": "string", "description": "The email address of the member." }, "address": { "type": "object", "properties": { "city": { "type": "string", "description": "Member's city." }, "country": { "type": "string", "description": "Member's country." }, "line2": { "type": "string", "description": "The member address." }, "line1": { "type": "string", "description": "The member address." }, "state": { "type": "string", "description": "Member's state." }, "postal_code": { "type": "string", "description": "Member's postal code." } } }, "phone_number": { "type": "string", "description": "The phone number of the member." }, "member_id": { "type": "string", "description": "The unique identifier of the member defined by an Admin." }, "member_status": { "type": "string", "description": "The current status of the member- ‘active’ , ‘blocked’, ‘opted_out’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program." }, "member_tags": { "type": [ "array", "string" ], "items": { "type": "string" }, "description": "The tags assocaited with a member." }, "number_of_purchases": { "type": "integer", "description": "The number of purchases made by a member." }, "number_of_redemptions": { "type": "integer", "description": "The number of redemptions made by a member." }, "birthdate": { "type": "string", "description": "Birthdate of the loyalty member. Expected date format: MM/DD/YYYY or MM/DD Irrespective of the year passed, 1904 will be set as a default value." }, "churn_status": { "type": "string" }, "enrollment_date": { "type": "string", "description": "The date on which the member joined the loyalty program." }, "last_modified_date": { "type": "string", "description": "The most recent date on which a member's profile was updated." }, "first_purchase_date": { "type": "string", "description": "The first purchase date of the member." }, "instagram_handle": { "type": "string", "description": "The instagram handle of the member." }, "last_purchase_date": { "type": "string", "description": "The last purchase made by a member." }, "anniversary_date": { "type": "string", "description": "The anniversary date of the member. Expected date format: MM/DD/YYYY or MM/DD In case, where a year has not been passed the default year will be set as 1904." }, "twitter_handle": { "type": "string", "description": "The twitter handle of the member." }, "preferred_language": { "type": "string", "description": "The preferred language of the member." }, "deprecated_fields": { "type": "object", "properties": { "user_id": { "type": "string" } } }, "tier_info": { "type": "object", "properties": { "tier_qualification_units": { "type": "integer" }, "current_period_start": { "type": "string", "description": "The start date of the current tier cycle." }, "loyalty_tier_name": { "type": "string", "description": "The name of the current tier." }, "qualified_points": { "type": "integer", "description": "The qualified points for tier calculation." }, "loyalty_tier_id": { "type": "string", "description": "The unique tier ID stored in TrueLoyal." }, "current_period_end": { "type": [ "string", "null" ], "description": "The end date of current tier cycle." }, "qualifid_points": { "type": "integer" } } }, "lifetime_points_earned": { "type": "integer", "description": "The total points earned in a member's account since he joined the program." }, "lifetime_points_expired": { "type": "integer", "description": "The total points expired from a member's account since he joined the program." }, "available_points": { "type": "integer", "description": "The avaliable points of the member." }, "points_onhold": { "type": "integer" }, "lifetime_points_deducted": { "type": "integer", "description": "The total points deducted from a member's account since he joined the program." }, "lifetime_points_redeemed": { "type": "integer", "description": "The total points redeemed from a member's account since he joined the program." }, "number_of_referral_purchase": { "type": "integer" }, "number_of_referral_share": { "type": "integer" }, "referral_URL": { "type": "string", "description": "The unique referral url of the member." }, "custom_attributes": { "type": "object", "properties": { "Nationality": { "type": "string" }, "City_Name": { "type": "string" }, "Marital_Status": { "type": "string" }, "Income_Source": { "type": "string" }, "Age_In_Years": { "type": "string" }, "Gender_Identity": { "type": "string" }, "Graduation_Date": { "type": "string" }, "Number of purchases": { "type": "integer" }, "Favourite Destination": { "type": "string" }, "Last traveled": { "type": "string" }, "Gender": { "type": "string" }, "List of favourite place": { "type": "array", "items": { "type": "string" } }, "Review date": { "type": "string" }, "traveled destination": { "type": "string" }, "Preferences": { "type": "string" }, "Subscription Plan": { "type": "string" }, "Active Camera": { "type": "integer" } } }, "revenue": { "type": "integer" }, "aov": { "type": [ "number", "null" ] }, "deleted_date": { "type": "null" }, "referral_code": { "type": "string", "description": "The unique referral code of the member." } }, "description": "The `member_info` object of the event's `data`. Which fields are present depends on the event." }, "OtpInfo": { "type": "object", "properties": { "otp": { "type": "string" }, "minutes_valid": { "type": "integer" }, "valid_till": { "type": "string" } }, "description": "The `otp_info` object of the event's `data`. Which fields are present depends on the event." }, "TransactionInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique internal ID generated by TrueLoyal." }, "transaction_type": { "type": "string", "description": "The type of transaction- award, redeem or deduct." }, "member_id": { "type": "string", "description": "The unique identifier of the member defined by an Admin." }, "transaction_attributes": { "type": "object", "properties": { "order_id": { "type": "string", "description": "The unique ID associated with the placed order. This is system defined transaction attribute for \"made_a_purchase\" activity." }, "coupon_code": { "type": "string", "description": "The coupon code used for the purchase of the product. This is system defined transaction attribute for \"made_a_purchase\" activity." }, "reason": { "type": "string", "description": "The reason for making transaction." }, "tags": { "type": [ "array", "string" ], "items": { "type": "string" } }, "products": { "type": "array", "items": { "type": "object", "properties": { "product_id": { "type": "string" }, "product_price": { "type": "string" }, "product_title": { "type": "string" }, "product_category": { "type": "string" }, "product_quantity": { "type": "string" }, "product_url": { "type": [ "string", "null" ] }, "is_excluded": { "type": "boolean" }, "bonus_multiplier": { "type": "integer" }, "product_points_per_quantity": { "type": "integer" }, "product_image_url": { "type": "string" } } } }, "source_of_redemption": { "type": "string" }, "pow_01": { "type": "null" }, "order_subtotal": { "type": "integer" }, "order_total": { "type": "integer" }, "coupons": { "type": "string" }, "currency": { "type": "string" } } }, "approver_details": { "type": "object", "properties": { "approver_id": { "type": "null" }, "approver_name": { "type": "string" } } }, "approved_date": { "type": "string", "description": "The date and time on which the transaction will be approved." }, "last_modified_date": { "type": "string", "description": "The most recent date on which a transaction was updated." }, "created_date": { "type": "string", "description": "The date and time on which the transaction was created." }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string", "description": "The unique ID of the activity assigned by TrueLoyal." }, "activity_name": { "type": "string", "description": "The activity name stored with TrueLoyal." }, "points_status": { "type": "string", "description": "The status of the points- 'pending', 'approved', 'rejected', 'auto_approved', 'auto_rejected', 'expired' or 'exhausted.'" }, "points": { "type": "integer", "description": "The number of points awarded for performing the activity." } }, "description": "These data are system-defined for award transactions." }, "points_expiration_date": { "type": "string", "description": "The date and time when points expire." }, "auto_approval_date": { "type": "string", "description": "The date and time on which the transaction will be auto-approved. It can be configured through the Admin Console > Activities > Settings > Approval Type. This is a system-defined field for award transactions." }, "reward_info": { "type": "object", "properties": { "reward_id": { "type": "string", "description": "The unique reward ID assigned by TrueLoyal." }, "reward_name": { "type": "string", "description": "The name of the reward stored in TrueLoyal." }, "points_status": { "type": "string", "description": "The status of the points- 'redeemed,' redemption_pending' or 'redemption_cancelled.'" }, "points": { "type": "integer", "description": "The number of points redeemed by the member." }, "coupon_code": { "type": "string", "description": "The coupon code used for redemption." }, "reward_link": { "type": "null", "description": "The link to flexi reward. Instead of asking members to choose from a fixed set of rewards, loyalty points can be used as a currency and members can redeem any number of points they have from their account for a corresponding discount on their transactions." } }, "description": "These data are system-defined for reward transactions." }, "deduct_info": { "type": "object", "properties": { "points_status": { "type": "string", "description": "The status of the points- 'redeemed,' redemption_pending' or 'redemption_cancelled.'" }, "points": { "type": "integer", "description": "The number of points redeemed by the member." } }, "description": "These data are system-defined for deduct transactions." }, "expiry_info": { "type": "object", "properties": { "points_status": { "type": "string", "description": "The status of the points- 'redeemed,' redemption_pending' or 'redemption_cancelled.'" }, "points": { "type": "integer", "description": "The number of points redeemed by the member." } } } }, "description": "The `transaction_info` object of the event's `data`. Which fields are present depends on the event." }, "FriendInfo": { "type": "object", "properties": { "email_address": { "type": "string", "description": "The email address of the member." }, "id": { "type": "string", "description": "The internal ID generated by TrueLoyal." }, "first_name": { "type": "string", "description": "The first name of the member." }, "last_name": { "type": "string", "description": "The last name of the member." }, "address": { "type": "object", "properties": { "city": { "type": "string", "description": "Member's city." }, "country": { "type": "string", "description": "Member's country." }, "line2": { "type": "string", "description": "The member address." }, "line1": { "type": "string", "description": "The member address." }, "state": { "type": "string", "description": "Member's state." }, "postal_code": { "type": "string", "description": "Member's postal code." } } }, "phone_number": { "type": "string", "description": "The phone number of the member." }, "member_id": { "type": "string", "description": "The unique identifier of the member defined by an Admin." }, "member_status": { "type": "string", "description": "The current status of the member- ‘active’ , ‘blocked’, ‘opted_out’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program." }, "member_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags assocaited with a member." }, "number_of_purchases": { "type": "integer", "description": "The number of purchases made by a member." }, "number_of_redemptions": { "type": "integer", "description": "The number of redemptions made by a member." }, "birthdate": { "type": "string", "description": "Birthdate of the loyalty member. Expected date format: MM/DD/YYYY or MM/DD Irrespective of the year passed, 1904 will be set as a default value." }, "enrollment_date": { "type": "string", "description": "The date on which the member joined the loyalty program." }, "last_modified_date": { "type": "string", "description": "The most recent date on which a member's profile was updated." }, "first_purchase_date": { "type": "string", "description": "The first purchase date of the member." }, "instagram_handle": { "type": "string", "description": "The instagram handle of the member." }, "last_purchase_date": { "type": "string", "description": "The last purchase made by a member." }, "anniversary_date": { "type": "string", "description": "The anniversary date of the member. Expected date format: MM/DD/YYYY or MM/DD In case, where a year has not been passed the default year will be set as 1904." }, "twitter_handle": { "type": "string", "description": "The twitter handle of the member." }, "preferred_language": { "type": "string", "description": "The preferred language of the member." }, "tier_info": { "type": "object", "properties": { "tier_qualification_units": { "type": "integer" }, "current_period_start": { "type": "string", "description": "The start date of the current tier cycle." }, "loyalty_tier_name": { "type": "string", "description": "The name of the current tier." }, "qualified_points": { "type": "integer", "description": "The qualified points for tier calculation." }, "loyalty_tier_id": { "type": "string", "description": "The unique tier ID stored in TrueLoyal." }, "current_period_end": { "type": "string", "description": "The end date of current tier cycle." } } }, "lifetime_points_earned": { "type": "integer", "description": "The total points earned in a member's account since he joined the program." }, "lifetime_points_expired": { "type": "integer", "description": "The total points expired from a member's account since he joined the program." }, "available_points": { "type": "integer", "description": "The avaliable points of the member." }, "points_onhold": { "type": "integer" }, "lifetime_points_deducted": { "type": "integer", "description": "The total points deducted from a member's account since he joined the program." }, "lifetime_points_redeemed": { "type": "integer", "description": "The total points redeemed from a member's account since he joined the program." }, "referral_URL": { "type": "string", "description": "The unique referral url of the member." }, "custom_attributes": { "type": "object", "properties": { "Gender": { "type": "array", "items": { "type": "string" } }, "Number of purchases": { "type": "integer" }, "List of favourite place": { "type": "array", "items": { "type": "string" } }, "Review date": { "type": "string" }, "City_Name": { "type": "string" }, "Marital_Status": { "type": "string" }, "Income_Source": { "type": "string" }, "Age_In_Years": { "type": "string" }, "Gender_Identity": { "type": "string" }, "Graduation_Date": { "type": "string" } } }, "revenue": { "type": "integer" }, "aov": { "type": "number" }, "deleted_date": { "type": "null" }, "referral_code": { "type": "string", "description": "The unique referral code of the member." } }, "description": "The `friend_info` object of the event's `data`. Which fields are present depends on the event." }, "IncentiveInfo": { "type": "object", "properties": { "coupon": { "type": "string" }, "referrer_info": { "type": "object", "properties": { "referral_link": { "type": "string" }, "member_id": { "type": "string", "description": "The unique identifier of the member defined by an Admin." }, "id": { "type": "string", "description": "The internal ID generated by TrueLoyal." } } } }, "description": "The `incentive_info` object of the event's `data`. Which fields are present depends on the event." }, "ShareInfo": { "type": "object", "properties": { "channel_shared": { "type": "string" } }, "description": "The `share_info` object of the event's `data`. Which fields are present depends on the event." }, "EmailShareInfo": { "type": "object", "properties": { "friend_email": { "type": "array", "items": { "type": "string" } } }, "description": "The `email_share_info` object of the event's `data`. Which fields are present depends on the event." }, "ReferrerInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "The internal ID generated by TrueLoyal." }, "first_name": { "type": "string", "description": "The first name of the member." }, "last_name": { "type": "string", "description": "The last name of the member." }, "email_address": { "type": "string", "description": "The email address of the member." }, "address": { "type": "object", "properties": { "city": { "type": "string", "description": "Member's city." }, "country": { "type": "string", "description": "Member's country." }, "line2": { "type": "string", "description": "The member address." }, "line1": { "type": "string", "description": "The member address." }, "state": { "type": "string", "description": "Member's state." }, "postal_code": { "type": "string", "description": "Member's postal code." } } }, "phone_number": { "type": "string", "description": "The phone number of the member." }, "member_id": { "type": "string", "description": "The unique identifier of the member defined by an Admin." }, "member_status": { "type": "string", "description": "The current status of the member- ‘active’ , ‘blocked’, ‘opted_out’. ‘active’ member is the one accumulating loyalty points and has access to rewards and earning opportunities. ‘blocked’ member is prohibited from participating in the program. ‘opted_out’ member is the one who has chosen to opt out of the loyalty program." }, "member_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags assocaited with a member." }, "number_of_purchases": { "type": "integer", "description": "The number of purchases made by a member." }, "number_of_redemptions": { "type": "integer", "description": "The number of redemptions made by a member." }, "birthdate": { "type": "string", "description": "Birthdate of the loyalty member. Expected date format: MM/DD/YYYY or MM/DD Irrespective of the year passed, 1904 will be set as a default value." }, "enrollment_date": { "type": "string", "description": "The date on which the member joined the loyalty program." }, "last_modified_date": { "type": "string", "description": "The most recent date on which a member's profile was updated." }, "first_purchase_date": { "type": "string", "description": "The first purchase date of the member." }, "instagram_handle": { "type": "string", "description": "The instagram handle of the member." }, "last_purchase_date": { "type": "string", "description": "The last purchase made by a member." }, "anniversary_date": { "type": "string", "description": "The anniversary date of the member. Expected date format: MM/DD/YYYY or MM/DD In case, where a year has not been passed the default year will be set as 1904." }, "twitter_handle": { "type": "string", "description": "The twitter handle of the member." }, "preferred_language": { "type": "string", "description": "The preferred language of the member." }, "tier_info": { "type": "object", "properties": { "current_period_start": { "type": "string", "description": "The start date of the current tier cycle." }, "loyalty_tier_name": { "type": "string", "description": "The name of the current tier." }, "qualified_points": { "type": "integer", "description": "The qualified points for tier calculation." }, "loyalty_tier_id": { "type": "string", "description": "The unique tier ID stored in TrueLoyal." }, "current_period_end": { "type": "string", "description": "The end date of current tier cycle." } } }, "referral_code": { "type": "string", "description": "The unique referral code of the member." }, "lifetime_points_earned": { "type": "integer", "description": "The total points earned in a member's account since he joined the program." }, "lifetime_points_expired": { "type": "integer", "description": "The total points expired from a member's account since he joined the program." }, "available_points": { "type": "integer", "description": "The avaliable points of the member." }, "points_onhold": { "type": "integer" }, "lifetime_points_deducted": { "type": "integer", "description": "The total points deducted from a member's account since he joined the program." }, "lifetime_points_redeemed": { "type": "integer", "description": "The total points redeemed from a member's account since he joined the program." }, "referral_URL": { "type": "string", "description": "The unique referral url of the member." }, "custom_attributes": { "type": "object", "properties": { "City_Name": { "type": "string" }, "Marital_Status": { "type": "string" }, "Income_Source": { "type": "string" }, "Age_In_Years": { "type": "string" }, "Gender_Identity": { "type": "string" }, "Graduation_Date": { "type": "string" } } }, "revenue": { "type": "integer" }, "aov": { "type": "null" }, "deleted_date": { "type": "null" } }, "description": "The `referrer_info` object of the event's `data`. Which fields are present depends on the event." }, "ReferralSuccessActivityInfo": { "type": "object", "properties": { "activity_id": { "type": "string", "description": "The unique ID of the activity assigned by TrueLoyal." }, "activity_name": { "type": "string", "description": "The activity name stored with TrueLoyal." }, "order_info": { "type": "object", "properties": { "order_total": { "type": "string" }, "currency": { "type": "string" }, "order_id": { "type": "string", "description": "The unique ID associated with the placed order. This is system defined transaction attribute for \"made_a_purchase\" activity." }, "order_subtotal": { "type": "string" }, "reason": { "type": "string", "description": "The reason for making transaction." }, "device_type": { "type": "string" }, "coupons": { "type": "string" } } } }, "description": "The `referral_success_activity_info` object of the event's `data`. Which fields are present depends on the event." }, "ReferrerRewardInfo": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "transaction_type": { "type": "string" }, "member_id": { "type": "string" }, "transaction_attributes": { "type": "object", "properties": { "reason": { "type": "string" }, "tags": { "type": "array" } } }, "approver_details": { "type": "object", "properties": { "approver_id": { "type": "null" }, "approver_name": { "type": "string" } } }, "approved_date": { "type": "string" }, "last_modified_date": { "type": "string" }, "created_date": { "type": "string" }, "award_info": { "type": "object", "properties": { "activity_id": { "type": "string" }, "activity_name": { "type": "string" }, "points_status": { "type": "string" }, "points": { "type": "integer" }, "coupon_code": { "type": "string" } } }, "points_expiration_date": { "type": "string" }, "auto_approval_date": { "type": "string" } } }, "description": "The `referrer_reward_info` object of the event's `data`. Which fields are present depends on the event." }, "OfferInfo": { "type": "object", "properties": { "offer_valid_till": { "type": "string" }, "bonus_points": { "type": "integer" }, "activity_to_complete": { "type": "object", "properties": { "id": { "type": "string", "description": "The internal ID generated by TrueLoyal." }, "activity_id": { "type": "string", "description": "The unique ID of the activity assigned by TrueLoyal." }, "metadata": { "type": "object", "properties": { "Category": { "type": "string" }, "Location": { "type": "string" }, "Gender": { "type": "string" } }, "description": "The metadata associated with an activity." }, "activity_name": { "type": "string", "description": "The activity name stored with TrueLoyal." }, "is_active": { "type": "boolean" }, "approval_method": { "type": "string" }, "show_on_guest_dashboard": { "type": "boolean" }, "activity_card_background_image_url": { "type": "string", "description": "\"Activity Tile Image\" configuration in TrueLoyal admin console." }, "enduser_activity_short_description": { "type": "string", "description": "\"Description\" configuration in TrueLoyal admin console." }, "enduser_activity_description_html": { "type": "string", "description": "\"Points earning description HTML\" configuration in TrueLoyal admin console." }, "last_modified_date": { "type": "string", "description": "The most recent date on which a transaction was updated." }, "created_date": { "type": "string", "description": "The date and time on which the transaction was created." }, "is_qualified_for_tier_upgrade": { "type": "boolean", "description": "The activity qualifies for a tier upgrade." }, "rules_config": { "type": "array", "items": { "type": "object", "properties": { "rule_type": { "type": "string" }, "rule_value": { "type": "integer" }, "is_active": { "type": "boolean" }, "conditions_matching_policy": { "type": "string" }, "conditions": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string" }, "attribute": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } } } } } } }, "activity_benefit_type": { "type": "string", "description": "Activity benefit type is based on activity_type” - For 'fixed' activity types, the benefit type is 'points.' - For 'fixed and coupon-based' activity types, the benefit type is 'points_and_coupon_code.' - When the activity type is 'bonus_multiplier,' the benefit type is 'points.' - For 'bonus and coupon-based' activity types, the benefit type is 'points_and_coupon_code.' - For 'coupon-based' activity types, the benefit type is 'coupon_based.'\" Please Note: For coupon_based activity, the points_config will be empty." }, "points_config": { "type": "object", "properties": { "points_computation_type": { "type": "string" }, "attribute_to_multiply": { "type": "string" }, "multiplier": { "type": "integer" } } } } } }, "description": "The `offer_info` object of the event's `data`. Which fields are present depends on the event." }, "RewardInfo": { "type": "object", "properties": { "count": { "type": "integer" }, "rewards": { "type": "array", "items": { "type": "object", "properties": { "reward_name": { "type": "string" }, "enduser_reward_confirmation_html": { "type": "string" }, "reward_card_background_image_url": { "type": "string" }, "implementation_type": { "type": "string" }, "enduser_reward_post_confirmation_html": { "type": "string" }, "show_on_guest_dashboard": { "type": "boolean" }, "last_modified_date": { "type": "string" }, "is_active": { "type": "boolean" }, "product_url": { "type": "string" }, "reward_sub_type": { "type": "string" }, "eligible_tiers_list": { "type": "array", "items": { "type": "string" } }, "created_date": { "type": "string" }, "enduser_reward_short_description": { "type": "string" }, "points_to_be_redeemed": { "type": "integer" }, "reward_type": { "type": "string" }, "redemption_eligibility_criteria": { "type": "string" }, "id": { "type": "string" }, "reward_id": { "type": "string" }, "product_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "Category": { "type": "string" }, "Location": { "type": "string" }, "Gender": { "type": "string" } } }, "earning_period_operator": { "type": "string" }, "points_earned": { "type": "integer" }, "points_earned_operator": { "type": "string" }, "reward_value": { "type": "string" } } } } }, "description": "The `reward_info` object of the event's `data`. Which fields are present depends on the event." }, "ExpiryInfo": { "type": "object", "properties": { "expiration_date": { "type": "string", "description": "The expiration date of the available points." }, "points": { "type": "integer", "description": "The total number of points that will expire." }, "days_to_expire": { "type": "integer" } }, "description": "The `expiry_info` object of the event's `data`. Which fields are present depends on the event." }, "CampaignInfo": { "type": "object", "properties": { "event_name": { "type": "string" }, "event_ID": { "type": "string" }, "delay_in_days": { "type": "integer" }, "campaign_name": { "type": "string" }, "campaign_ID": { "type": "string" }, "promotion_info": { "type": "object", "properties": { "promotion_id": { "type": "string" }, "promotion_type": { "type": "string" }, "configuration_settings": { "type": "null" } } } }, "description": "The `campaign_info` object of the event's `data`. Which fields are present depends on the event." }, "FileInfo": { "type": "object", "description": "The result of processing an import file.", "required": [ "file_name", "status", "total_count", "success_count", "error_count", "processed_at" ], "properties": { "file_name": { "type": "string", "description": "The name of the imported file.", "example": "members_20260101.csv" }, "status": { "type": "string", "description": "`success` when every row was imported, `failure` when at least one row had an error.", "enum": [ "success", "failure" ], "example": "failure" }, "total_count": { "type": "integer", "description": "The number of rows in the file.", "example": 10 }, "success_count": { "type": "integer", "description": "The number of rows imported successfully.", "example": 7 }, "error_count": { "type": "integer", "description": "The number of rows that couldn't be imported.", "example": 3 }, "inserted_count": { "type": "integer", "description": "Member imports only. The number of members created.", "example": 5 }, "updated_count": { "type": "integer", "description": "Member imports only. The number of members updated.", "example": 2 }, "erroneous_file_url": { "type": [ "string", "null" ], "description": "A link to a file listing the rows that couldn't be imported and why, `null` when there were none.", "example": "https://example.com/imports/members_20260101_errors.csv" }, "processed_at": { "type": "string", "description": "When the file finished processing, in UTC, as `MM/DD/YYYY HH:MM:SS`.", "example": "01/01/2026 10:15:00" } } }, "JobInfo": { "type": "object", "description": "The result of a bulk job.", "required": [ "job_id", "schema_slug", "action", "payload_type", "status", "started_at", "completed_at" ], "properties": { "job_id": { "type": "string", "description": "The identifier of the bulk job.", "example": "6f1c2b7e-3f5a-4c1d-9b2e-0a8d7c6e5f41" }, "schema_slug": { "type": "string", "description": "The schema the job's records were written to.", "example": "purchases" }, "action": { "type": "string", "description": "What the job did with its records.", "enum": [ "create" ], "example": "create" }, "payload_type": { "type": "string", "description": "How the job's records were sent.", "enum": [ "json", "csv", "url" ], "example": "csv" }, "result_file_urls": { "type": "array", "description": "Links to the files listing the result of each row (`index`, `id` and `error`) of `csv` and `url` jobs. Empty for `json` jobs, whose results are returned by the job itself.", "items": { "type": "string" }, "example": [ "https://example.com/jobs/6f1c2b7e/results_1.csv" ] }, "status": { "type": "string", "description": "`success` when every record was processed, `failure` when at least one record had an error.", "enum": [ "success", "failure" ], "example": "success" }, "started_at": { "type": "string", "format": "date-time", "description": "When the job started, in ISO 8601.", "example": "2026-07-17T12:00:00+00:00" }, "completed_at": { "type": "string", "format": "date-time", "description": "When the job completed, in ISO 8601.", "example": "2026-07-17T12:00:05+00:00" } } }, "WorkflowRunInfo": { "type": "object", "description": "A workflow run that failed.", "required": [ "workflow_id", "workflow_run_id", "status", "failed_at", "errors" ], "properties": { "workflow_id": { "type": "string", "description": "The identifier of the workflow.", "example": "wf_8d2a6c1e" }, "workflow_run_id": { "type": "string", "description": "The identifier of the run that failed.", "example": "log_4b9e7f20" }, "status": { "type": "string", "enum": [ "failed" ], "example": "failed" }, "failed_at": { "type": "string", "format": "date-time", "description": "When the run failed, in UTC, in ISO 8601.", "example": "2026-07-17T12:00:00.123456+00:00" }, "errors": { "type": "array", "description": "The errors of the workflow's steps.", "items": { "type": "object", "properties": { "node_id": { "type": "string", "description": "The identifier of the step that failed.", "example": "node_3" }, "error": { "type": "string", "description": "What went wrong.", "example": "Member not found" } } } } } } }, "parameters": { "signature": { "name": "x-zinrelo-signature", "in": "header", "required": true, "description": "The HMAC-SHA512 hex digest of `:`, computed with the webhook's secret key. See [Webhook Event Signatures](/loyalty/guides/webhook-signatures.html).", "schema": { "type": "string", "example": "3f5c2a9e0b7d4e1f8a6c5b3d2e9f0a1b7c4d6e8f0a2b3c5d7e9f1a3b5c7d9e0f2a4b6c8d0e1f3a5b7c9d1e3f5a7b9c1d3e5f7a9b1c3d5e7f9a1b3c5d7e9f" } }, "nonce": { "name": "nonce", "in": "header", "required": true, "description": "The Unix time, in milliseconds, at which the request was signed. It's part of the signed message.", "schema": { "type": "string", "example": "1664265924123" } } }, "responses": { "retried": { "description": "Any status code other than `200` is a failure: the request is sent again every 5 minutes until your endpoint returns `200` or the maximum number of attempts (5 by default) is reached. Your Customer Success Manager can change these settings." }, "acknowledged": { "description": "Acknowledges receipt of the events. Return `200` as soon as you receive the request and process the events afterwards, so the request doesn't time out." } } } }