MAGESHIP-21-develop Add track_url to DB & API and send via Customer S…

[RhodriOwainDavies]

Please beware this is critical for Magento Shipping (to be released in v2.2.2 - discuss with @joni-jones @orlangur & Nadia Kalinovich

Linked to #10799

Forked from develop branch, merge target branch develop as per @orlangur 's request.

Description

Add a new field sales_shipment_track.track_url.
Expose this field via API.
Including this URL as a hyperlink in the Shipment Sent Email template.

Feature

To support impending Magento Shipping feature request of inserting Carrier Specific URL in email template to Customer

Manual testing scenarios

1. API Test
   POST /V1/order/{orderId}/ship
   Pass in tracking_url as an extension attribute (in same manner as tracking_number)
2. UI Test
   In the admin section, view a Shipment which already has a trackinging URL set (via API in Test Can you commit to repository a folder dev/tests/static ? #1). Click Send Tracking Email. Check email, Tracking Number should be a hyperlink to tracking_url

Contribution checklist

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds on Travis CI are green)

[vrann]

This change is not needed, the version of the extension will be bumped automatically during the build depending on the severity of the changes

[RhodriOwainDavies]

Updated

[vrann]

TrackUrl interface is added to the system but never referenced neither from the interfaces in Api namespace nor from the extensions attributes. How is it expected to be exposed through the API?

I tried to run API query adding track_url to the body, but it resulted in decoding error, because Property TrackUrl does not have corresponding setter in class Magento\Sales\Api\Data\ShipmentTrackCreationInterface

Please advise.

Request:

{
  "items": [
    {
      "extension_attributes":[],
      "order_item_id":3,
      "qty":1
    
    },
    {
      "extension_attributes":[],
      "order_item_id":4,
      "qty":1
    }
  ],
  "notify":true,
  "appendComment":true,
  "comment":{
    "extension_attributes":[],
    "comment":"Shipped via Shipment Provider",
    "is_visible_on_front":0
  },
  "tracks":[
    {
      "extension_attributes":[],
      "track_number":"1234567890",
      "track_url": "http://fedex.com/122321212",
      "title":"fedex",
      "carrier_code":
      "fedex"
    }
  ],
  "packages":[
    {
      "extension_attributes":[]
    }
  ],
  "arguments":{
    "extension_attributes":[]
  }
}

[vrann]

this constant does not have corresponding getter and setter in this interface and should not reside here, rather in the interface which has setter for it.

[RhodriOwainDavies]

Hi @vrann

Thanks for your review, I've addressed all your comments. Can you please test again and let me know. If the changes are successful, I'll update #10977 with the same changes.

Cheers,

Rhodri D

[vrann]

I was expecting to see tracking URL in the admin backend and in the customer account on the frontend, but neither of those places has it. Is it just sent via email? Please add them to order shipments and to the customer account.

[vrann]

This change is not needed, it will be automatically set by the packaging tool

[vrann]

@RhodriOwainDavies discussed with @antonkril today, this change cannot be released in 2.2 as backward incompatible. Please re-create the PR for develop branch