Import and export checkout blocks

Before you start

• Checkout Ninja installed in both stores if you’re moving a block between stores.
• Pick the right tool. There are two, and their files aren’t interchangeable:

Tool	Where	What’s in the file
Whole block	More actions → Export / Import at the top of the block editor	Block name, status, layout, visibility conditions and all the blocks inside
Blocks only	The ⋯ button next to Add block → Export blocks / Import blocks	Only the list of blocks inside, with their settings

Steps

Export a whole block

1. Go to Checkout Blocks and open the block.
2. Click More actions → Export.
3. A .json file downloads, and you’ll see Export completed successfully.

Import a whole block (for example, into another store)

1. Go to Checkout Blocks → Create New Block → Start Fresh. Or open an existing block to overwrite it.
2. Click More actions → Import. The Import data by JSON window opens.
3. Click Add file, or drag the file into the drop zone. You’ll see the file name and a count, such as Found: 3 block(s), 1 rule(s).
4. Under Import behavior, choose:
   • Override existing data to replace the fields in the file, such as name, status, layout, visibility conditions and blocks.
   • Append to existing data to add the file’s blocks and visibility conditions after the ones already there. The name, status and layout are still taken from the file.
5. Click Upload and preview. The editor fills in, and you’ll see a message such as Data replaced successfully - Found: 3 block(s), 1 rule(s).
6. Re-pick any products, variants or collections (see Limitations).
7. Click Save. The block gets its own Block ID under Block Details.
8. Copy the Block ID, click Open Checkout Editor, add a Custom Block and paste the ID. Then save the checkout editor.

Download sample JSON in the import window gives you an empty example of the file format.

Export only the blocks

1. Open the block.
2. Click the ⋯ button next to Add block, then Export blocks.
3. A file named checkout-blocks- plus today’s date downloads, and you’ll see Blocks exported successfully.

Import only the blocks

1. Open the block you want to add them to, and stay on the default language tab.
2. Click ⋯ → Import blocks.
3. Choose a tab:
   • Upload file: click Add file or drag the file in. You’ll see Found: N block(s).
   • Paste JSON: paste the blocks into JSON content. It must be a JSON array, starting with [.
4. Under Import behavior, choose Override existing blocks (replace all current blocks) or Append to existing blocks (add them after the current ones).
5. Click Import. You’ll see, for example, 2 block(s) appended successfully.
6. Click Save.

Verify it worked

1. After you save, the block list shows the imported block with the name from the file.
2. In the editor, each imported block opens with its settings filled in.
3. Place the block in the checkout editor and check it in a test checkout. For blocks with visibility conditions, also test a cart that should not match.

Limitations

• Product, variant and collection selections aren’t moved between stores. They’re saved as IDs from the original store and imported as-is. In a different store, re-pick them in:
  • Upsell, Featured Upsell, Promo Banner Upsell and Quick Add Upsell product pickers
  • Shipping Protection → the protection product
  • Progress Bar products to track
  • Visibility conditions such as Product in cart or Variant in cart
• Importing doesn’t save. Leaving the page without clicking Save discards the import.
• Override existing data only replaces what’s in the file. Fields missing from the file keep their current values.
• Plan limits still apply. Importing a block type your plan doesn’t include shows it behind a Premium Feature card. See plans and features.
• Blocks only import works on the default language. The ⋯ menu isn’t shown on a translation tab.

Troubleshooting

“Invalid JSON file format” or “Invalid JSON format”. The file or pasted text isn’t valid JSON, or it’s the wrong kind of export for the tool you used. See the fix.

The import window shows “Found: 0 block(s)” for a file that has blocks. You’re using one tool with the other tool’s file. Whole-block exports go into More actions → Import. Blocks-only exports go into ⋯ → Import blocks.

The upsell or shipping protection block doesn’t show in the new store. Its product selection still points to the old store. Open the block, pick the product again and save.