Future proof API's

The new future-proof API v4 is currently unavailable for the CCV Shop PostNL plug-in. If you would like to make use of the new APIs on this platform, please reach out to customer support of CCV Shop.

The new future-proof API v4 is currently unavailable for the Lightspeed PostNL plug-in. If you would like to make use of the new APIs on this platform, please reach out to customer support of Lightspeed.

You are using the PostNL Magento 2 extension and will soon be using our future-proof APIs v4. There are few things that you will need to do to get started.

Update the extension and PHP

It is required to update your server’s PHP version between 8.2 and 8.5 to ensure compatibility with the future-proof APIs. After that, the newest Magento2 PostNL extension needs to be downloaded from the store to get access to a new API key field in which you will enter a new API key. Proceed to the next step if you have performed these actions or if these actions don’t apply to your situation.

Request a new API key

To make sure you can use the PostNL plug-in as you are used to, you will need to request a new API key that is compatible with the future-proof API infrastructure.

1. Log in to Mijn PostNL Zakelijk
   Go to Mijn PostNL Zakelijk and log in with your user account.
2. Navigate to the Self-Service API Module
   After logging in, navigate to the Self-Service API Module via the menu in the top right corner by going to My account > API management. This environment is used to manage existing integrations and request new integrations.
3. Create a new integration
   Click on the button ‘Create API integration’ and select ‘Third-party integration’. You can now choose a name for your integration. If you have multiple customer numbers, select the customer number(s) for which you want to create a new integration. Next, select "Magento2" from the list. Review the Terms and Conditions and click ‘Create integration’. Your new API keys will be shown on the following page. For more in-depth instructions, see our guides on creating and managing integrations here.
4. Configure your new API key in the plug-in
   You now have access to your new integration including a new sandbox and production key for your extension. Enter these keys in the configuration settings of your extension by going to Magento > select PostNL in the left sidebar > select Configuration > scroll down to Basic and select Account settings > enter your new API key in the New API key field.

Test your integration

After completing all the previous steps:

• Verify that the new API key is correctly configured in the PostNL plug-in.
• Test your shipping functionality to ensure everything is working correctly.
• Use PostNL products as you are used to.

If you need help with any of the above-mentioned steps, please reach out to PostNL Tech Support.

Important Notes

• Using an unsupported PHP version may cause the PostNL extension to malfunction.
• Always perform changes in a staging environment before applying them to production.
• Once the PostNL Magento 2 extension has been migrated to our new future-proof APIs v4, you will be notified to update your extension.

You are using the PostNL Shopify app and will soon be using our future-proof APIs v4. There are few things that you will need to do to get started.

1. Log in to Mijn PostNL Zakelijk
   Go to Mijn PostNL Zakelijk and log in with your user account.
2. Navigate to the Self-Service API Module
   After logging in, navigate to the Self-Service API Module via the menu in the top right corner by going to My account > API management. This environment is used to manage existing integrations and request new integrations.
3. Create a new integration
   Click on the button ‘Create API integration’ and select ‘Third-party integration’. You can now choose a name for your integration. If you have multiple customer numbers, select the customer number(s) for which you want to create a new integration. Next, select "Shopify" from the list. Review the Terms and Conditions and click ‘Create integration’. Your new keys will be shown on the following page. For more in-depth instructions, see our guides on creating and managing integrations here.
4. Configure your new API key
   You now have access to your new integration including a new production key for your app. Enter these keys in the configuration settings of your app by going to Shopify > select PostNL in the left sidebar > click on Settings > enter your new API key in the New API key field.
5. Use your new API key
   You are now using the new API key which is compatible with the PostNL API v4. You can keep using the PostNL app in Shopify as you are used to.

You are using the PostNL Shopware 6 extension and will soon be using our future-proof APIs v4. There are few things that you will need to do to get started.

1. Log in to Mijn PostNL Zakelijk
   Go to Mijn PostNL Zakelijk and log in with your user account.
2. Navigate to the Self-Service API Module
   After logging in, navigate to the Self-Service API Module via the menu in the top right corner by going to My account > API management. This environment is used to manage existing integrations and request new integrations.
3. Create a new integration
   Click on the button ‘Create API integration’ and select ‘Third-party integration’. You can now choose a name for your integration. If you have multiple customer numbers, select the customer number(s) for which you want to create a new integration. Next, select "Shopware" from the list. Review the Terms and Conditions and click ‘Create integration’. Your new keys will be shown on the following page. For more in-depth instructions, see our guides on creating and managing integrations here.
4. Configure your new API key
   You now have access to your new integration including a new sandbox and production key for your extension. Enter these keys in the configuration settings of your extension by going to Shopware > select Extensions in the left sidebar > go to My extensions > click on Configure next to the PostNL extension > enter your new API key in the API key field.
5. Use your new API key
   You are now using the new API key which is compatible with the PostNL API v4. You can keep using the PostNL extension in Shopware as you are used to.

Important Notes

• Once the PostNL Shopware extension has been migrated to our new future-proof APIs v4, you will be notified to update your extension.

You are using the PostNL WooCommerce plug-in and will soon be using our future-proof APIs v4. There are few things that you will need to do to get started.

Update the plug-in and PHP

It is required to update your server’s PHP version between 8.2 and 8.5 to ensure compatibility with the future-proof APIs. After that, the newest WooCommerce PostNL plug-in needs to be downloaded from the store to get access to a new API key field in which you will enter a new API key. Proceed to the next step if you have performed these actions or if these actions don’t apply to your situation.

Request a new API key

To make sure you can use the PostNL plug-in as you are used to, you will need to request a new API key that is compatible with the future-proof API infrastructure.

1. Log in to Mijn PostNL Zakelijk
   Go to Mijn PostNL Zakelijk and log in with your user account.
2. Navigate to the Self-Service API Module
   After logging in, navigate to the Self-Service API Module via the menu in the top right corner by going to My account > API management. This environment is used to manage existing integrations and request new integrations.
3. Create a new integration
   Click on the button ‘Create API integration’ and select ‘Third-party integration’. You can now choose a name for your integration. If you have multiple customer numbers, select the customer number(s) for which you want to create a new integration. Next, select "WooCommerce" from the list. Review the Terms and Conditions and click ‘Create integration’. Your new keys will be shown on the following page. For more in-depth instructions, see our guides on creating and managing integrations here.
4. Configure your new API key
   You now have access to your new integration including a new sandbox and production key for your plug-in. Enter these keys in the configuration settings of your plug-in by going to WooCommerce > select Plug-ins in the left sidebar > click on Settings under the PostNL for WooCommerce header > enter your new API key in the New API key field.

Test your integration

After completing all the previous steps:

• Verify that the new API key is correctly configured in the PostNL plug-in.
• Test your shipping functionality to ensure everything is working correctly.
• Use PostNL products as you are used to.

If you need help with any of the above-mentioned steps, please reach out to PostNL Tech Support.

Important Notes

• Using an unsupported PHP version may cause the PostNL plug-in to malfunction.
• Always perform changes in a staging environment before applying them to production.
• Once the PostNL WooCommerce plug-in has been migrated to our new future-proof APIs v4, you will be notified to update your plug-in.