Brightpearl
The data from Brightpearl can be imported in just a few clicks into Lokad thanks to a native integration that leverages the Brightpearl API (see Brightpearl AppStore). In this page, we detail how to make the most of this native Brightpearl integration.
Setup of the Lokad/Brightpearl data connector
The suggested process to connect your Lokad and Brightpearl accounts is the following:
- Log into your Brightpearl account, and go to the Appstore
- Find the Lokad in-store app, and install it
- Click on Configure on the newly installed app
The last step will redirect you to your Lokad account and the data connection between your Lokad account and your Brightpearl account will be finalized there.
Two remarks:
- our data retrieval logic is read-only: your Brigthpearl data will not be modified in any way by Lokad; in the future, if Lokad were to add write capabilities for Brightpearl, we will make it very explicit whenever you are about to change anything within Brightpearl.
- your company remains the sole owner of your data; by default, we treat this data as if an NDA was in place between your company and Lokad; if you want an actual NDA to be signed, just drop us a message.
Filters for the sales orders
Lokad treats as sales orders all the orders retrieved from Brightpearl where the OrderType code is SO (Sales Order) or SC (Sales Credit) and where the OrderStatus is not Canceled SO.
Filters for the purchase orders
Lokad treats as purchase orders all the orders retrieved from Brightpearl where the order type code is PO (Purchase Order) or PC (Purchase Credit) and where the order status is not Canceled PO.
Stock on order calculation
Brightpearl does not offer a direct way to compute the stock on order. Thus, Lokad calculates this value based on the purchase orders. More specifically, we count as on order all the orders where
- the order type is
PO - the order status is not
Canceled PO - the stock status code is
PON(Purchase Order Not fulfilled) orPOP(Purchase Order Partly fulfilled) - the dropship status is false
Annex: Tables reference
Lokad retrieves extensive data from Brightpearl which include:
- All products with the brand, Sku, sell price, buy price…
- Custom attributes and seasons associated with the products
- All stock information: stock on hand, stock on order, outbound/inbound stock…
- The sales order history with the quantity, delivery date, net amount, client, status…
- The purchase order history with the quantity, delivery date, net amount, supplier, status…
- The price lists with the SKU, the price, the min quantity and the name of the list
All data are aggregated per product and per warehouse. They are pushed to your Lokad account into the following files:
- Brightpearl_ProductCustomFields.tsv
- Brightpearl_ProductSalesChannels.tsv
- Brightpearl_ProductWarehouses.tsv
- Brightpearl_ProductVariations.tsv
- Brightpearl_ProductPrices.tsv
- Brightpearl_PriceLists.tsv
- Brightpearl_ProductAvailabilities.tsv
- Brightpearl_Warehouses.tsv
- Brightpearl_Brands.tsv
- Brightpearl_Contacts.tsv
- Brightpearl_ContactPostalAddresses.tsv
- Brightpearl_Seasons.tsv
- Brightpearl_OrderFulfillments.tsv
- Brightpearl_OrderFulfillmentLocations.tsv
- Brightpearl_Orders.tsv
- Brightpearl_Reservations.tsv
- Brightpearl_PartialFulfillments.tsv
- Brightpearl_DropshipNotes.tsv
- Brightpearl_DropshipNoteOrderRows.tsv
- Brightpearl_DropshipNoteEvents.tsv
- Brightpearl_GoodsOuts.tsv
- Brightpearl_GoodsOutOrderRows.tsv
- Brightpearl_GoodsOutEvents.tsv
- Brightpearl_StockTransfers.tsv
- Brightpearl_GoodsIn.tsv
- Brightpearl_GoodsInMovements.tsv
Additional information can be found in Brightpearl’s documentation
Brightpearl_Products.tsv
Id: the ID of the productSkuBarcodeBrandIdIsBundledNominalCodeStockPrimarySupplierIdProductGroupIdProductTypeIdStatusStockTrackedTaxableTaxCodeTaxCodeIdWeight
Brightpearl_ProductCustomFields.tsv
SkuField: defined by the userValueProductId: the ID of the product
Brightpearl_ProductSalesChannels.tsv
Id: the ID of the productAvailableToSellOnChannelDescriptionProductConditionProductId: the ID of the productProductNameSalesChannelNameSellWhenNoStockShortDescription
Brightpearl_ProductWarehouses.tsv
DefaultLocationId: the ID of the default location in a given warehouseProductId: the ID of the productReorderLevelReorderQuantityWarehouseKey
Brightpearl_ProductVariations.tsv
OptionIdOptionNameOptionValueOptionValueIdProductId: the ID of the product
Brightpearl_ProductPrices.tsv
UnitPriceMinQuantityCurrencyCodePriceListIdProductId: the ID of the product
Brightpearl_PriceLists.tsv
Id: the ID of the productNameCodeCurrencyCodeCurrencyIdCurrencySymbolPriceListTypeCode
Brightpearl_ProductAvailabilities.tsv
AllocatedInStockOnHandProductId: the ID of the productTotalAllocatedTotalInStockTotalOnHandWarehouseId
Brightpearl_Warehouses.tsv
Id: the ID of the productNameAddressId
Brightpearl_Brands.tsv
Id: the ID of the productNameDescription
Brightpearl_Contacts.tsv
BillingPostalAddressIdContactIdCreatedOnCurrentContactStatusDefaultPostalAddressIdDeliveryPostalAddressIdEmailFirstNameIsPrimaryContactIsStaffIsSupplierLastNameOrganisationIdOrganisationNameReceiveEmailNewsletter
Brightpearl_ContactPostalAddresses.tsv
Id: the ID of the productAddressLine1AddressLine2AddressLine3AddressLine4ContactIdCountryIsoCodePostalCode
Brightpearl_Seasons.tsv
Id: the ID of the productNameDescription
Brightpearl_OrderFulfillments.tsv
QuantityOrderId: the ID of the orderFulfilledShipped
Brightpearl_OrderFulfillmentLocations.tsv
QuantityOrderId: the ID of the orderFulfilledLocationIdShipped
Brightpearl_Orders.tsv
DeliveryDateQuantityNetAmountTaxAmountCurrencyChannelOrderStatusOrderId: the ID of the orderAcknowledgedAllocationStatus: the code that indicates whether the stock has been allocatedBillingContactIdBillingPartyEmailBillingPartyNameChannelIdCreatedByIdCreatedDateDeliveryPartyContactIdDeliveryPartyEmailDeliveryPartyNameIsDropShipNetAmountTotalOrderPaymentStatusOrderRowIdOrderType: the code that distinguishes Sales Orders, Purchase Orders, Sales Credits and Purchase CreditsParentOrderIdPlacedOnDatePriceListIdPriceModeProductId: the ID of the productProductNameProductSkuReferenceShippingStatusStockStatusSupplierPartyContactIdSupplierPartyEmailSupplierPartyNameTaxAmountTotalWarehouseWarehouseId
Brightpearl_Reservations.tsv
QuantityOrderRowIdProductId: the ID of the productWarehouse
Brightpearl_PartialFulfillments.tsv
QuantityOrderRowIdProductId: the ID of the productWarehouse
Brightpearl_DropshipNotes.tsv
Id: the ID of the productOrderId: the ID of the orderIsShippedPurchaseOrderIdShippedByIdShippedOnShippingMethodIdShippingRefSupplierId
Brightpearl_DropshipNoteOrderRows.tsv
QuantityOrderId: the ID of the orderDropshipNoteIdLocationIdOrderRowIdProductId: the ID of the productPurchaseOrderId
Brightpearl_DropshipNoteEvents.tsv
OrderId: the ID of the orderDropshipNoteIdEventCodeEventOwnerIdOccuredPurchaseOrderId
Brightpearl_GoodsOuts.tsv
Id: the ID of the productOrderId: the ID of the orderCreatedByCreatedOnEventCountLabelUriOrderRowCountPackedPackedByIdPackedOnPickedPickedByIdPickedOnPrintedPrintedByIdPrintedOnPriorityReleaseDateSequenceShippedShippedByIdShippedOnShippingBoxesShippingMethodIdShippingReferenceTransferWarehouseIdWeight
Brightpearl_GoodsOutOrderRows.tsv
Id: the ID of the productQuantityGoodsOutIdLocationIdProductId: the ID of the productUserBatchReference
Brightpearl_GoodsOutEvents.tsv
EventCodeEventOwnerIdGoodsOutIdOccured
Brightpearl_StockTransfers.tsv
CreatedByCreatedOnGoodsOutNoteIdReferenceSourceWarehouseIdStockTransferIdTargetWarehouseId
Brightpearl_GoodsIn.tsv
OrderId: the ID of the orderCreatedByGoodsMovementCountGoodsNoteIdGoodsNoteStatusReceivedOnTransferUserBatchReference
Brightpearl_GoodsInMovements.tsv
QuantityAllocatedBatchGoodsNoteIdClearedCreatedByCreatedOnDestinationLocationIdGoodsNoteIdProductId: the ID of the productProductValueProductValueCurrencyPurchaseOrderRowIdQuarantineUpdatedByUpdatedOnValueConfirmedWarehouseId