FTP Batch Solution Overview


 

 

The purpose of this document is to illustrate the scope of work needed for tracking within Impact via FTP Batch. Number of events and programs included will be referenced in your PO.

 

Summary

  • Tracking purchases (online sale) that happen on your website.
  • The sales will be reported to Impact via batch files.
  • Impact will dynamically populate the query string parameter irclickid in the landing page URLs for affiliate traffic. If the clickid is present in the URL – capture the value and store it in a cookie or server side.
  • Submitted batch files will include details of the lead or the order and items purchased.  If there is a data point that influences the way you want to pay your partners you will want to check with your developer that it is available in your data layer to pass into thefile.

 

Implementation Flow

  • Customer lands on site
  • Irclickid query string parameter populated in landing page URL (example: www.mysite.com?irclickid=RRCR4ixN-xyJUbT0UfQwQyYMUkgQpaVcw05JRM0)
  • Irclickid value is captured and stored by you via cookie or server side
  • Customer completes lead/purchase event(s)
  • Events to be batched into Impact via (S)FTP
  • Batch files should be submitted in a daily automated process
  • Data points sent via FTP are what are used to calculate commission
  • When a conversion event takes place, store the most recent clickid you have captured with the conversion event server side

 

  • If an active partner was the last click for a given event, the lead/purchase will post to reporting with commission calculated per your contract with them

 

  • If the customer returns an item or cancels their order you can update the sale within Impact
  • Returns can be made within the window you specify in your contract with the partner
  • Returns can be made by you directly within the Impact UI or you can choose a more automated method like FTP or API – for more information, see Impact’s Modifications and Reversals Overview.

 

 

 

 

*SAMPLE BATCH FTP FILE BELOW*

Batch FTP File – Online Sale – SAMPLE

Once an online sale occurs, you will pass back the ClickId value in the csv format below. FTP credentials to send this file to batch.impact.com will be provided during onboarding.

 

CampaignId,ActionTrackerId,ClickId,EventDate,OrderId,CustomerId,CustomerEmail,CustomerStatus,CurrencyCode,PromoCode,Amount,Category,Sku,Quantity

1234,567894,ClickID123,30-JAN-2022+22:10:24+PDT,OID123,CustomerID123,E770F63FB589B4AB972009B5AD8D836B,New,USD,PromoCodeXyz,SubTotal1,Cat1234,SKU1234,1

 

Action Tracker Parameters

  • CampaignId: (Required) Value will be provided in onboarding. (Integer)
  • ActionTrackerId: (Required) Value will be provided in onboarding. (Integer)
  • ClickId: (Required) The unique Click ID for the click captured on the initial landing page’s query string. This value must be passed in order to credit partners. (String 128)
  • EventDate: (Required) Use dd-MMM-yyyy HH:mm:ss z or ISO-8601 format.
  • OrderId: (Required) The unique order ID for the event. (AlphaNumeric 64)
  • CustomerId: (Required) Unique customer identifier your platform assigns to customer accounts. If you want to associate a downstream event with this order, customer IDs for subsequent actions this customer takes must match. (String 255)
  • CustomerEmail: (Recommended) SHA1 hash of customer’s email. (String)
  • CustomerStatus: (Recommended) Use values of “New” or “Returning”. (String)

 

Following data points only applicable to Sale events:

  • CurrencyCode: (Required) ISO 4217 currency code (e.g. USD). (String 3)
  • PromoCode: (Required) Coupon / Promo code (Leave empty if there is no promo code for the order). If more than one is used, only one can be reported to us in this field. This value can be used to alter payouts. (String 255)
  • Amount: (Required) Subtotal amount of SKU-set (quantity * price), pre-tax, pre-shipping, and post-discount. (Decimal 8,2)
  • Category: (Required) Item category identifier. (String 255)
  • Sku: (Required) Item specific identifier. (AlphaNumeric 40)
  • Quantity: (Required). Quantity of the given item. (Integer)