Purchase History - file setup
What is Purchase history and what can I use it for?
In order to get started basic knowledge of Carma’s list and contact management is required. Readers are assumed to have some familiarity with Carma’s graphical interface.
General workflow
In order to start an import you will need to prepare a file. The format of the purchase history data is very strict. It must have this exact format or the import will fail. The delimiter must be semicolon (;) and the columns must have the order specified below. There are some columns that are mandatory and some that are optional. If you want to include optional fields all optional fields prior to you field in the order must be included. The data may be empty, so you can just add semicolons for the intermediate optional fields that you do not want to add. The custom fields can be named for the user in the carma UI.
NOTE! The file must not contain a header row. The first row should contain data.
Column Id | Field | Description |
0* | Originalid | Your id of the contact the data should be associated with |
1* | Sku/Custom1 | Stock Keeping Unit |
2* | itemPrice | Price of one unit with point (.) for decimals, i.e. 20.50 |
3** | Transaction Time | Time in ISO-8601 format; yyyy-MM-dd HH:mm:ss |
4** | No of Items | |
5 | Total price | itemPrice*noOfItems |
6 | Custom2 | custom value |
7 | Custom3 | custom value |
8 | Custom4 | custom value |
9 | Custom5 | custom value |
10 | custom6 | custom value |
11 | Custom7 | custom value |
12 | Custom8 | custom value |
13 | Custom9 | custom value |
14 | Custom10 | custom value |
15 | Custom11 | custom value |
16 | Custom12 | custom value |
17 | Custom13 | custom value |
18 | Custom14 | custom value |
19 | Custom15 | custom value |
20 | Custom16 | custom value |
21 | Custom17 | custom value |
22 | Custom18 | custom value |
23 | Custom19 | custom value |
24 | Custom20 | custom value |
25 | Custom21 | custom value |
26 | Custom22 | custom value |
27 | Custom23 | custom value |
28 | Custom24 | custom value |
29 | Custom25 | custom value |
30 | Custom26 | custom value |
*Mandatory fields
** Not mandatory, but strongly recommended
NOTE! In order for data in custom fields to be parsed correctly, dates must be formatted in ISO-8601 and prices should be formatted as 000000.00 (decimal point)
NOTE! The data is append only, so if the same data is imported twice the second import will append, not overwrite the previous import.
Make sure that your file is in a valid CVS format. For instance, you cannot have a single ” in the data ( as in 6″ monitor) in the data as this will make the CVS file invalid.
When your file has been prepared, upload it to your Carma FTP.
Your contact at Compost will help you verify the file and finish the set up.
A credit row is when the Quantity is a negative number.
When a credit row is imported, the number (Qty) is reduced to zero regardless of how many PH lines it requires.
Example
row Orignalid Sku Qty
1 A100 iPhone 2
2 A100 iPhone 3
3 A100 iPhone 2
If you then import a credit row with “-3” (Qty)
Then, the following is meant to happen
row Orignalid Sku Qty
1 A100 iPhone (credited)
2 2 A100 iPhone 2 (reduced by 1)
3 A100 iPhone 2
In other words, lines 1 and 2 is decreased in adjustment to the “-3” in the credit line.
“COLUMN1” is special in the way that, in combination with the column “Transaction Date” it can be used to identify a specific row to set as credited (if count <0). It should then (if you want to be able to handle credit-lines) be a unique product identifier.
After import a credited row is listed in a “blue” color on the recipient “contact card” (the color is picked by our UI designers for best readability among variations of color-blindness.
Credited rows will be neglected by PH segments based on “purchased” rules, and solely targeted by PH segments based on “Credtied” rules.