Product Configuration File Definitions

Updated May 31, 2024 11:44

The Product Configuration File is a CSV file used to enable or disable Ordergroove features for your products. They're commonly used to update many products at once; you can upload a file with a maximum of 10,000 rows.

Formatting your file

Most configuration file errors happen due to Microsoft Excel formatting. For a smooth process, keep the following tips in mind:

Microsoft Exel does not respect leading zeros. If you have a product ID like "0001", Excel will omit them and display it as "1". To avoid this, convert the column to text format before saving.
Product IDs must be formatted as numbers/text. Excel will automatically reformat IDs as text to scientific notation, which Ordergroove won't be able to recognize. There's a quick fix, highlight Column A, right-click, choose Format Cells, select Numbers with 0 decimal places.

Boolean

True Values	true, t, TRUE 1
False Values	false, f, False, FALSE, 0

Product IDs and Variants

The Product ID listed on the configuration file is received through the product feed. We use variant IDs on most platforms as unique product identifiers. For example, a bottle of vitamins might have a unique product ID in your system, with larger and smaller quantity bottles listed as variants. In our database, these bottle sizes are listed as individual products.

Available Fields

Field	Input Type	Description
Product_id	None	Product ID received via the product feed This value should not require configuration; ensure that it matches your product ID The product feed must send unique IDs for each product We use variant IDs on most platforms as unique product identifiers For example, a bottle of vitamins might have a unique product ID in your system, with larger and smaller quantity bottles listed as variants. In our database, these bottle sizes are listed as individual products.
Name	None	The name received via the product feed
In Stock	None	Product stock status received from product feed, used for informational purposes True = in stock False = out of stock
Discontinued	Boolean	True = product is out of stock and out of production Products can only be discontinued if set to In Stock = false, Subscription Eligible = false and Discontinued = true Discontinuing a product will immediately cancel all subscriptions for that product unless otherwise specified in the discontinued silent and non-silent fields (see below)
Subscription Eligible	Boolean	True = product is eligible for subscription False = product is not eligible for subscription Dictates if a subscription offer will be displayed on your website
Reorder Eligible	Boolean	True = product is eligible for SMS reorder False = product is not eligible for SMS reorder
Instant Upsell Eligible	Boolean	True = Display Instant Upsell when the customer is logged in and has an upcoming order
Incentive Group	String	Assign a product to a specific incentive group CSV configuration allows you to dictate the groups that each product belongs in. Contact your Ordergroove representative for configuration of the group names to discount names.
SKU Swap Group	String	Swap a subscription product to an equivalent, merchant-defined product For example, a merchant that sells different brands of Vitamin B can specify that all Vitamin B brands belong to that SKU Swap Group. With this in place, a customer that is subscribed to one brand can swap to a different brand in the Subscription Manager without canceling their subscription. No work needs to be done in Ordergroove. Dictate your groups in the CSV, ensuring that they match between swappable products Additional Information on Configuring SKU Swap
Every	Integer	The integer value of the default subscription period Should be within the existing global range *See below for an explanation on PSDF
Every Period	String	Days, day, d OR Weeks, Week, w OR Months, month, m *See below for an explanation on PSDF
Discontinued Silent	Integer	Different product IDs within your catalog When this is set, the customer’s subscription will be moved from the original product to the new product ID set in this field Silent means that the customer will not receive a notification on product change **See below for an explanation on Discontinued SKU Migration
Discontinued Non Silent	Integer	Different product IDs within a merchant’s catalog When this is set, the customer’s subscription will be moved from the original product to the new product ID set in this field The customer will be notified via email that their subscription was swapped to a different product **See below for an explanation on Discontinued SKU Migration
Default to Subscription	Boolean	True = subscription enrollment will be pre-selected on page load for the product
Swap on Purchase Product	String	Specify a product ID for a Buy X, Subscribe to Y experience

*PSDF: Product Specific Default Frequency
While your program-wide frequencies include a default value to be suggested to customers at the time of subscription enrollment, there are often times when a product needs a more tailored default value. These settings allow you to set the default subscription frequency for each product from within the range of program-wide options. If a value that is not available in your global range is specified, the program-wide default frequency will be used.
**Discontinued Silent SKU Migration
When a product is discontinued, all subscriptions for that product are typically canceled. In some cases, you may wish to swap those subscriptions to a new product instead of canceling the subscriptions entirely. For example, beauty brands have to frequently discontinue products when making packaging or minor formula changes. This will not affect the product as a whole but will require a new ID and SKU because of the updates. Instead of canceling the subscription, the merchant is given the option to swap the two products for the affected customers and choose whether to notify the customer of the update via email.