Importing and Exporting Organization Entities

The ability to import or export specific entities within your organization is designed primarily for testing and sandbox environments. It supports development workflows by enabling you to back up, transfer, and version control your configuration settings.

Use this functionality to:

  • Backup configurations: Export your organization settings to JSON files for safekeeping.

  • Transfer configurations between environments: Move role and system configurations between development, testing, and production environments within the app.

  • Enable version control: Maintain a historical record of configuration changes for auditing or rollback purposes.

All imported and exported files are limited to the Pipe17 app and cannot be used externally.


Available Entities

The following entity types can be exported and imported:

  • Automation Engine

  • Integrations

  • Organization Profile

  • Plugins

  • Shipping Method Mappings

  • API Keys

  • Order Routing Engine Rules

  • Filters

  • Manually Created Locations


How to Export Entities

Exporting generates JSON files that can be stored and reused for sandbox or backup purposes.

To export:

  1. Navigate to Settings → Import/Export and open the Export tab.

  2. Select the entities you want to export.

  3. Click Export to begin the process.

  4. A step-by-step wizard will display which entities are available for export.

    • Some steps may require you to select specific records to include (e.g., Integrations).

  5. Click Export and Continue to download the JSON files for each selected entity.

  6. You can choose to Skip a step and not export that entity or Close the wizard at any time.


How to Import Entities

Importing uses JSON files previously generated from an export. This is especially helpful for restoring or replicating settings in a new environment.

To import:

  1. Go to Settings → Import/Export and open the Import tab.

  2. Click Import to launch the wizard.

  3. Upload the relevant JSON files using drag-and-drop or the file selector.

  4. The wizard will display the importable entities and prompt for further action where required.

    • Some steps may ask you to select an Action (such as replace) to complete the import.

    • The status of each action will be shown after selecting Import.

  5. Click Import to proceed.

  6. You can choose to Skip a step and not import that entity or Close the wizard at any time.


Need Help?

If you need additional assistance:

We're here to help you succeed with your operations.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.

Have more questions?
Submit a request
Share it, if you like it.