Reservation POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/order/{ORDER-ID}/reservation/warehouse/{WAREHOUSE-ID}

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

Description

This method will create a reservation note for an order.

Note:Only one reservation note can be created per sales order so you cannot reserve stock from many warehouses.

Stock will be reserved following fifo (stock which enters the Warehouse first will be used first) rules.

If you request to allocate 10 items however there is only 5 on hand the reservation will still succeed however only 5 items will be reserved. If no items were available to be reserved an error will be returned.

Example 1

Demonstrates reserving 5 of product id 1010 for order 54

Request URI

/order/54/reservation/warehouse/2

Request body

{
	"products": [
		{
			"productId": "1010",
			"salesOrderRowId": "68",
			"quantity": "5"
		}
	]
}

Response

{
}

Example 2

Demonstrates trying to reserve against an invalid product id

Request URI

/order/55/reservation/warehouse/2

Request body

{
	"products": [
		{
			"productId": "0",
			"salesOrderRowId": "68",
			"quantity": "5"
		}
	]
}

Response

{
	"errors": [
		{
			"code": "WHSC-014",
			"message": "Product ID must be set and greater than 0"
		}
	]
}