Goods-Out Note Event POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/goods-note/goods-out/{ID}/event

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

Description

This message enables you to add an event to an existing goods-out note. All three fields are required along with a valid goods-out note Id.

Possible Event Codes:

  • PRI: Printed - The time the Goods-Out Note was printed
  • UPR: Unprinted - The time the Goods-Out note was unprinted
  • PIC: Picked - The time the Goods-Out Note was picked
  • UPI: Unpicked - The time the Goods-Out note was unpicked
  • PAC: Packed - The time the Goods-Out Note was packed
  • UPA: Unpacked - The time the Goods-Out Note was unpacked
  • SHW: Shipped - The time the Goods-Out Note was shipped from a warehouse

When setting a goods note to shipped, if the goods note has not been printed, picked or packed previously, then those events will be created before it is set to shipped.

The request message can contain a list of event objects. Each event should contain:

  • eventCode:
    • PRI: Printed
    • UPR: Unprinted
    • PIC: Picked
    • UPI: Unpicked
    • PAC: Packed
    • UPA: Unpacked
    • SHW: Shipped
  • occured: The date and time the event occured
  • eventOwnerId: The ID of the contact that performed the event

Note: Once shipped, you can no longer add events to the goods-out note.

Example

Add a picked and shipped event to the goods-out note.

Request URI

/goods-note/goods-out/3/event

Request body

{
	"events": [
		{
			"eventCode": "PIC",
			"occured": "2011-07-15T16:10:45.555Z",
			"eventOwnerId": 182
		},
		{
			"eventCode": "SHW",
			"occured": "2011-07-28T19:10:45.555Z",
			"eventOwnerId": 123
		}
	]
}

Response

{
}