How To Read, Edit, And Use A Migration Error File

What's In The File

  • Our migration error files are formatted as line-separated JSON objects.
  • Each line in the file contains all the information for a single subscriber including their addresses, payment methods, and subscriptions.
  • If any of the customer's data encounters an error none of their subscriptions will be imported and all of the subscriber's data will be in the error file.
  • Get a summary to help you navigate the file using this tool.

How To Read The Errors

  • There are four types of objects per customer in the error file.
    • Customer data
    • Addresses
    • Payment methods
    • Subscriptions

  • Information on the errors will be in two places:
    • In a new error field on any object that encountered an error:
      "customer" : {...}
      "addresses" : [
      "first_name" : "Sam",
      "last_name" : "Smith",
      "address" "1 Fifth Ave",
      "city" : "New York",
      "state" : "New York"
      "error" : {
      "error" : "error in transform",
      "details" : "Untranslated state/province in shipping address. Please change to 2 letter ISO code"
      "payments" : [...],
    • In a summary error object added after all the customer data

Where To Fix Errors

  • Before Migration Day
    • If your file is from a dry-run before the live migration, do not edit the error file as you will need to provide a fresh version of all the data on the day of migration. Instead fix the data in the system from which it originated.
  • After Migration Day
    • You can edit the data directly in the file and then retry as many times as necessary. Feel free to break it into multiple files, if necessary.



Article is closed for comments.