Repository navigation
Add delivery_bill_id to shipment fulfillment payload - #291
Open
Marvin-Magmodules wants to merge 2 commits into
Open
Marvin-Magmodules wants to merge 2 commits into
Marvin-Magmodules wants to merge 2 commits into
Conversation
Release 1.24.3
Channable requires a delivery_bill_id on every shipment update: the number of the delivery note included in the parcel, used by marketplaces such as Conrad to match their invoice to the delivery. - Defaults to the Magento shipment increment ID, which is printed on the standard packing slip - ERP systems can supply their own number through the channable_delivery_bill_id extension attribute, on shipment creation or on an existing shipment - Add shipment_id to the shipments webhook so multiple shipments of the same order can be told apart - Return one fulfillment entry per shipment on the order status endpoint; the previous merge flattened them and lost tracking data of later shipments - Add Magento module dependencies to the module sequence - Add E2E coverage and merchant documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Channable requires a
delivery_bill_idon every shipment update: the number of the delivery note included in the parcel. Marketplaces such as Conrad use it to match their invoice to the physical delivery the customer received.What it does
Default — the Magento shipment increment ID. Works out of the box for every merchant, no configuration or manual input. It is already printed on Magento's standard packing slip, so the number in the parcel matches the number Channable receives.
ERP override. Merchants who print delivery notes from an ERP (
DSN-123) supply their own number through thechannable_delivery_bill_idextension attribute on the shipment, either on creation:or afterwards, when a shipping extension created the shipment:
Empty falls back to the increment ID, so shipping extensions that know nothing about the field keep working unchanged.
Multi-shipment fixes
shipment_id. Previouslyidheld the order increment ID, so two shipments of the same order were indistinguishable.+=, silently dropping the tracking data of the second and later shipments. It now returns afulfillmentsarray with one entry per shipment. The existingfulfillmentkey is kept and holds the most recent shipment, so the Channable side does not break.Changes
Service/Order/Shipping/Fulfillment.php—delivery_bill_idwith ERP override and fallbackService/Webhook/Shipments.php—shipment_idper entryService/Webhook/OrderStatus.php— one fulfillment entry per shipmentPlugin/Shipment/DeliveryBillId.php— load and persist the extension attributePlugin/Shipment/DeliveryBillIdArgument.php— accept the value as shipment creation argumentetc/db_schema.xml—channable_delivery_bill_idonsales_shipment(nullable varchar, instant DDL)etc/module.xml— completed the module sequenceTesting
12 new E2E tests in
Test/End-2-end/tests/order/delivery-bill-id.spec.tscovering the default, both ERP paths, the fallback and multi-shipment orders. Full suite green on the VPS: 62 passed.Merchant documentation added in
docs/SHIPMENTS.md+docs/SHIPMENTS_NL.md.