Point of Sale Upload
This page details the CSV file format used for uploading Point of Sale (POS) data in order to integrate transaction information with RetailNext for analysis and to derive additional metrics; such as conversion, shopper yield, etc.
Below is a list of general topics and Admin Settings that relate to file uploads.
File Upload Configuration to configure what the system should expect from file uploads, such as the timestamp format and column order
File Upload Access to setup direct POS integration (supported vendors only) or to get the details to use when uploading files over HTTP or SFTP from an automated system
File Upload Status for viewing previously uploaded files, their upload statuses, or to manually upload a file
Using CSV Files to learn more about generating and uploading CSV files to RetailNext
POS data may also be uploaded via the RetailNext API. This allows you to upload individual (or a small set of) transactions as they happen, and thus see near real-time updates to metrics like conversion. The API also has much higher frequency/quantity limits compared to CSV upload. For instructions on using the RetailNext API, please see API | Point of Sale.
Uploading POS Data
For each period of transaction data, the system requires two uploaded files.
Transaction - high-level information for each transaction occurring within that period (eg. the transaction total)
Line Item - detailed information about the products pertaining to each transaction (eg. the product SKU)
In order to make optimal use of the Asset Protection Dashboard, you’ll need to provide some additional transaction and line item fields. The columns required for POS Exceptions are noted in both file format instructions below.
File Format - Transaction
Filename: Begins with “TransactionInfo_” and ends with “.csv”. Files are often named for the time period they cover, eg: “TransactionInfo_YYYYMMDD_HHMMSS.csv”.
Column | Identifier | Identifier in POS Upload API | Required for POS Exceptions? | Value | Example Value |
---|---|---|---|---|---|
Store ID* | StoreID |
| Y | Store identifier that matches the configured Store ID in Admin Settings > Locations. If POS Store ID is enabled, you must use that value. | RNP |
Transaction ID* | ReceiptNumber |
| Y | Unique identifier of the transaction. | ARO502218097 |
Terminal ID* | WorkstationID |
| Y | Identifier of the POS terminal where the transaction was performed. | Terminal 13 |
Timestamp* | ReceiptDateTime |
| Y | Date and time of the transaction, with default format YYYY‐MM‐DD HH:MM:SS (format configurable in Admin Settings > File Upload Configuration > POS). Timestamps are interpreted per the store’s configured timezone. | 2016-06-22 11:01:00 |
Line Items Total* | LineItemsTotal |
| Y | Total before tax and transaction-level discounts; i.e. the sum of all line items that were part of the transaction, including line-item discounts. This value can be negative for return transactions. | -39.58 |
Transaction Total* | TransactionTotal |
| Y | Amount the customer pays, including tax and transaction-level discounts. This value can be negative for return transactions. | -27.651 |
Cashier ID | OperatorIDs |
| Y | Unique identifier of the employee who perfomed the transaction. This must be included and must match the value used when integrating staffing data. Multiple Cashier IDs are supported when separated with a semicolon. | Emp1005_Justin |
Transaction Type | TransactionType |
| Y | The type of transaction; e.g. | RETURN |
Transaction Status | TransactionStatus |
| Y | Indication of transaction success; e.g. Note that | Successful |
Payment Type | PaymentType |
| Y | Method of payment used for the transaction. See the Appendix for a list of supported payment types.
| cash |
Tax Amount | TaxAmount |
| N | Total tax paid on transaction. This value can be negative for return transactions. | -1.650 |
Sales Associate ID | SalesAssociateID |
| N | Unique identifier of the employee who should be recognized for the transaction, used when integrating staffing data. Multiple Sales Associate IDs are supported when separated with a semicolon. | 1112 Sally Smith |
Currency Code | CurrencyCode |
| N | The currency used for the transaction. See the list of supported currency codes.
| USD |
Transaction Subtype | TransactionSubType |
| N | Used only for custom reporting purposes; not visible anywhere in the cloud interface. Valid values and formatting detailed below this table. | Walk-in |
Category | Category |
| N | Indication of whether to include the transaction in data mining calculations. Valid values and formatting detailed below this table. | Retail |
Voided Transaction ID | VoidedReceiptNumber |
| N | The ID of the transaction being post-voided. This is used when the transaction ID of the post-voiding transaction (the one with status set to post-void) is different than the ID of the original transaction that is being voided. Should be left blank for transactions that are not post voids. See Transaction Status Details below this table for more information. | ARO502218097 |
Division ID | DivisionID |
| N | Additional store identifier that matches the store’s configured Division ID in Admin Settings > Locations. Only required when Division ID is enabled to allow for duplicate Store IDs. | 037 |
* required column