Reservation GET

URI

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

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

Description

Returns the order ID, warehouse ID and a reservation per each order row. Each reservation specifies the product ID and the quantity reserved.

Example 1

Return the reservation(s) againsts the order 54

Request URI

/order/54/reservation

Response

{
	"response": [
		{
			"orderId": 54,
			"warehouseId": 2,
			"orderRows": {
				"68": {
					"productId": 1010,
					"quantity": 5
				}
			}
		}
	]
}

Example 2

No reservation exists for order 62

Request URI

/order/62/reservation

Response

{
	"errors": [
		{
			"code": "CMNC-404",
			"message": "No reservation exists for order 62"
		}
	]
}