Application File Imports Release Notes Sync Web Services FAQ

Reward Sync

The Reward Sync is used to export batches of reward issuances and changes with related information. The Reward Sync is unique in that there is a variable amount of columns in each record that is governed by the trigger type. Some data is optional and is configured within the “Sync Settings” page. If member reward custom field value data is enabled, this data will accompany “issued” and “redeemed” triggers as standalone records within the sync file(s).  

Upon each execution, all member changes since the last execution will be included in the sync file with current information. Files are then FTP’d to the predetermined location. 

Each of the Sync triggers will include a Record Type that corresponds to the type of trigger that occurred. The Record Types are identified as follows:

  1. Issued Trigger
  2. Redeemed Trigger
  3. Cancelled Trigger
  4. Redemption Reversal Trigger
  5. Expired Trigger
  6. Member Reward Custom Field Value Data Trigger

Note: This information is available as a PDF for portability. Reward Sync.pdf

Reward Sync

Name Standard_Reward_Sync_DB_SYNC#_YYYYMMDDHHMMSS.txt

DB = Customer DB Internal ID  
SYNC# = Sync Session ID  
Format Pipe delimited
No header record
Variable column count (see trigger type information)
Frequency  Daily
Source Smart Button
Contents Reward-related trigger data in ALP SaaS since the last sync file execution 

Issued Trigger

Field Name Type  Notes 
Record Type  Numeric(1)  Always 1 
Reward Id Numeric(20)  Internal ALP SaaS Reward Id 
Internal Member Id  Numeric(20)  
Reward Barcode String(40)  
Reward Type External Reference  String(20)  
Reward Type Name String(120)  
Retail Value Float(21)  
Point Value Float(21)  
Issued Timestamp (Database Timezone)  Date/Time YYYY-MM-DD HH:MM:SS (24hr clock)  
If Include Source Dates is enabled, this value is UTC 
Member Email String(256)  
Member Mobile Phone String(30) See Article for Phone Number Formatting 
Member First Name String(60)  
Member Last Name String(60)  
Issued Source Date Date YYYY-MM-DD Optional Field  
Configured in Sync Settings
Expiration Date Date YYYY-MM-DD Optional Field  
Configured in Sync Settings
Your Cost Float(21) Optional Field
Configured in Sync Settings
Updated Expiration Date Date YYYY-MM-DD
Only displayed if "Include Reward Expiration Dates in Issue Trigger" is selected in Sync Settings
and reward expiration date was updated prior to redemption or cancellation.

Example Data

1|247234|34172|247234|SRA|Super Reward A|0.05|5|2015-05-13 12:53:11|zwolf@smartbutton.com|1-(555) 555-5555|Zachary|Wolf

Redeemed Trigger

Field Name Type  Notes 
Record Type  Numeric(1)  Always 2 
Reward Id Numeric(20)  Internal ALP SaaS Reward Id 
Internal Member Id  Numeric(20)  
Reward Barcode String(40)  
Reward Type External Reference  String(20)  
Redeemed Timestamp (Database Timezone)  Date/Time YYYY-MM-DD HH:MM:SS (24hr clock)  
If Include Source Dates is enabled, this value is UTC 
Redeemed Location String(20) Location External Reference
Redeemed Source Date Date YYYY-MM-DD Optional Field  
Configured in Sync Settings page

Example Data

2|247234|34172|247234|SRA|2015-05-14 14:00:01|1000 

Cancelled Trigger

Field Name Type  Notes 
Record Type  Numeric(1)  Always 3 
Reward Id Numeric(20)  Internal ALP SaaS Reward Id 
Internal Member Id  Numeric(20)  
Reward Barcode String(40)  
Reward Type External Reference  String(20)  
Cancelled Timestamp (Database Timezone)  Date/Time YYYY-MM-DD HH:MM:SS (24hr clock)  
If Include Source Dates is enabled, this value is UTC 

Example Data

3|247235|34172|247235|SRA|2015-05-14 14:00:02

Redemption Reversal Trigger

Field Name Type  Notes 
Record Type  Numeric(1)  Always 4 
Reward Id Numeric(20)  Internal ALP SaaS Reward Id 
Internal Member Id  Numeric(20)  
Reward Barcode String(40)  
Reward Type External Reference  String(20)  

Example Data

4|247234|34172|247235|SRA

Expired Trigger

Field Name Type  Notes 
Record Type  Numeric(1)  Always 5 
Reward Id Numeric(20)  Internal ALP SaaS Reward Id 
Internal Member Id  Numeric(20)  
Reward Barcode String(40)  
Reward Type External Reference  String(20)  
Expiration Date Date YYYY-MM-DD

Example Data

5|246150|71318|F_20152|F2015|2015-05-12  

Member Reward Custom Field Value Data

Field Name  Type  Notes 
Record Type  Numeric(1)  Always 6 
Trigger Type  Numeric(1)  1 = Issued
2 = Redeemed 
Reward Id  Numeric(20)  Internal ALP SaaS Reward Id 
Internal Member Id  Numeric(20)  
Member Reward Custom Field External Reference  String(40)  
Member Reward Custom Field Datatype Numeric(1) 1 = Checkbox  
2 = DropDown  
3 = Integer  
4 = Money  
5 = Text  
7 = Date  
8 = Address  
9 = Multi Checkbox
Member Reward Custom Field Value  Variable Checkbox datatype: “True” or “False”    

DropDdwn datatype: Dropdown Value External  Reference  

Integer, Money, Text datatypes: Actual Value  
 
List datatype: Length of List    

Date = Actual Value (YYYY-MM-DD format)    

Address datatype: C/O Value    

Multi Checkbox datatype: Number of checkboxes checked
Member Reward Custom Field  Additional Info   Variable Address datatype: contains 6 additional columns  (Line 1, Line 2, City, State/Region, PostalCode, Country)    

Multi Checkbox datatype: contains a variable amount of additional columns, with external references for the selected checkboxes.

Example Data

6|1|247234|2|Money_1|4|320.00
6|1|247234|1|Checkbox_1|1|False  
6|1|247234|4|Date_1|7|2015-01-02  
6|1|247234|5|Address_1|8|John|100 Main St|Apt. 4|Newark|DE|19701|US  
6|1|247234|6|MultiCheckbox_1|9|2  

Please note: All external ALP SaaS links and references are directed to US datacenter unless specifically noted.


Tags:
Home: Aimia Loyalty Platform SaaS Wiki
Copyright © 2019 Aimia Inc. All Rights Reserved.
What's new: Recently changed articles