Bulk Upload: New Orders
A bulk upload of new orders allows uploading of orders into the dynamic commissioning system. Orders that are bulk uploaded should never have been uploaded via a pixel (they are mutually exclusive).
We recommend pixel over bulk upload whenever possible, but know that may not be appropriate for everyone. Feel free to implement the method that you feel is appropriate for your needs and conditions. The dynamic commissioning system will process your rules in the exact same way.
No Personally Identifiable Information (PII) may be passed through the batch file. PII includes but is not limited to information which can be used to distinguish or trace an individual's identity, such as their name, social security number, email address, phone number, or physical address.
Bulk Upload: New Orders Fields Explained
| Field Name | Description | Required | Example | Data Type / Length |
|---|---|---|---|---|
| PROGRAM_ID | Your program ID. Your Account Manager will have this information. |
Required | 123 | Integer (10) |
| AFFILIATE_ID | The affiliate ID is provided by the subid field in the URL used to bring traffic to your site by an Affiliate in the Pepperjam. This will need to be captured and stored for later retrieval for your bulk upload. |
Required | 12334 | Integer (10) |
| CLICK_ID | Unique ID assigned by Pepperjam to each click record generated from a creative. This value is passed to the advertiser's website as the placeholder clid in the creative destination URL. This will need to be captured and stored so it can later be passed back in your bulk upload. Usage: A single or pipe-separated list of click IDs associated with the transaction's customer. Additional info: See Dynamic Tracking - Click ID Capture and Storage for more information. |
Required | 934023|934025 | String |
| ORDER_ID | An order ID that is meaningful to you (usually the order identifier/number in your system). Order items will be grouped together with this and should be unique per order. Allowed characters: alphanumeric (A-Za-z0-9), dashes (-), and underscores (_). |
Required | FT-13543422 | String (50) |
| ITEM_ID | An item ID or product SKU that is meaningful to you (usually the SKU identifier/number in your system). This is for an individual item in an order (denoted by ORDER_ID). Allowed characters: alphanumeric (A-Za-z0-9), dashes (-), underscores (_), periods (.), and colons (:). |
Required | SKU-423125 | String (50) |
| ITEM_PRICE | The unit price of the ITEM_ID. The price should reflect any coupon or discount that is applied to an order, and should be before shipping and taxes. This field may be set to zero (0). |
Required | 32.30 | Float |
| CURRENCY | The currency of the item prices being passed for the order. When not supplied, amounts are assumed to be in the program's native currency. Accepted values are the three-letter abbreviations of the currencies supported by our platform: USD, CAD, GBP, EUR, AUD, CNY, JPY, INR, KRW, SGD, RUB, TRY, BRL, MXN, ARS, CHF, HKD. |
Required | CAD | String (3) |
| QUANTITY | The quantity of ITEM_ID ordered. Must be a non-negative integer. |
Required | 2 | Integer (10) |
| ORDER_DATE | The date and time of the order. YYYY-MM-DD HH:MM:SS |
Required | 2015-05-13 11:03:27 | String(19) |
| CATEGORY | The category ID that is meaningful to you for ITEM_ID. | Optional | ABC123 | String(64) |
| COUPON | A single or pipe-separated list of promotional codes tied to a personalized coupon. This is used to ensure credit is given to the owner of the personalized creative, rather than someone who may have used it without permission. If a list is provided, the first valid code will be used. If a valid code is not provided, the sale will be attributed as normal. This also may affect commissions if you have a Coupon Rule set up in the applied Term. Note: This feature requires additional setup by your Account Manager. |
Optional | MYPROMO1 | String |
| NEW_TO_FILE | Whether or not the customer that placed the order is a new customer in your system using whatever business logic you deem appropriate. Note: This value should be 1 (one) if the customer is new or 0 (zero) if the customer is not new. |
Optional | 1 | Boolean |
| TYPE | Please use one of the following values: 1 - Sale Based Transactions (percentage of sale) 2 - Lead Based Transactions (Flat dollar payout) If not provided, 1 is assume |
Optional | 1 | Integer(1) |
| GOOGLE_CLICK_ID | Case-sensitive unique ID assigned by Google Ads each time a search ad is shown. This value is passed to the advertiser's website upon click as the placeholder gclid. This can be captured and stored so it can later be passed back in your bulk upload, where we will associate them with Pepperjam Network's Click IDs. Usage: A single or pipe-separated list of Google click IDs associated with the transaction's customer. |
Optional | TeSter-123|TeSter-124 | String(100) per ID |
| SEGMENT | Custom Segment can be used to pass any attribute that is meaningful to you with the order. | Optional | Remarketing | String(64) |
Bulk Upload: New Orders CSV
You will need to generate a data file in CSV (comma separated value) format. The file will need to have the field names in uppercase on the first line, with all the data on the following line(s).
A simple example:
PROGRAM_ID,AFFILIATE_ID,CLICK_ID,ORDER_ID,ITEM_ID,ITEM_PRICE,QUANTITY,ORDER_DATE,CATEGORY,COUPON,NEW_TO_FILE,TYPE, SEGMENT 123,456,934023,O-2015-93042,SKU-93492,33.99,2,2015-05-13 08:34:00,ABC123,,0,1,STUDENT 123,456,934023|934026,O-2015-93042,SKU-342,387.95,1,2015-05-13 08:34:00,ABC122,,0,1, 123,8834,939933,O-2015-10302,FREE-420,0,1,2015-05-13 10:09:34,ABCDEF,,1,1, MILITARY 123,8834,939933,O-2015-10302,SKU-9939,99.95,1,2015-05-13 10:09:34,ABC123,,1,1, TEACHER 123,2202,949900|9499001|9499020,O-2015-33399,BONUS-3433,1.99,1,2015-05-13 10:25:03,ABC111,FREEAIRFRESH,1,1, 123,2202,949900,O-2015-33399,CAR-3422,34001.13,1,2015-05-13 10:25:03,ABC111,FREEAIRFRESH,1,1,
The file naming standard for new order CSV is:
PROGRAM_ID_transactions_new_YYYYmmddHHMMSS.csv
Simple PHP code snippet to create filename:
$program_id = 123;
$filename = $program_id . '_transactions_new_' . strftime('%Y%m%d%H%M%S') . '.csv';
6.3. Bulk Upload: New Orders Upload Instructions
Your Account Manager will need to log into the Pepperjam Control Panel and add the SFTP/FTP file server and path to where bulk uploads are stored, represented like ftp://ftp.server.com/pepperjam/bulkuploads/ Or sftp://user:password@server.com/home/user/pepperjam/bulkuploads . The dynamic commissioning system will attempt to log into ftp.server.com via FTP protocol on port 21 (or server.com via SFTP protocol on port 22), change directory to /pepperjam/bulkuploads/ and look for any files in that directory matching the expected pattern. After the files are processed, they will be deleted from the SFTP/FTP server.
The CSV can also be manually uploaded in the control panel.
All times must be sent and will be reported in Eastern Time. Times are representative of Daylight Savings Time.