Magento import shipments interaction

The import shipments interaction updates the Magento order with details of the shipment made in Brightpearl, including drop-shipped items.

The shipment will include item details, shipping methods and tracking references.

Import shipment triggers

Shipments can be recorded against Magento orders at any of the following times:

Time Description Execution method
Real-time Updates the relevant order as and when items are shipped in Brightpearl via goods-out or drop-ship Webhook
Cronjob Checks all open orders in Magento for goods-out notes and drop-ship notes in Brightpearl Scheduled
Manual: real-time Imports the details of a specific goods-out note or drop-ship note in Brightpearl Manual

How to run the real-time import shipments interaction

  1. In the Magento admin panel, go to:

    Magento 1: Interactions > Brightpearl > Interactions

    Magento 2: Brightpearl > Brightpearl interactions > Interactions

  2. Select Import shipments (real-time).
  3. Enter the Brightpearl goods out note ID or drop-ship note ID. This is the Brightpearl system ID, not the goods out or drop-ship note reference. To find the ID open the goods out note in Brightpearl and find it in the URL. Use the API to get dropship note IDs or contact support.
  4. Specify whether the customer should be sent an email (sent from Magento) to notify them of the shipment.
  5. Click Execute to run the import.
  6. Review the log for any warnings or errors.

Shipping methods and carriers

Shipping methods will need to be mapped within the extension configuration at Shared: Shipment settings. If the shipping method is not mapped, a custom value will be seen on the shipment in Magento.

Shipments will be added to Magento orders with the shipping method applied to the goods out note or drop-ship note in Brightpearl. Note that this can be different from the method assigned to the order originally.


Tracking reference

If a tracking reference is recorded on the shipment in Brightpearl, it will be recorded on the shipment in Magento.

Shipping confirmation customer emails

To update customers of shipments, an email can be triggered from either Brightpearl or Magento.

Check the Magento configuration within the Shared: Shipment settings to see if emails will be sent from Magento.


How is the shipping import different from the shipment reconciliation?

This interaction differs from the shipment reconciliation because it looks for specific goods out notes and drop-ship notes in Brightpearl, where the shipment reconciliation just checks to see whether the order has been fully shipped in Brightpearl. Therefore, the import shipments interaction imports detailed shipping information while the shipment reconciliation does not.

I have run the import shipments interaction but the wrong shipping method has been applied. Why?

If the shipping method applied to the shipment in Brightpearl is not mapped to a shipping method in Magento then the original shipping method on the Magento order will be used, which may be different from the method actually selected at point of shipping. Ensure mapping has been configured and is correct.

Have more questions? Submit a request