DHL Carrier Wrong Service Type Variable Displayed in Tracking Popup
Preconditions and environment
- Magento Version 2.0.0 - 2.4.9
Functional Testing Scenario 1: (Shipment with description)
Steps to reproduce
- Configure the DHL shipping/delivery method using valid API credentials.
- Make sure that the "Content Type (Non Domestic)" configuration field is set to "Non documents", if applicable.
- Add any non-virtual product to a shopping cart.
- Place an order with a shipping address.
- Create a shipment for the order.
- Add a valid DHL tracking number for a shipment with description, selecting DHL under the Carrier column.
- Open the shipment Tracking Information popup for the order.
Expected result
The DHL product title is displayed as the Service Type.
Actual result
The DHL shipment description is displayed as the Service Type.
Functional Testing Scenario 2: (Shipment without description)
Steps to reproduce
- Configure the DHL shipping/delivery method using valid API credentials.
- Make sure that the "Content Type (Non Domestic)" configuration field is set to "Non documents", if applicable.
- Add any non-virtual product to a shopping cart.
- Place an order with a shipping address.
- Create a shipment for the order.
- Add a valid DHL tracking number for a shipment without description, selecting DHL under the Carrier column.
- Open the shipment Tracking Information popup for the order.
Expected result
The DHL product title is displayed as the Service Type.
Actual result
The Service Type is not displayed.
Additional information
The DHL product title can be obtained by using the GlobalProductCode variable, instead of the ShipmentDesc variable, and passing it to the Magento\Dhl\Model\Carrier::getDhlProductTitle() function.
Release note
Fixed: The DHL shipment description was used as the Service Type instead of the DHL product title in the shipment Tracking Information popup.
Triage and priority
- [ ] Severity: S0 - Affects critical data or functionality and leaves users without workaround.
- [ ] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
- [ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
- [x] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
- [x] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.
Hi @nicolasddev. Thank you for your report. To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.
- For more details, review the Magento Contributor Assistant documentation.
- Add a comment to assign the issue:
@magento I am working on this - To learn more about issue processing workflow, refer to the Code Contributions.
Join Magento Community Engineering Slack and ask your questions in #github channel. :warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting. :clock10: You can find the schedule on the Magento Community Calendar page. :telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.
Hi @engcom-November. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:
- [ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
- [ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
- [ ] 3. Add
Area: XXXXXlabel to the ticket, indicating the functional areas it may be related to. - [ ] 4. Verify that the issue is reproducible on
2.4-developbranchDetails
- If the issue is reproducible on2.4-developbranch, please, add the labelReproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here! - [ ] 5. Add label
Issue: Confirmedonce verification is complete. - [ ] 6. Make sure that automatic system confirms that report has been added to the backlog.
Hello @nicolasddev ,
Thank you for the report and your collaboration.
We attempted to reproduce this issue on the latest 2.4-develop branch, but we were unable to replicate the problem.
Please find the reference screenshot below.
Steps we followed to reproduce:
- Configure the DHL shipping/delivery method using valid API credentials.
- Ensure the “Content Type (Non Domestic)” field is set to “Non documents”, if applicable.
- Add any non-virtual product to the cart.
- Place an order with a shipping address.
- Create a shipment for the order.
- Add a valid DHL tracking number, selecting DHL under the Carrier column.
- Open the shipment’s Tracking Information popup.
We did not encounter any issues during these steps. Could you please review and let us know if we might have missed anything while attempting to reproduce it?
We are therefore marking this issue as “Needs Update.”
Thank you!
Hi @engcom-November,
Thank you for attempting to reproduce this issue.
I confirm that the "Steps to reproduce" that I previously provided are correct.
Based on the information provided, you did not follow the step 6 correctly, which was "Add a valid DHL tracking number, selecting DHL under the Carrier column."
Since this information is retrieved via the DHL API, a valid DHL tracking number must be provided in order to reproduce this issue.
Alternatively, you may always attempt to use the sandbox mode if you cannot use a valid DHL tracking number for testing purposes.
However, since the DHL integration currently relies on the wrong variable for displaying the Service Type, a shipment description must be provided when generating the shipping label. The step 6 has been updated accordingly and a second functional testing scenario has been added in order to facilitate reproducing this issue.
Hi @engcom-Hotel. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:
- [ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
- [ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
- [ ] 3. Add
Area: XXXXXlabel to the ticket, indicating the functional areas it may be related to. - [ ] 4. Verify that the issue is reproducible on
2.4-developbranchDetails
- If the issue is reproducible on2.4-developbranch, please, add the labelReproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here! - [ ] 5. Add label
Issue: Confirmedonce verification is complete. - [ ] 6. Make sure that automatic system confirms that report has been added to the backlog.