This article discusses how to implement an Order Feed. To learn more about Order Feeds and their features and considerations, click here. To learn more about troubleshooting your Order Feed, click here.
This article contains the following sections:
- Required Fields
- Optional Fields
- Creating Your Order Feed
- Uploading Your Order Feed
- Recurring Order Feed
- Recurring Order Feed Upload History
- Manual Order Feed
Required Fields
The following fields are required to successfully set up your Order Feed. Each row is required for each product ordered.
Field | Example | Description | Length |
page_id | H8572G | The same page_id that you provided to us in your product data. Each Follow-Up Email includes 10 products per order. This field is case-sensitive and should not include spaces. | Up to 50 characters |
order_id | C019385 | The unique identifier for an order that you specify. PowerReviews doesn't control this identifier. Include for each page_id even if duplicated. | Less than 50 characters |
first_name | James | The customer's first name for a particular order. You can insert this value in the email itself using the {FIRST_NAME} variable. Include for each page_id even if duplicated. | Less than 255 characters |
last_name | Smith | The customer's last name for a particular order. Include for each page_id even if duplicated. | Less than 255 characters |
jsmith@gmail.com | The customer's email address for a particular order. Multiple orders with the same email address are merged into a single email. Include for each page_id even if duplicated. | Less than 255 characters | |
order_date |
2019/09/28 2019-08-28 09 28 2019 |
The Follow-Up Email is sent 21 days after the order date, unless you specify otherwise. If no date is provided, or the order date is more than 21 days ago, the email is sent the following day. Note that emails aren't sent for orders older than 6 months. If you want to send an email for an order that is 6 months old or older, leave the this field blank. Additionally, dates must be in the past. We cannot accept future order dates. Format order dates as YYYY MM DD or MM DD YYYY. Year should be 4 digits, month as 2 digits, and day as 2 digits. You can separate the digits by slashes, dashes, or white space. Include for each page_id even if duplicated. |
|
locale | en_US | The locale is specific to the merchant. This value will be provided by PowerReviews. |
Optional Fields
The following fields may be required to successfully set up your Order Feed.
Field | Example | Description | Length |
variant | 4871283 | The same page_id_variant that you uploaded in your Product Feed. Each Follow-Up Email includes 10 products per order. This field is case-sensitive and should not include spaces. | Up to 50 characters |
user_id | bhfjsk3 | Unique identifier for the customer writing the review. Typically this is your internal User ID or Customer ID. This ID will be passed through to the Write-a-Review page setting the variable pr_merchant_user_id with this value. |
Creating Your Order Feed
1. Prepare your file to send to PowerReviews, noting the requirements above. You should format the file with UTF-8 encoding, and with no byte order mark (BOM).
- Click to download an Order Feed sample CSV file.
2. Edit the sample file you downloaded with your own customer orders, keeping the PowerReviews' field names as column headers.
Uploading Your Order Feed
Once your Order Feed has been created, you are ready to upload the file. You can either create a recurring file job that will enable PowerReviews to automatically upload your Order Feed on a regular basis (recommended), or you can perform a one-time manual upload. Both options are explained further below.
Recurring Order Feed
The most reliable way of ensuring that PowerReviews gets your Order Data on a regular basis is to set up a Recurring Order Feed. When setting up a Recurring Order Feed, there are additional considerations when creating the file:
- Make sure the file contains at least 3 days' worth of orders on a rolling basis. We recommend somewhere between 3-5 days, depending on your order volume.
- Ensure that the filename and location are static. When we configure the Order Feed import on our backend, it relies on looking for the same file each time. If you need to rename your file or move it to another location, you will need to contact us when this occurs so that we can update your configuration. You cannot append a date or other variable information in the filename.
When the file is ready, please reach out to your Implementation Team or PowerReviews Technical Support to request that we configure your Order Feed for import into our system.
Note: The file will be picked up at 8pm Central Time on a daily basis. Any files that are updated after that time will not be processed until the following day.
Recurring Feed Upload History
Once you have configured your Recurring Order Feed, you will be able to check the status of its daily ingestion. Once the process is complete, the following information will be provided:
- Date Uploaded - The date when Order Feed file was processed
- File Name - The original file name and ability to download
- Total Items - The total number of orders in the file
- New Items - New orders found in the file
- Items Failed - Orders that failed
- Duplicate Items - Orders that already existed in our system
- Status - Overall status of the Order Feed file that was processed
Example:
If some orders failed to ingest, download the Items Failed file by clicking the blue cloud icon. The file will provide you with a line-by-line breakdown outlining the errors and how to fix them. Fix the errors and include them in the recurring file to be picked up next day. Continue this process until all orders have been ingested successfully.
Manual Order Feed
If you simply want to upload a one-time file of past orders, you can use the Manual Order Feed option.
1. Log into the PowerReviews Portal.
2. Click +Setup in the left navigation menu.
3. Click Order Feed Manager on the Products page.
4. Click on the Manual Upload tab.
5. To upload your file, you can either click and drag your file into the uploader or click Choose File and navigate to where your Order Feed is locally stored.
6. The Order Feed will then begin processing and will appear in the Manual Upload History table.
7. To see if the file has completed processing, click the Refresh button. Depending on the size of the file, it may take up to 10 minutes or more to process.
8. Once the process is complete, the following information will be provided:
- Date Uploaded - The date when Order Feed file was processed
- File Name - The original file name and ability to download
- Total Items - The total number of orders in the file
- New Items - New orders found in the file
- Items Failed - Orders that failed
- Duplicate Items - Orders that already existed in our system
- Status - Overall status of the Order Feed file that was processed
Example:
If some orders failed to upload, download the Items Failed file by clicking the blue cloud icon. The file will provide you with a line-by-line breakdown outlining the errors and how to fix them. Fix the errors and upload the updated file. Continue this process until all orders have been uploaded successfully.