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 productSku
Barcode
BrandId
IsBundled
NominalCodeStock
PrimarySupplierId
ProductGroupId
ProductTypeId
Status
StockTracked
Taxable
TaxCode
TaxCodeId
Weight
Brightpearl_ProductCustomFields.tsv
Sku
Field
: defined by the userValue
ProductId
: the ID of the product
Brightpearl_ProductSalesChannels.tsv
Id
: the ID of the productAvailableToSellOnChannel
Description
ProductCondition
ProductId
: the ID of the productProductName
SalesChannelName
SellWhenNoStock
ShortDescription
Brightpearl_ProductWarehouses.tsv
DefaultLocationId
: the ID of the default location in a given warehouseProductId
: the ID of the productReorderLevel
ReorderQuantity
WarehouseKey
Brightpearl_ProductVariations.tsv
OptionId
OptionName
OptionValue
OptionValueId
ProductId
: the ID of the product
Brightpearl_ProductPrices.tsv
UnitPrice
MinQuantity
CurrencyCode
PriceListId
ProductId
: the ID of the product
Brightpearl_PriceLists.tsv
Id
: the ID of the productName
Code
CurrencyCode
CurrencyId
CurrencySymbol
PriceListTypeCode
Brightpearl_ProductAvailabilities.tsv
Allocated
InStock
OnHand
ProductId
: the ID of the productTotalAllocated
TotalInStock
TotalOnHand
WarehouseId
Brightpearl_Warehouses.tsv
Id
: the ID of the productName
AddressId
Brightpearl_Brands.tsv
Id
: the ID of the productName
Description
Brightpearl_Contacts.tsv
BillingPostalAddressId
ContactId
CreatedOn
CurrentContactStatus
DefaultPostalAddressId
DeliveryPostalAddressId
Email
FirstName
IsPrimaryContact
IsStaff
IsSupplier
LastName
OrganisationId
OrganisationName
ReceiveEmailNewsletter
Brightpearl_ContactPostalAddresses.tsv
Id
: the ID of the productAddressLine1
AddressLine2
AddressLine3
AddressLine4
ContactId
CountryIsoCode
PostalCode
Brightpearl_Seasons.tsv
Id
: the ID of the productName
Description
Brightpearl_OrderFulfillments.tsv
Quantity
OrderId
: the ID of the orderFulfilled
Shipped
Brightpearl_OrderFulfillmentLocations.tsv
Quantity
OrderId
: the ID of the orderFulfilled
LocationId
Shipped
Brightpearl_Orders.tsv
DeliveryDate
Quantity
NetAmount
TaxAmount
Currency
Channel
OrderStatus
OrderId
: the ID of the orderAcknowledged
AllocationStatus
: the code that indicates whether the stock has been allocatedBillingContactId
BillingPartyEmail
BillingPartyName
ChannelId
CreatedById
CreatedDate
DeliveryPartyContactId
DeliveryPartyEmail
DeliveryPartyName
IsDropShip
NetAmountTotal
OrderPaymentStatus
OrderRowId
OrderType
: the code that distinguishes Sales Orders, Purchase Orders, Sales Credits and Purchase CreditsParentOrderId
PlacedOnDate
PriceListId
PriceMode
ProductId
: the ID of the productProductName
ProductSku
Reference
ShippingStatus
StockStatus
SupplierPartyContactId
SupplierPartyEmail
SupplierPartyName
TaxAmountTotal
Warehouse
WarehouseId
Brightpearl_Reservations.tsv
Quantity
OrderRowId
ProductId
: the ID of the productWarehouse
Brightpearl_PartialFulfillments.tsv
Quantity
OrderRowId
ProductId
: the ID of the productWarehouse
Brightpearl_DropshipNotes.tsv
Id
: the ID of the productOrderId
: the ID of the orderIsShipped
PurchaseOrderId
ShippedById
ShippedOn
ShippingMethodId
ShippingRef
SupplierId
Brightpearl_DropshipNoteOrderRows.tsv
Quantity
OrderId
: the ID of the orderDropshipNoteId
LocationId
OrderRowId
ProductId
: the ID of the productPurchaseOrderId
Brightpearl_DropshipNoteEvents.tsv
OrderId
: the ID of the orderDropshipNoteId
EventCode
EventOwnerId
Occured
PurchaseOrderId
Brightpearl_GoodsOuts.tsv
Id
: the ID of the productOrderId
: the ID of the orderCreatedBy
CreatedOn
EventCount
LabelUri
OrderRowCount
Packed
PackedById
PackedOn
Picked
PickedById
PickedOn
Printed
PrintedById
PrintedOn
Priority
ReleaseDate
Sequence
Shipped
ShippedById
ShippedOn
ShippingBoxes
ShippingMethodId
ShippingReference
Transfer
WarehouseId
Weight
Brightpearl_GoodsOutOrderRows.tsv
Id
: the ID of the productQuantity
GoodsOutId
LocationId
ProductId
: the ID of the productUserBatchReference
Brightpearl_GoodsOutEvents.tsv
EventCode
EventOwnerId
GoodsOutId
Occured
Brightpearl_StockTransfers.tsv
CreatedBy
CreatedOn
GoodsOutNoteId
Reference
SourceWarehouseId
StockTransferId
TargetWarehouseId
Brightpearl_GoodsIn.tsv
OrderId
: the ID of the orderCreatedBy
GoodsMovementCount
GoodsNoteId
GoodsNoteStatus
ReceivedOn
Transfer
UserBatchReference
Brightpearl_GoodsInMovements.tsv
Quantity
Allocated
BatchGoodsNoteId
Cleared
CreatedBy
CreatedOn
DestinationLocationId
GoodsNoteId
ProductId
: the ID of the productProductValue
ProductValueCurrency
PurchaseOrderRowId
Quarantine
UpdatedBy
UpdatedOn
ValueConfirmed
WarehouseId