Magento Manual

For the manual and more information, please refer to our Magento Manual on the MyParcel Developer Portal.

Important notice about third-party checkouts

We support the default Magento checkout and the Hyvä checkout.

To install our Hyvä compatibility module via composer:

composer require hyva-themes/magento2-hyva-checkout-myparcelnl

Enable module

bin/magento setup:upgrade

This ensures that our plugin (version 5 or higher) works seamlessly with the Hyvä checkout, there are no additional settings or requirements.

:warning: Third-Party Checkouts Compatibility.

Other third party checkouts are not officially supported. Features such as Delivery Options or other functionalities might not work as expected.

We recommend testing the plugin’s functionality in your specific setup before fully implementing it.

Installation

Install using composer require.

composer require myparcelnl/magento

For developers

Clone this repository in app/code/MyParcelNL/Magento/ using git and run the following commands in the root directory of your Magento installation:

composer config repositories.myparcelnl/magento path app/code/MyParcelNL/Magento/
composer require myparcelnl/magento

This will install our SDK as a dependency.

You can install the SDK as a git repository as well:
Clone MyParcelNL/Sdk in app/code/MyParcelNL/Sdk/ using git and run the following commands in the root directory of your Magento installation:

composer config repositories.myparcelnl/sdk path app/code/MyParcelNL/Sdk/
composer require myparcelnl/sdk

Changelog

All notable changes to this project will be documented in this file. See
Conventional Commits for commit guidelines.

5.7.0 (2026-06-05)

:bug: Bug Fixes

• checkout: prevent shipping method loop (2) (#960) (adec5ac)
• checkout: prevent shipping_methods loop when interacting with delivery options (#958) (483dac4)

:sparkles: New Features

• add languages DE, IT, PL, DA, and fallback to EN nicely (#957) (75cb646)

5.6.0 (2026-05-28)

:sparkles: New Features

• api: add a generic proxy to inject API key into API requests (#936) (1e10eff)
• dedicated delivery options endpoint (#941) (2d7d388), closes thephpleague/openapi-psr7-validator#163
• improve user agent header (#953) (11a20e2)
• use delivery options v7 with capabilities and compact view (#954) (38e4701)

5.5.2 (2026-03-30)

:bug: Bug Fixes

• security: fix tar vulnerability (#945) (f60044f)

5.5.1 (2026-03-13)

:bug: Bug Fixes

• prevent deprecated functionality error (#943) (067b9c1)
• prevent unserialize errors for orders (#944) (36bdce5)

5.5.0 (2026-03-02)

:sparkles: New Features

• remove drop off point (#939) (07b766c)

:zap: Performance Improvements

• improve adding delivery options to order rest endpoint (#927) (8e90958)

5.4.0 (2026-02-17)

:sparkles: New Features

• throw intelligible error for missing api key (#938) (af0c47a)

:bug: Bug Fixes

• update delivery options with address street and number (#937) (0fbd18b)

5.3.0 (2026-02-11)

:sparkles: New Features

• dynamic settings (#930) (57759ea)
• remove show delivery date setting and derive from deliverydays_window (#931) (d143003)

5.2.2 (2026-02-05)

:bug: Bug Fixes

• add priority delivery title (#935) (66f12cf)
• use newest delivery options (#934) (90fd89c)

5.2.1 (2026-01-30)

5.2.0 (2026-01-19)

:bug: Bug Fixes

• cleanup myparcelconfig options (#922) (6cfbddb)
• remember the type in carrier options (#921) (a9668ed)
• save correct data types in matrix (#924) (9a5ce3e)
• use account general settings to check for mailbox international (#923) (59fe7cb)

:sparkles: New Features

• postnl mailbox priority (#926) (1cf1170)

5.1.0 (2025-12-02)

:sparkles: New Features

• add exclude parcel lockers (#920) (8bf4609)
• add trunkrs (#913) (515773f)

5.0.0 (2025-11-24)

:warning: This is a major release which introduces breaking changes.

:sparkles: New Features

• v5 introduces the MyParcel Delivery Method and associated delivery costs settings

4.19.0 (2025-07-24)

:sparkles: New Features

• checkout: unselect delivery options when other method is chosen (#883) (ad6d9f9)
• show error message when received from api (#879) (25cbd56)

:bug: Bug Fixes

• ensure product weight is correctly exported to backoffice (#889) (ddb404c)
• remove weight from large format option (#877) (d914038)

4.18.1 (2024-12-20)

:bug: Bug Fixes

• prevent random error messages from halting shipment creation (#878) (399f16a)

4.18.0 (2024-11-26)

:sparkles: New Features

• add delivery fee (#872) (64a7c2b)
• add receipt code for belgium (#875) (8a219ad)
• carriers: add ups shipping options (#873) (b223ac7)

4.18.0 (2024-11-26)

:sparkles: New Features

• add delivery fee (#872) (64a7c2b)
• add receipt code for belgium (#875) (8a219ad)
• carriers: add ups shipping options (#873) (b223ac7)

4.17.0 (2024-10-29)

:sparkles: New Features

• add receipt code (#867) (5e23b40)

:bug: Bug Fixes

• export: restore automate shipment options settings (#869) (9b03b61)

4.16.2 (2024-09-10)

:bug: Bug Fixes

• honor package type choice from admin (#862) (c93eef4)

4.16.1 (2024-08-08)

:bug: Bug Fixes

• splitstreet: use latest regex for be (#861) (fca229e)
• use country codes from sdk (5b1339e)

4.16.0 (2024-08-06)

:sparkles: New Features

• small package belgium (#859) (84aaae1)
• update insurance settings (#856) (129bd68)

4.15.2 (2024-07-25)

:bug: Bug Fixes

• add correct translations for delivery options (#858) (2df7796)

4.15.1 (2024-07-11)

:bug: Bug Fixes

• allow exporting without delivery options (#848) (7f88b09)
• allow package type mailbox when postnl is disabled (#850) (c3357eb)
• checkout: honor monday delivery setting (#849) (359eef0)
• checkout: show delivery options also when totalprice is chosen (#852) (0408cad)
• checkout: show delivery options even if not all mailbox settings are present (#853) (cfc33e8)
• checkout: take carrier specific mailbox weight into account (#855) (6ce5131)
• checkout: update shipping price in delivery options on change (#846) (52bc15f)
• checkout: use backwards compatible delivery options (#854) (f8727ee)
• prevent dhl shipments being rejected for size (#851) (cec93a9)

4.15.0 (2024-06-10)

:bug: Bug Fixes

• checkout: fix mailbox options (#844) (495ea80)

:sparkles: New Features

• add mailbox to dpd (#843) (0fbd8ee)
• change large package name (#845) (50fc945)

4.14.4 (2024-05-13)

:bug: Bug Fixes

• checkout: show nicer messages in delivery options (#842) (ae71d80)
• checkout: stabilise choosing pickup point (#841) (aaa21d4)
• export: allow signature or only_recipient for be (#840) (8c10cc3)

4.14.3 (2024-04-22)

:bug: Bug Fixes

• checkout: work with bbp and do6 from cdn (#837) (c560351)
• prevent camel cased options from breaking order detail page (#838) (bc8cff4)

4.14.2 (2024-04-04)

:bug: Bug Fixes

• add delivery options 6 (#835) (a253bcc)

4.14.1 (2024-04-02)

:bug: Bug Fixes

• migration: allow migration to run with invalid scopes present (#834) (6eb73f6)

4.14.0 (2024-03-29)

:sparkles: New Features

• add international bbp (#826) (f9d0b63)
• add price surcharge option (#828) (b3cee24)
• include delivery options 6 (#830) (82a41e3)

4.13.0 (2024-03-13)

:sparkles: New Features

• activate dpd for myparcel contract (#822) (ee59c0d)
• add package type package small (#825) (6d1c461)
• add sunday cut-off time (#827) (d0cfc65)

4.12.1 (2024-02-21)

:bug: Bug Fixes

• fix php 8.2 deprecation error (#818) (793f7ef)
• use both address lines for street name (#819) (2053b08)

4.12.0 (2024-02-01)

:bug: Bug Fixes

• allow observer to use transport object (#805) (e64a687)
• checkout: prevent delivery options from disappearing (#811) (1f153dc)
• checkout: prevent missing street from blocking delivery options (#813) (169e8be)
• fix large format issue (#798) (dd98a32)
• fix php deprecation error (#793) (5222a77)
• fulfilment: export phonenumber and weight (#810) (d2b2a85)
• fulfilment: set weight on customs item rather than throw error (#814) (2eadcbc)
• implement regression feedback (#806) (0b3b1f0)
• only set country if currentCountry has value (#794) (e86d3fe)

:sparkles: New Features

• add carrier dpd (#786) (e87fe71)
• add carrier ups (#787) (c6aff00)
• add digital stamp weight range (#801) (696b771)
• add state to consignment (#815) (8c3e208)

4.11.1 (2023-11-23)

:bug: Bug Fixes

• checkout: show delivery options for tablerate when appropriate (#790) (8e29ac1)
• ordernotes: bail early without order (#788) (37bacb5), closes #772

4.11.0 (2023-11-10)

:sparkles: New Features

• add dhl carriers (#777) (6b64df9)

:bug: Bug Fixes

• checkout: consistently use correct package type for delivery options (#782) (85aa4c3)
• checkout: fix for multiple shipping methods (#779) (1acffbc)
• checkout: restore payload extender functionality (#775) (15ffe5e)
• migration: honor database table prefix (#776) (b327b90)
• new-shipment-form: preselect correct carrier (#780) (cc1817c)
• order-mode: allow export with carrier specific options (#781) (6bef66b)

4.10.0 (2023-08-01)

:sparkles: New Features

• fulfilment: add order notes (#768) (d1fcdcc)

:bug: Bug Fixes

• migration: fix deprecated functionality (#766) (5e18dad)

4.9.1 (2023-04-20)

:bug: Bug Fixes

• allow price based tablerate with mailbox (#762) (2860ad2)

4.9.0 (2023-03-07)

:bug: Bug Fixes

• restore option product not to use mailbox (#757) (31bfcf5)

:sparkles: New Features

• add insurance custom be (#755) (5525faf)

4.8.1 (2023-02-02)

:bug: Bug Fixes

• clarify texts regarding mailbox settings (#745) (8d33bd9)
• fix division by zero issue on checkout (#746) (cee3094)
• fix php 8.1 deprecation notice in strtotime (#748) (eca47d6)
• mailbox works with kilo setting on php 8.1 (#744) (721259a)
• prevent type error in use entity id (#749) (57a05a7)
• use correct way to inject search value (#750) (d11f3e0)

4.8.0 (2023-01-03)

:bug: Bug Fixes

• fix division by zero when calculating package type (#737) (5811bc8)
• fix php 8.1 deprecation errors (#736) (81d49f1)
• trim postal code before validating (#735) (c502947)

:sparkles: New Features

• add eu insurance possibilities (#733) (1644a7b)

4.7.1 (2022-12-12)

:bug: Bug Fixes

• remove instabox (#731) (d1c66df)
• remove myparcel product attributes on uninstall (#722) (00a17c0)
• remove php deprecation warning (#721) (23af9f8)

4.7.0 (2022-10-05)

:sparkles: New Features

• allow exporting digital stamp (#716) (793e78c)
• show only relevant delivery options (#711) (1806558)

:bug: Bug Fixes

• fix delivery options loading forever (#713) (6dc37e2)
• fix mailbox amount (#714) (c9970f5)
• translate instabox strings (#718) (a15b595)

4.6.1 (2022-09-15)

:bug: Bug Fixes

• display correct version to end user (#706) (a821359)
• fix wrong parameter type (#707) (57d79fa)
• have cronjob update shipment status (#708) (a615f6e)

4.6.0 (2022-07-28)

:sparkles: New Features

• allow custom amount of items in mailbox package (#695) (557f355)

:bug: Bug Fixes

• compatibility with php 8.1 (#690) (027ee90)
• error invalid element tooltip (#698) (6e0ea60)
• export order from order details (#693) (5d04892)
• om: show enable setting (#691) (0a72278)
• only get available options for carriers (#703) (f6317f7), closes #701
• prevent loop while exporting shipment (#700) (ae83b0a)
• prevent upgrade from failing on new install (#702) (df24444)

4.5.0 (2022-06-14)

:sparkles: New Features

• add custom insurance option (#674) (caaee09)
• add instabox (#662) (d322919)
• update shipping status orderbeheer (#677) (2cbb2be)

:bug: Bug Fixes

• don't render delivery options when already visible (#680) (d5c084a)
• om: order grid shipment column options (#681) (cb7d2c0)
• regression: mailbox price is baseprice by itself (#686) (c7d07ac)
• regression: remove instabox pickup options (#685) (88f2020)
• set default carrier for row shipments (#679) (5f5437b)
• set filterable and searchable attributes to false (#668) (7961df1)