Migration File: All About The Data You Need

Updated March 22, 2023 16:03

Below you'll find information about the data you'll need to populate the migration file. If you want to know how that file should be organized, click here.

Note: Fields marked with a * are required during your migration.

Fields For Each Customer

Field	Format	Notes
merchant *	string	String. Your program's unique ID within Ordergroove
merchant_user_id *	string	String. The customer ID in the e-commerce platform you've installed Ordergroove on. We use this to identify your subscriber in that system
email	string	Used to send transactional emails. Check your settings to see if this is required
first_name	string	Check your settings to see if this is required
last_name	string	Check your settings to see if this is required
live *	boolean	Indicates if a customer has been manually deactivated
phone_number	string Format: E.164
created	string Format: YYYY-MM-DD HH:MM:SS
extra_data	JSON as string	Used in rare cases, can be ignored
origin *	object	Identifiers from the platform(s) you're migrating from

Fields For The Customer Origin Component

Field	Format	Notes
ID *	string	The ID of the customer you will use in other origin objects to refer to this customer

Fields For Each Subscription

Field	Format	Notes
customer *	string	The customer ID in the e-commerce platform you've installed Ordergroove on. We use this to identify your subscriber in that system. [merchant_user_id]
start_date	string	The date when the subscription was created or the date it was most recently reactivated after having been canceled. Format: YYYY-MM-DD HH:MM:SS
canceled	string	The date when the subscription was most recently canceled
next_order_date	string	When we import this subscription this will be the date on which we create its next order. Format: YYYY-MM-DD HH:MM:SS
live *	boolean	Whether or not the subscription is active. For 'Paused' subscriptions please use false.
merchant_order_id *	string	The ID of the e-commerce order with which the subscription was originally created (when they enrolled). This will be used to ensure accuracy and avoid duplicate subscriptions.
product *	string	The ID of the product in your e-commerce system. Before you start the migration, this product's information must be included in the recurring product feed sent to Ordergroove. This is how we will identify the subscription product when placing orders.
every *	integer	How often, in frequency periods, to send the subscription item. For example, if a subscription comes every four weeks this field would be "4"
every_period *	string	The frequency period to use when calculating the next order. Options: Days, Weeks, Months For example, if a subscription comes every four weeks this field would be "Weeks"
price *	string	Can be set to null, or you may provide a price. Keep in mind however that the key is required.
quantity *	integer	How many pieces of the product the subscriber has subscribed to for each order
offer *	string	This will be provided to you when your account is created. It identifies the incentive profile for this subscription.
shipping address *	string	The address to which the subscription will be shipped
extra_data	JSON as string	Used in rare cases, can be ignored.
components	object	If the subscription is a bundle, include the data for each component product of the bundle here. See below for more information.
origin *	object	Identifiers from the platform(s) you're migrating from

Fields For Each Subscription Component

Field	Format	Notes
product *	string	The ID of the product in your e-commerce system. Before you start the migration this product's information must be included in the recurring product feed sent to Ordergroove. This is how we will identify the subscription's component products when placing orders.

Fields For Each Subscription Origin Component

Field	Format	Notes
ID *	string	The ID you'll use to identify this address in the rest of this customer's JSON object. It can be the ID of the address in your e-commerce system, subscription platform, or something you generate for migration.
payment *	string	The ID of the payment method for this subscription. This should be the same as the origin ID provided for this payment method in this JSON object.
shipping_address *	string	The ID of the shipping address for this subscription. This should be the same as the origin ID provided for this shipping address in this JSON object.

Fields For Each Payment Method

Field	Format	Notes
customer *	string	The customer ID in the e-commerce platform you've installed Ordergroove on. We use this to identify your subscriber in that system. [merchant_user_id]
cc_holder	string	Name of the credit cardholder. If you're unable to access this data you can turn it off as required for the migration and back on if desired. Check your settings to see if required by your Ordergroove program. Please also check the requirements of your e-commerce store. If this field is required outside of Ordergroove but not present in the data you migrate it could cause errors during the import or orders not to place down the line.
cc_type	string	Options: Visa: 1 MasterCard: 2 American Express: 3 Discover: 4 If you're unable to access this data you can turn it off as required for the migration and back on if desired however please note subscribers will not see this with their subscription payment information. Check your settings to see if required by your Ordergroove program. Please also check the requirements of your e-commerce store. If this field is required outside of Ordergroove but not present in the data you migrate it could cause errors during the import or orders not to place down the line.
cc_exp_date	string	If you're unable to access this data you can turn it off as required for the migration and back on if desired however please note subscribers will not see this with their subscription payment information. In addition, we will not be able to. Format: MM/YYYY Check your settings to see if required by your Ordergroove program. Please also check the requirements of your e-commerce store. If this field is required outside of Ordergroove but not present in the data you migrate it could cause errors during the import or orders not to place down the line.
token_id *	string	Either: 1. The credit card token used when placing orders for this subscription 2. A unique identifier used by your e-commerce system to charge the subscriber (such as a customer ID). For BigCommerce send the customer ID as the token To migrate to Shopify payments leave this blank and continue to the origin components below
live *	boolean	If the payment method is still active and usable by the customer
origin *	object	Identifiers from the platform(s) you're migrating from

Fields For Each Payment Method > Origin Component

Field	Format	Notes
ID *	string	The ID you'll use to identify this payment method in the rest of this customer's JSON object. It can be the ID of the payment method in your e-commerce system, a subscription platform, or something you generate for migration.
billing_address *	string	The ID of the billing address for this subscription. This should be the same as the origin ID provided for this billing address in this JSON object.
payment_processor	string	Information on payment processor being migrated

Fields For Each Payment Method > Origin > Payment Processor Component

Field

Format

Notes

type

string

Options: PayPal, Stripe

Required when migrating to Shopify Payment

data

string

Data specific to the type of payment process

Fields For Each Payment Method > Origin > Payment Processor > Data (Stripe Type)

Field	Format	Notes
token_id	string	The Stripe token to be migrated. Please provide the Customer Profile ID only. For example: cus_abc123

Fields For Each Payment Method > Origin > Payment Processor > Data
(PayPal Type)

Field

Format

Notes

token_id

string

The PayPal billing agreement ID to be migrated

Deprecated PayPal Docs

Braintree Docs

Fields For Each Shipping or Billing Addresses

Field	Format	Notes
customer *	string	The customer ID in the e-commerce platform you've installed Ordergroove on. We use this to identify your subscriber in that system. [merchant_user_id]
address_type *	string Options: billing_address, shipping_address
first_name	string	Check your settings to see if required by your Ordergroove program. Please also check the requirements of your e-commerce store. If any of these fields are required outside of Ordergroove but not present in the data you migrate it could cause errors during the import or orders not to place down the line.
last_name	string
company	string
address	string
address2	string
city	string
state	string Validation
zip_code	string
country	Validation
phone	string Format: E.164
live *	boolean	Whether or not this address is still active and usable by the customer
origin *	object	Identifiers from the platform(s) you're migrating from

Fields For Each Address Origin Component

Field	Format	Notes
ID *	string	The ID you'll use to identify this address in the rest of this customer's JSON object. It can be the ID of the address in your e-commerce system, subscription platform, or something you generate for migration.

Fields For Each Customer

Fields For The Customer Origin Component

Fields For Each Subscription

Fields For Each Subscription Component

Fields For Each Subscription Origin Component

Fields For Each Payment Method

Fields For Each Payment Method > Origin Component

Fields For Each Payment Method > Origin > Payment Processor Component

Fields For Each Payment Method > Origin > Payment Processor > Data (Stripe Type)

Fields For Each Payment Method > Origin > Payment Processor > Data(PayPal Type)

Fields For Each Shipping or Billing Addresses

Fields For Each Address Origin Component

Fields For Each Payment Method > Origin > Payment Processor > Data
(PayPal Type)