To help you get started quickly with nShift Checkout, you can import your existing DeliveryCheckout (v1) configuration. This allows you to reuse much of your current setup instead of building everything from scratch.
This guide walks you through how to export your configuration from DeliveryCheckout and import it into nShift Checkout, as well as important things to consider before and after the import.
Before you begin
Before exporting your configuration, please ensure the following:
1. Verify your template
Make sure your DeliveryCheckout configuration is using a template that includes Essential, Professional, or Premium in the name. Any template with Standard in the name is a legacy template and should be updated before export.
|
The nShift Standard template If your configuration uses the nShift Standard template, it must be updated to the correct template (Essential, Professional, or Premium) before export. When changing the template, make sure to check Create new DeliveryCheckout Id on the Change template page. This creates a separate configuration for the template when you change to a new template, so your existing live configuration remains untouched. Please also be aware that the Standard template does not enforce functionality restrictions, which means your current configuration may be using features not included in your subscription. When switching to a template that reflects your actual agreement (for example, Essential or Professional), some of that functionality may no longer be available. If you are unsure, contact support or your customer manager before proceeding. |
How to change the template
- In nShift Delivery, go to Maintenance > DeliveryCheckout.
- Click the view icon next to the configuration you want to update.
- On the DeliveryCheckout details page, click Change template.
- In the dropdown, select the correct template (Essential, Professional, or Premium).
- Make sure the Create new DeliveryCheckout Id checkbox is checked.
- Click OK.
A new DeliveryCheckout ID will be created with the updated template, leaving your existing live configuration unchanged.
2. Set up a Sender in nShift Checkout
Before importing a configuration, at least one Sender must be configured in your nShift Portal account.
Read more: Setting up Senders
3. Prepare custom pickup locations
If you are using custom PUDOs (for example, collect in store), these are not included in the export file and must be set up manually in nShift Portal.
If you have all the details for your custom locations (IDs, address, coordinates, opening hours, and so on) available elsewhere, you can use that directly. If your custom PUDOs information only exists in DeliveryCheckout, you can export the information from there:
- In nShift Delivery, go to Maintenance > DeliveryCheckout > Agent lists.
- Click Search to list your agent lists.
- Download the lists you want to export.
Note that the format used in nShift Portal is different. The JSON exported from DeliveryCheckout cannot be reused as-is and will need to be reformatted before upload in nShift Portal.
Adding your own pickup locations (custom PUDOs)
4. Export and import your condition lists
Any condition lists used in your DeliveryCheckout configuration must also be migrated manually. Export your condition lists from DeliveryCheckout and import them into nShift Checkout before importing your configuration, so that they are available when needed during the import process.
Note that condition lists and custom PUDO lists do not have to be in place before you import your configuration. You can set them up later. However, they will need to be migrated manually at some point if they are still relevant and should be used in the new Checkout.
Step 1: Export configuration from Delivery Checkout
- Go to your DeliveryCheckout (v1) configuration.
- Press Export > Export JSON to export the configuration as a JSON file.
- Save the file locally.
Step 2: Import configuration into nShift Checkout
- Log in to nShift Portal.
- Confirm you have set up a Sender.
- Navigate to nShift Checkout > Configurations.
- Select Import.
- Upload your exported JSON file.
- Review the imported content and correct any errors indicated in the interface.
- Save.
What happens during import?
When importing a configuration, your existing setup is transferred into nShift Checkout. The core structure is preserved, but adapted to the new system.
Keep in mind that nShift Checkout is designed to work differently from DeliveryCheckout in some fundamental ways. In v1, the same condition often had to be written separately in every place where it should trigger something. In new Checkout, a single rule can trigger multiple actions at once, for example, changing a text, adjusting a price, and hiding a delivery option, all from one condition.
This means that while an imported configuration will work, it may not take full advantage of how nShift Checkout is designed to work. In many cases, particularly for more complex configurations, building from scratch will result in a leaner, more maintainable setup.
In DeliveryCheckout, conditions were typically written to define when an option should be shown. In nShift Checkout, you can choose whether a delivery option is shown by default and hidden by rules, or hidden by default and activated by rules. On import, delivery options will be set to inactive, with rules activating them when conditions are met, mirroring the logic from DeliveryCheckout. This is worth reviewing after import, as the new approach may allow you to simplify your rules depending on your setup.
Legacy conditions are automatically converted into rules in the Rule Engine. Where the same condition was used in multiple places in DeliveryCheckout, this will result in a single rule with multiple actions in nShift Checkout, reflecting how the new rule engine is designed to work.
After import, all converted rules will be named Rule 1, Rule 2, and so on. We recommend going through your rules and renaming them to something meaningful. This makes your configuration easier to maintain and troubleshoot going forward.
After import: What to review
After importing your configuration, we strongly recommend reviewing and validating your setup.
Use the Test panel in nShift Checkout to validate your configuration. Using the Test and Developer mode
The Test panel is available on the edit Configurations page. Click Change test input on the right side of the screen to open it.
Fill in the parameters with test data to mock different scenarios, such as different cart values, locations, or product types. The parameters in the Test panel reflect the parameters enabled in your configuration. As you modify the test data, the widget preview updates in real time, giving you a what-you-see-is-what-you-get view of exactly what delivery options would be returned for a given set of inputs.
This makes it straightforward to verify that your rules behave as expected across different scenarios, including edge cases.
We strongly recommend testing a range of scenarios after import before going live.
Delivery options
- Ensure all expected delivery options are available.
- Check naming, visibility, and pricing.
Pricing
- Validate that pricing behaves correctly across different scenarios.
In nShift Checkout, every delivery option has a default price that is displayed unless a rule specifies otherwise. If all prices in your DeliveryCheckout configuration were condition-based, the default price field will be empty after import. Make sure to set a default price for each delivery option in the nShift Checkout interface. This is a mandatory field, and without it, you will not be able to save the configuration.
Rules and logic
- Verify that converted rules behave as expected.
- Adjust logic where needed to align with the new rule engine.
Review the order of your rules
Rules at the top take priority over those below. After import, make sure the order reflects your intended logic, and test different scenarios to confirm you are getting the expected results. Rules can be reordered by drag and drop.
|
Recommendation Use the imported configuration as a starting point, but consider refining or rebuilding parts of it to fully benefit from nShift Checkout's capabilities. Manual adjustments are often required after import. nShift Checkout uses a new rule engine, which may behave differently from legacy conditions. |
Need help?
If you encounter issues during export or import, or need help reviewing your setup, please contact support.