Application File Imports Release Notes Sync Web Services FAQ

Product Sales Transaction File Extended

Intended Application

For product-level transaction importing in which a single file may contain transactions of multiple transaction types from multiple locations. Supports either retail amount->point conversion via ALP SaaS transaction point formula, and also direct point entry in file.

 

Notes

  • Any delimiter, except for a semi-colon and [tab], can be used to separate columns.  The delimiter used is then specified at the time of file import.
  • Header record is required and column names must match those in the header record specified in the sample, with the exception of custom fields.  
  • All data rows are processed as records.  All items sharing the same transaction type and unique Transaction Id should be contiguous.
  • Unique Transaction Id should be different for return and purchase if the intention is to use the same transaction type.
  • If a missing product is encountered, the associated transaction is skipped unless the "Add Missing Product Flag" is set to 'Y'.

 

File Structure

DATA COLUMN

DATA TYPE DATA REQUIRED? FORMATTING NOTES

Activity Timestamp

Date/Time

Yes

MM/DD/YYYY HH:MM:SS

Based on a 24 hour clock
Booking Date Date No MM/DD/YYYY  

Account Id

Alphanumeric

Yes

 

 
Location External Reference Alphanumeric Yes    
Product External Reference Alphanumeric Yes   Typically the "SKU" for the product.
Add Missing Product Flag Alphanumeric Yes   Y = Add missing product, N = Do not add missing product.
Item Quantity Numeric No   If empty, quantity of 1 is assumed.

Total Retail Value

Decimal Yes 0.00  
Total Point Amount Decimal Yes 0.00 Only used when point formula is set to "direct point entry".
Total Profit Amount Decimal Yes 0.00 Only used when profit formula is set to "externally calculated".
Transaction Type External Reference* Alphanumeric Yes    
Unique Transaction Id* Alphanumeric Yes    
Transaction Custom Field(s) Varies No    

* - Denotes that the data column helps comprise the transaction unique key for this import file specification.

 

Sample File

1:
2:
3:
ActivityTimestamp,BookingDate,AccountID,LocationExternalReference,ProductExternalReference,AddMissingProductFlag,ItemQuantity,TotalRetailValue,TotalPointAmount,TotalProfitAmount,TransactionTypeExternalReference,UniqueTransactionId,EmployeeIdCF
11/20/2017 14:30:00,11/20/2017,R40,MALL,22222,N,1,500,500,310,GMPBD,16283712,3
11/20/2017 15:30:00,11/20/2017,R40,MALL,33333,Y,1,500,500,310,GMPBD,16623511,4

Aimia Logo

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.