Warehouse Defaults GET

URI

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

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

Description

Returns warehouse defaults for the specified warehouse and products.

There are two parameters which are specified in the URI:

  • Warehouse ID - The parameter specifies the ID of the warehouse you wish to query for warehouse defaults.
  • Product ID-SET - The parameter specifies the discrete set of product IDs which you wish to query for warehouse defaults.

Currently the warehouse service can return at most the details of 200 warehouse defaults in a single request/response transaction. To obtain details on a larger set, multiple service calls must be made.

Example 1

Demonstrates the simplest usage to get warehouse defaults for product 1007 in warehouse 2.

Request URI

/warehouse/2/product/1007

Response

{
	"response": [
		{
			"productId": 1007,
			"defaultLocationId": 2,
			"overflowLocationId": 19,
			"reorderLevel": 5,
			"reorderQuantity": 25
		}
	]
}

Example 2

Demonstrates a more complex usage requesting warehouse defaults for products 1007 through 1010 and 1015 in warehouse 2.

Request URI

/warehouse/2/product/1007-1010,1015

Response

{
	"response": [
		{
			"productId": 1007,
			"defaultLocationId": 2,
			"overflowLocationId": 19,
			"reorderLevel": 5,
			"reorderQuantity": 25
		},
		{
			"productId": 1009,
			"defaultLocationId": 3,
			"overflowLocationId": 3,
			"reorderLevel": 10,
			"reorderQuantity": 5
		},
		{
			"productId": 1015,
			"defaultLocationId": 6,
			"overflowLocationId": 15,
			"reorderLevel": 3,
			"reorderQuantity": 15
		}
	]
}