Quarantine Release POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/warehouse/{ID}/quarantine/release

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

Description

This method is used to Release Stock from the Quarantine Location to another Location within the warehouse.

The request URI takes the ID of the Warehouse of which you wish to Release Stock items from the Quarantine Location.

There body of the request has three simple arguments:

  • productId - The ID of the Stock item of which you are to Transfer.
  • quantity - How many Stock items to Transfer.
  • toLocationId - The destination Location ID.

Example 1

Release 5 of the Stock with ID 1223 to Location 7.

Request URI

/warehouse/2/quarantine/release

Request body

{
	"productId": 1223,
	"quantity": 5,
	"toLocationId": 7
}

Response

{
}

Example 2

Trying to Release 5 of the Stock with ID 1223 to Location 7 where there are no Stock to release. Notice the response refers to 'location 3' this is the ID of the Quarantine Location.

Request URI

/warehouse/2/quarantine/release

Request body

{
	"productId": 1223,
	"quantity": 5,
	"toLocationId": 7
}

Response

{
	"errors": [
		{
			"code": "WHSB-023",
			"message": "None of the requested products are available in location 3"
		}
	]
}