nShift Checkout is our new checkout product, compatible with all nShift book and print platforms as well as book and print solutions from third-party vendors. It features a modern, user-friendly interface that makes it easy to set up, test, and update your Checkout configurations. Once your configuration has been migrated, maintaining it will be much simpler.
We suggest using the migration to review and improve your workflows and rules. Starting fresh often leads to a cleaner, more manageable setup. Alternatively, you can use our import feature to bring in your existing Delivery Checkout configuration if you prefer.
|
Note: Migrating involves updating your integration to the new API that uses a Connection ID. Once integrated, you can update connections and link them to any configuration, allowing for integration updates without code changes. |
Follow these steps to migrate a Delivery Checkout configuration to nShift Checkout:
- Get an nShift Portal account
-
Set up your nShift Checkout configuration
A. Import a Delivery Checkout configuration
B. Create a new nShift Checkout configuration - Change your integration
1. Get an nShift Portal account
Contact customer service to migrate from Delivery Checkout to nShift Checkout. They will create your nShift Portal account and enable access to nShift Checkout. We're transitioning to a single user account for all nShift products, with nShift Portal as the gateway to the new nShift Checkout.
If you have an old subscription, please contact your nShift Account Manager or Customer Service to upgrade to an Essential, Professional, or Premium subscription to use nShift Checkout.
2. Set up your nShift Checkout configuration
Once you have access to nShift Checkout via nShift Portal, you can begin to set up your configuration.
- Log in to nShift Portal and go to Checkout:
- First, go to Senders in the top menu and click New Sender. Having a Sender is required to create a Checkout configuration. Add as many senders as you have in your old Delivery Checkout setup by filling in all the required fields.
- You must connect your sender(s) to your Book and Print platform. For more detailed instructions on how to create a sender, please see this article: Add a sender. It explains how to connect to the different platforms.
Example showing a Sender that is connected to nShift Delivery:
For more information about the API keys used by Delivery, click here.
Tip: Click Test credentials to verify that the connection works.
- Some carriers require additional carrier credentials to access route information, pick-up points, etc. Click the Add carrier credentials button and fill in any credentials needed for your carrier services.
- Click Save when you have filled in all the required fields.
You are now ready to create a new Checkout configuration. You have two options:
A. Import B. New configuration Import a Delivery Checkout configuration from a JSON file. Choose this method to quickly get your old configuration with delivery options, conditions, etc., imported into nShift Checkout.
Pros: Quick and easy.
Cons: If your old setup has outdated flows and unused settings, these are carried over to the new setup, making it harder to maintain.Create a Checkout configuration from scratch for complete control and an optimized, easy-to-maintain setup. Use the migration to review your business rules and workflows.
Pros: A streamlined, easy-to-maintain configuration. You will learn the self-service interface while setting it up, simplifying future updates.
Cons: Might take longer, especially if you have a very advanced configuration.
A. Import a Delivery Checkout configuration
The way conditions, parameters, and extras are added in the nShift Checkout interface differs from Delivery Checkout. As a result, depending on your settings, not everything can be imported exactly as-is. It is important to carefully review all imported settings and conduct thorough testing. Adjustments and corrections may be necessary.
Prerequisites:
- Have the JSON file with your old configuration ready.
Important! If your Delivery Checkout uses the standard template, please contact nShift for help to change it BEFORE running the export. The standard template is not compatible with import. - Have a Sender created.
Follow these steps to import a Delivery Checkout configuration from a file:
- Start by preparing the JSON file with your old configuration. This is done by exporting your configuration from Delivery Checkout. For step-by-step instructions, please see: Exporting a Delivery Checkout configuration.
- Log in to nShift Portal, go to Checkout > Configurations, and click the Import button.
- Select Member account and a Sender. You must have both to be able to import a configuration.
- Select or drag and drop the JSON file with your old configuration.
- Click Import. You will now see the Basic settings with information from your old configuration. Edit or fill in any missing information.
- Click on the Delivery options and check all the settings for each delivery option. If you are missing carrier services from your old configuration, please contact nShift Customer Service. In some cases, assistance from nShift is needed to add the correct delivery options.
- (Essential customers can go directly to point 10) If your configuration uses parameters and conditions, e.g., cart_price, go to the Parameters section and verify that all the needed parameters are enabled. You can add additional parameters by clicking the Add parameter button. (Read more)
- If your configuration uses conditions, go to the Rule Engine and click on each rule to verify that it works as intended. Learn more about how the Rule Engine works in our series of articles here.
- Click the Change test input button and use the test tool to test your rules. (Read more about the test tool here.) Note: imported rules are named "Rule 01", Rule 02", etc. Rename to more explanatory names.
- Verify that any Categories and Extras have been imported correctly. You may need to edit or add text.
- Click Save. If the save is successful, your new configuration is created. If you see any errors, try to fix any missing information that was not imported. This could be a translation text, a currency symbol, or similar.
- Your new configuration will be inactive by default. Click the Inactive icon from the Configuration overview to activate it.
If you experience any issues while running the import, please reach out to nShift Customer Service.
B. Create a new nShift Checkout configuration
Skip this section if you have already imported a configuration as explained above under A. Import a Delivery Checkout configuration.
Things to be aware of before getting started:
- You must have a sender created
- In Delivery Checkout, conditions could be specified under each delivery option. In nShift Checkout, all conditions are specified in the Rule engine, so any conditions you had under each delivery option can be ignored while adding the delivery options.
Follow these steps to create a new Checkout configuration from scratch:
- Log in to nShift Portal and go to Checkout > Configurations.
- Click Create new checkout and configure the Basic settings to match your old Delivery Checkout setup.
- Under Delivery options, add the same delivery options as your old configuration. If a carrier service is missing, please contact Customer Service for help.
- Essential customers can skip points 5-7 and go to point 8.
- Go to Parameters. Check the drop-down list for parameters needed for your Checkout setup. For example, to create rules based on your shopping cart value, use the cart_price parameter. For more information, see Enable parameters
- Set up conditions in the Rule engine. The Rule Engine consolidates all conditions, including those that used to be on different levels as delivery options, badges, fields, and addons. Check out our articles for guidance on setting up conditions in the Rule Engine here.
- Under Categories, add any categories from your old configuration, like "Express" or "Home". These can now be selected on each Delivery option. Learn more about categories here.
- Under Extras, enable any required Custom addons or Fields. For more details, check these articles: Extras - Custom addons and Extras - Fields.
- Test your configuration with the test tool to ensure it functions correctly. Learn more about the test tool here.
- Remember to save your configuration.
For more detailed instructions on creating a configuration, see this article: Create an nShift Checkout configuration.
4. Change your integration
When migrating to nShift Checkout, you need to change your integration. The nShift Checkout uses a different API and a Connection ID. Once you have made the integration using the Connection ID, you can easily update a connection and link it to any configuration, allowing you to update your integration without making code changes. Learn more about Connections here.
Please follow the steps in this guide: Getting started with nShift Checkout API
It will explain how to:
- Create a Client ID and secret
- Request a token
- Create a session
- Call the shipping options endpoint
- Create a partial shipment
You can also go straight to our technical API documentation here.
Kustom integration
For customers using Kustom, please find additional information here:
Checkout widget
If you want to display the nShift Checkout widget on your web page, please refer to the documentation here: