Recent Customer Purchase Upload
Upload a list of recent customers who have made purchases from your business for targeting purposes.
Overview
When initially launching your referral program, if marketing wishes to run campaigns that are targeted to acquire new customers, you can provide recent customer purchases to Extole so current active customers' referred purchases do not reward an advocate.
Note
Once you have launched your program with conversion tags or the conversion API, Extole will automatically store recent purchase information. Uploading recent purchases is only necessary a single time at launch if you wish to exclude historical customers.
Acquisition campaigns normally include both brand new customer and win-back customers who haven't made a purchase in the prior 12 months. You do not need to load your entire purchase history, but only the previous 12-months and only the most recent purchase by a customer.
You can either use the Extole API to send in Events or you can use an Event File uploaded to My Extole or SFTP.
API Call
Preconditions
Make sure you have generated API keys through the My Extole Security Center.
After creating an API Key in My Extole, you can use the Create Event API call to send in the list of recent purchases via API call with each purchase uses a single call to Extole:
POST https://api.extole.io/v5/events
{
"event_name":"conversion",
"data":{
"required_labels":"existing_customer",
"email":"[email protected]",
"first_name":"julio",
"last_name":"friend",
"partner_user_id":"ABcd234A1s",
"partner_conversion_id":"12294838abs2",
"event_time":"yyyy-MM-dd'T'HH:mm:ssZ",
"cart_value":"100"
}
}
Input Parameters
| Input Parameter | Description |
|---|---|
data.partner_conversion_idrequired | The unique identifier of the conversion event, typically an order number. This is required to ensure there are no duplicate conversions sent to Extole and for report reconciliation. Maximum of 38 characters. |
data.partner_user_idsometimes required | Your unique identifier of the customer. This is not required, but is recommended so that if this identifier is passed in again during a future purchase, this person can be recognized as an existing customer. Either the partner_user_id OR the email is required. |
data.emailsometimes required | The email address of the customer. This is not required, but is recommended so that if this email is passed in again during a future purchase, this person can be recognized as an existing customer. Either the partner_user_id OR the email is required. |
data.first_name | The first name of the customer. |
data.last_name | The last name of the customer. |
data.cart_valuerecommended | The revenue value of the transaction used for reporting. |
data.event_time | The date when the purchase/conversion was created |
File Upload
You can also upload an existing customer file to your SFTP account at My Extole or through your Account inside of My Extole.
Event File Records
| Column Name | Required | Validation | Description |
|---|---|---|---|
event_name | Yes | eventname | The type of event to create from the list (e.g., conversion). |
required_labels | Yes | existing_customer | The required labels field ensures that the events are properly mapped as existing customer upload (not a new referral conversion). |
email | Maybe | 256 characters | The email address of the customer. This is not required, but is recommended so that if this email is passed in again during a future purchase, this person can be recognized as an existing customer. Either the partner_user_id OR the email is required. |
partner_user_id | No | 38 characters | Your unique identifier of the customer. This is not required, but is recommended so that if this identifier is passed in again during a future purchase, this person can be recognized as an existing customer. Either the partner_user_id OR the email is required. |
first_name | No | 38 characters | The event creator's first name. |
last_name | No | 38 characters | The event creator's last name. |
event_time | No | ISO_8601 DateTime | The date and time of the event as ISO_8601 format. Generally this is YYYY-MM-DDThh:mm:ssZ (e.g. "2013-08-11T14:33:18-0700"). If not provided, Extole will use the processing time of the event file as the event time. |
partner_conversion_id | No | 38 characters | The unique identifier of the conversion event, typically an order number. This is required to ensure there are no duplicate conversions sent to Extole and for report reconciliation. |
cart_value | No | Number with two decimal places | The revenue value of the transaction used for reporting. |
Filename: /events/2147483647_conversion_20130619000000.csv
event_name,required_labels,email,event_time,partner_conversion_id,cart_value
conversion,existing_customer,[email protected],2013-06-19T10:12:53-0700,00540000001PULM,20.34
conversion,existing_customer,[email protected],2013-06-19T11:42:51-0700,00540000001O1fi,100.28
conversion,existing_customer,[email protected],2013-06-19T12:16:12-0700,0064000000QP7SN,99.99
Updated 12 months ago