Zone GET

URI

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

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

Description

Returns zones for the specified warehouse.

There are two parameters which are specified in the URI:

  • Warehouse ID - The parameter simply specifies the ID of the warehouse you wish to query for zones.
  • Zone ID-SET - This is an OPTIONAL parameter where you can specify a discrete set of zone ID's which you wish to be returned.

Example 1

Demonstrates the simplest usage to get all zones for warehouse 2.

Request URI

/warehouse/2/zone/

Response

{
	"response": [
		{
			"id": 1,
			"name": "Bulk",
			"warehouseId": 2
		},
		{
			"id": 2,
			"name": "Hazardous Material",
			"warehouseId": 2
		},
		{
			"id": 4,
			"name": "High Value",
			"warehouseId": 2
		},
		{
			"id": 5,
			"name": "Shipping",
			"warehouseId": 2
		}
	]
}

Example 2

Demonstrates a more complex usage requesting zones from warehouse 2 with ID's 1 through 3 and 5.

Request URI

/warehouse/2/zone/1-3,5

Response

{
	"response": [
		{
			"id": 1,
			"name": "Bulk",
			"warehouseId": 2
		},
		{
			"id": 2,
			"name": "Hazardous Material",
			"warehouseId": 2
		},
		{
			"id": 5,
			"name": "Shipping",
			"warehouseId": 2
		}
	]
}