Goods-Out Note PUT

URI

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

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

Description

This message enables you to update the following attributes of a Goods-Out Note.

  • priority: The priority of the goods-out note.
  • shipping.shippingMethodId: The Id of the shipping method. This can be retrieved using the Shipping Method GET.
  • shipping.boxes: The number of boxes.
  • shipping.reference: A string of up to 64 characters.
  • shipping.weight: The total weight of products on the goods-out note. The maximum weight can be up to 999,999.99.
  • labelUri: The URL to the image of a packing label. This is optional and can be left blank. Max length is 512 characters.

Note: Once the goods-out note has been shipped, no further updates are allowed.

Example

Update goods-out note 22.

Request URI

/goods-note/goods-out/22

Request body

{
	"priority": false,
	"shipping": {
		"shippingMethodId": 1231,
		"reference": "REF-H73JD329K",
		"boxes": 118,
		"weight": "113.28"
	},
	"labelUri": "http://somedomain.com/packinglabel/image.jpg"
}

Response

{
}