Migration File: All About The Data You Need

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 * may be required during your migration. Please reach out to Ordergroove to confirm which fields are required for your subscription program.


Fields For Each Customer

Field

Required

Format

Notes

merchant

Y

string

String. Your program's unique ID within Ordergroove

merchant_user_id

Y

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

 

last_name

*

string

 

live

Y

boolean

Indicates if a customer has been manually deactivated

phone_number

N

string

Format: E.164

 

created

N

string

Format: YYYY-MM-DD HH:MM:SS

 

extra_data

N

JSON as string

Used in rare cases, can be ignored

 origin

Y

object

Identifiers from the platform(s) you're migrating from

 

Fields For The Customer Origin Component

Field

Required

Format

Notes

ID

Y

string

The ID of the customer you will use in other origin objects to refer to this customer

 

Fields For Each Subscription

Field

Required

Format

Notes

customer

Y

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

N

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

N

string

The date when the subscription was most recently canceled

next_order_date

N

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

Y

boolean

Whether or not the subscription is active.
For 'Paused' subscriptions please use false.

merchant_order_id

Y

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

Y

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

Y

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

Y

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

Y

string

Can be set to null, or you may provide a price. Keep in mind however that the key is required.

quantity

Y

integer

How many pieces of the product the subscriber has subscribed to for each order

offer

Y

string

This will be provided to you when your account is created. It identifies the incentive profile for this subscription.

shipping address

Y

string

The address to which the subscription will be shipped

extra_data

N

JSON as string

Used in rare cases, can be ignored.

components

N

object

If the subscription is a bundle, include the data for each component product of the bundle here. See below for more information.

Note: This is only used for Legacy Bundles.

 origin

Y

object

Identifiers from the platform(s) you're migrating from

 

Fields For Each Subscription Component

Field

Required

Format

Notes

product

Y

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

Required

Format

Notes

ID

Y

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

Y

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

Y

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

Required

Format

Notes

customer

Y

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

Y

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 Y boolean

If the payment method is still active and usable by the customer

origin Y object

Identifiers from the platform(s) you're migrating from

 

Fields For Each Payment Method > Origin Component

Field

Required

Format

Notes

ID

Y

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

Y

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

N

string

Information on payment processor being migrated

 

Fields For Each Payment Method > Origin > Payment Processor Component

Field

Required

Format

Notes

type

N

string

Options: PayPal, Stripe

Required when migrating to Shopify Payment

data

N

string

Data specific to the type of payment process

 

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

Field

Required

Format

Notes

token_id

N

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

Required

Format

Notes

token_id

N

string

The PayPal billing agreement ID to be migrated

Deprecated PayPal Docs

Braintree Docs

 

Fields For Each Shipping or Billing Addresses

Field

Required

Format

Notes

customer

Y

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

Y

string

Options: billing_address, shipping_address

 

first_name

*

string

 

Check with Ordergroove to see if these fields are required by your subscription 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

Y

boolean

Whether or not this address is still active and usable by the customer

origin

Y

object

Identifiers from the platform(s) you're migrating from

 

Fields For Each Address Origin Component

Field

Required

Format

Notes

ID

Y

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.