The purpose of the Historical Order Feed is to provide order data that you would like to use in your marketing activities with ActivatePro. The imported feed will create the following events:
- “Completed Order” events which will state that an order has been placed
- “Ordered Item” events
Furthermore, it is possible to use Order Feed to generate general events that you wish to use with ActivatePro and which are not sent via Web Tracking or Public API.
If you are using the order feed for your orders, please note that this is not real-time, so we highly recommend Web Tracking or API for real-time activity.
The file you have uploaded will be processed with a cronjob which will run every 15 minutes. We suggest however to upload your order feed if needed hourly instead.
Naming Convention
The naming convention for the order file is the following:
order_history_YYYYMMDDHHMMSS.json (UTC)
Order History File
This data file contains an array of objects which contain the data of the users that should be loaded into ActivatePro. Each object defines the attributes of a single user.
In case you use multiple stores with a separate SKU or ID logic each, you will need to include a business unit that the product belongs to. The combination of business unit and Order ID needs to be unique in that case.
The .JSON file consists of an array of objects . Each of these objects represents one order will have the default keys shown below:
| Key | Description | Data Type | Required | Example |
|---|---|---|---|---|
| event | Name of the Event you’re sending | string | yes | |
| orderId | ID of the order | string | yes | SK13332 |
| id | ID of the purchasing customer (should be the same as in the User Feed) | string | yes | DE85328 |
| timestamp | The timestamp of the order. | Datetime (YYYY-MM-DD hh.mm.ss.μμμ+UTC) | yes | 2016-04-18 07:00:43.591+02 |
| total | The total amount of the order in currency | float | yes | 49.99 |
| shipping | The shipping fee of the order | float | no | 5.00 |
| discount | The discount amount of the order | float | no | 10.00 |
| coupon | The voucher code used for the order | string | no | SUMMER16 |
| currency | The currency of the total amount of the order | string | yes | EUR |
| products | The purchased order items | array of objects | yes | See 'Order Feed Example' below |
| cart | The object containing a user's desired order items | array of objects | yes | See 'Order Feed Example' below |
The id refers to the user identifier you have assigned to a customer in your data warehouse and is named externalId in other places in the platform incl. the UI. This is the same id you might be already sending through our Tracking SDK or User Management API.
The combination of email and businessUnit of a user or lead is also a unique identifier and can be used instead or additionally to the external Id when importing events.
Please note that if there can be leads (users without an external Id) in the platform and you are also using the user feed import to upgrade these leads to full users (by adding the external Id to a profile with the matching email and businessUnit) then the user feed import needs to run first before any event- or orderfeed, or the system can't match the ids and creates new users instead.
This will not be necessary, if you include the email and businessUnit in the order events.
Order File Example:
It's possible to use more properties for each order than listed above. Please contact your account manager for this possibility.
order_history_20160321110559.json
[{
"event" : "Completed Order",
"orderId" : "50314b8e9bvf000000000000",
"businessUnit" : "DE",
"id" : "DE62305",
"email":"example@example.com",
"businessUnit":"activatepro",
"timestamp" : "2015-08-24 15:28:51.591+02",
"cart" : {
"total" : 24.5,
"shipping" : 2.5,
"numberOfUniqueItems" : 2,
"numberOfItems" : 3,
"currency" : "EUR",
"products" : [
{
"id" : "507f1f77bcf86cd799439011",
"sku" : "45790-32",
"name" : "Monopoly: 3rd Edition",
"price" : 19.0,
"currency" : "EUR",
"quantity" : 1,
"category" : "Games",
"supplier" : "Games supplier",
"brand" : "table games"
},
{
"id" : "505bd76785ebb509fc183733",
"sku" : "46493-32",
"name" : "Uno Card Game",
"price" : 3.0,
"currency" : "EUR",
"quantity" : 2,
"category" : "Games",
"supplier" : "Games supplier",
"brand" : "table games"
}
]
}
}]