What are interactions?

An interaction is any time Magento attempts to speak with your Brightpearl account. There are different types of interaction:

  • An import is used to bring data from Brightpearl into Magento
  • An export is used to send data to Brightpearl from Magento

Summary of Brightpearl Magento extension interactions

Import Brightpearl settings  This interaction draws in all warehouses, channels, price lists, shipping methods, order statuses, custom fields, payment methods/nominal codes which are required for configuration. It is needed only for first configuring, or updating the configuration
Import stock levels

The stock level imports will keep product availability up-to-date in Magento by importing the onhand quantity from Brightpearl. Real-time updates are triggered off front-end activity to keep availability as accurate as possible. Bulk updates can be scheduled to run automatically to ensure complete accuracy. Manual imports for one or more, or all products can be triggered at any time

Export orders

The orders export will send new Magento orders to Brightpearl for processing. This will happen at various trigger points throughout the order creation process and can also be run as a cronjob to ensure nothing is missed. A manual export can be run at any time for one or more order IDs

Export order status

The order status export will update orders in Brightpearl with the current order status in Magento. This will happen as and when the status changes are made or can be run as a cronjob to ensure all statuses match between the two applications at a specific point in time. It can also be run manually for a specific order ID

Export order payments The order payments export will create order payments in Brightpearl to mark the orders as paid, and where necessary create the accounting. This will happen at various trigger points and can also be run as a cronjob to pick up any queued which missed the trigger
Reconcile orders The order reconciliation will export any orders in Magento that have by-passed all the usual trigger points and were never queued for export - perhaps they were created in a none typical way
Import shipments The shipment import will create shipments in Magento as and when items are shipped in Brightpearl (using webhooks). This interaction can also be run as a cronjob or manually for a specific goods-out note
Reconcile shipments The shipment reconciliation will check the current shipping status in Brightpearl for all incomplete orders in Magento. This ensures that orders can be completed in Magento even where no shipping update will be triggered by Brightpearl (e.g. non-stock tracked items)
Import order status The order status import will update orders in Magento with the current order status in Brightpearl. This will happen as and when the status changes are made (using webhooks) or can be run as a cronjob to ensure all statuses match between the two applications at a specific point in time. It can also be run manually for a specific order ID
Import prices

The prices import will update all the mapped price attributes, customer groups and tier pricing, using the prices from Brightpearl. It can be set to run as a cronjob to check all products for updates or manually for specific SKUs

Export SKUs

The SKU export will tell Brightpearl which products are listed and what the current availability is. This provides the channel availability on the product list in Brightpearl, and allows a report of items connected/not connected to be produced

Register integration webhooks

The webhook registration interaction is used to activate webhooks on the connected Brightpearl account. It must be run in order to receive order status and shipping updates from Brightpearl in real-time

Have more questions? Submit a request

0 Comments

Article is closed for comments.