Goods Movement Search

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/goods-movement-search

Refer to our documentation on URI syntax for more information on how to construct URIs.

Columns

Name Required Sortable Filterable Data type Reference data Description
goodsMovementId IDSET None The ID of the goods movement.
productId INTEGER None The product ID of the goods on the goods movement
salesOrderRowId IDSET None The sales order row ID
purchaseOrderRowId IDSET None The ID of the purchase order row.
quantity INTEGER None The quantity of goods moved
destinationLocationId INTEGER None The location ID of the goods movement
warehouseId INTEGER None The ID of the warehouse on the goods movement
goodsNoteId IDSET None The ID of the goods note.
productValue STRING None The value of the goods on the movement
currencyCode STRING None The value of the goods on the movement
orderId INTEGER None The order ID of the parent order of the purchase or sale order row
isCleared BOOLEAN None Whether the stock is cleared or not
isQuarantine BOOLEAN None Whether the stock is quarantined or not
batchId INTEGER None The batch ID of the stock on the goods movement
goodsNoteTypeCode STRING None The type of goods note the movement belongs to:
  • DS - Drop-ship
  • GI - Goods in
  • GO - Goods out
  • IT - Internal transfer
  • RV - Reservation
  • SC - Stock correction
  • WO - Write off
updatedOn PERIOD None The date the goods movement was updated on.

Sorting

Sorted by Sort Direction
goodsNoteId DESC

More information

Instructions for working with resources can be found in Resource search design