Goods-Out Note Search

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/goods-note/goods-out-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
goodsOutNoteId INTEGER None The ID of the goods out note.
printed BOOLEAN None Details whether a goods out note has been printed.
picked BOOLEAN None Details whether a goods out note has been printed.
packed BOOLEAN None Details whether a goods out note has been packed.
shipped BOOLEAN None Details whether a goods out note has been shipped.
shippedOn PERIOD None The date the goods out note was shipped on.
orderId INTEGER None The ID of the order for the goods out note. Can be used to recover information about an order with an Order GET
shippingMethodId IDSET None
warehouseId INTEGER None The ID of the warehouse for the goods out note. Can be used to recover information about a warehouse with a Warehouse GET
priority BOOLEAN None The priority of the goods out note.
createdOn PERIOD None The date the goods out note was created on.
releaseDate PERIOD None The date the goods out note is to be released.
createdBy INTEGER None The ID of the contact that created this goods out note.
labelUri STRING None The URL of the shipping label image (optional)
channelId INTEGER None The Channel ID for the related order
transfer BOOLEAN None Details whether a goods out note is a transfer.

Sorting

Sorted by Sort Direction
goodsOutNoteId ASC

More information

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