Bundle Availability GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/warehouse-service/bundle-availability/{PRODUCT-ID}

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

Description

Returns the bundle availability for a given bundle product ID.

The return of the method is a bundle ID with the following information:

  • A summary giving the total availability across all warehouses
  • A breakdown of availability for each warehouse that currently contains all the required products

Note: This message is only applicable to stock bundles. For single stock items use Product Availability GET.

Example

Fetch the on-hand quantity for bundle product 1013.

Request URI

/bundle-availability/1013

Request body

{
}

Response

{
	"response": {
		"1013": {
			"total": {
				"onHand": 5
			},
			"warehouses": {
				"2": {
					"onHand": 0
				},
				"3": {
					"onHand": 5
				}
			}
		}
	}
}