Importing Order Data

1 Overview
2 Usage
3 Feed Formats for Order data
4 File Format Requirements
5 Orders Data Feed
6 Order Items Data Feed
7 Sample Files

Overview

Hawksearch requires a tracking code to be implemented on your site. This code will gather data real-time and will be used to generate recommendations based on the users browsing your site.

In order to utilize Recommendations prior to the real-time data collection, order history data can be provided to Recommendation engine. The order history data does NOT need to include any customer identification details. This document will describe the necessary feeds that are required.

Usage

Importing Order Data is impacting product Popularity Sales boost. Based on the factor defined under 'AI Based Multipliers' section, the boosting is applied for imported data.

More information can be found in section AI Based Multipliers

Feed Formats for Order data

The Recommendations engine will utilize your website’s order history, broken out into two separate files, and representing activity from the last 30 days.

orders.txt

This file represents the summary of the orders from the last 30 days.

order_items.txt

This file represents the items contained within the orders defined in the orders.txt file.

Please review the data feed format for each file. If a particular column does not appear to apply to your data, please bring this to the attention of your Hawk Search implementation representative for further clarification.

File Format Requirements

File Size Limit

The maximum file size that can be imported is 4096 kB. Larger files needs to be spitted and imported separately.

Flat-File Format Properties

Encoding	UTF-8
Column Delimiter	Tab
Column Headers	Required, case insensitive Column Headers are allowed in plain text or in quotation marks. For example: OrderId, orderid, "orderid" or "OrderId"
Row Delimiter	Unix Format (\n as a row delimiter)
File Name	Lowercase and should match names specified above

Orders Data Feed

FILE NAME: orders.txt

The Orders Data Feed consists of order summary data from the site over the last 30 days, provided in a single file named orders.txt.

Required Data Columns

Name	Type	Data Description	Required	Sample Value
OrderId	String	Alphanumeric ID value representing the order identifier. This is usually generated by your ecommerce system and is unique.	Yes	AA123
OrderNo	String	Alphanumeric value representing the order number, if it is different than the OrderId. If it is the same, please use the OrderId in this field. Typically unique.	Yes	AA123
SubTotal	Decimal	The total of items in the order before taxes or shipping costs.	Yes	12.34
Tax	Decimal	The amount of tax associated with this order.	Yes	1.23
Total	Decimal	The order total, or the amount that includes shipping, taxes and all associated costs.	Yes	13.57
Currency	String	The currency format used by the order (USD, EURO, CAD)	Yes	USD
CreateDate	MM-DD-YYYY	The date the order was submitted and completed in UTC	Yes	01/23/2014
MemberId	String	The unique identifier representing the customer. This is usually generated by your ecommerce system. This usually will not contain details such as the customer name.	Yes	ZZ1234

Order Items Data Feed

FILE NAME: order_items.txt

The Order Items Data Feed will contain the items associated with each order defined in the Orders Data Feed. This items should be grouped by its order identifier, and provided in a single file named order_items.txt.

Required Data Columns

Name	Type	Data Description	Required	Sample Value
OrderId	String	Unique Alphanumeric ID. This should correspond to the OrderId column specified in the orders.txt file	Yes	AA123
ItemId	String	Alphanumeric identifier for the item. This should be the unique number or internal identifier used track item. This is typically ItemId, SKU or ProductID.	Yes	AABB123
Price	Decimal	The per unit item price.	Yes	123.45
Quantity	Integer	The number of items purchased in this order.	Yes	123

Sample Files

Navigate to the Import Order Page, click on the “Workbench“ tab on the top navigation. Select Recommendations Imports, and select a zip filed for the upload. If nor errors, the store import will be added into an importing queue. After successful upload, a Dashboard message will appear:

Navigate to Admin Menu and Tracking Event Preview option. List of imported orders will be visible as a ‘Event Sale’:

Request Details:

The new preview boosting will be refreshed within the next 24 hours. As the order import is affecting up to the last 30 days, Hawk process needs to recalculate the purchasing data and include the import.

Preview with Popularity Sales before import:

Preview with Popularity Sales after import: