Location GET

URI

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

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

Description

Returns Location's 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 Locations.
  • Location ID-SET - This is an OPTIONAL parameter where you can specify a discrete set of Location ID's of which you wish to know about.

The returned location contains the following fields:

  • id - The ID of the location
  • warehouseId - The ID of the warehouse this location is part of
  • zoneId - The ID of the warehouse zone this location is assigned to (if set)
  • barcode - The barcode of the location
  • groupingA - The aisle number/name
  • groupingB - The bay number/name (if set)
  • groupingC - The shelf number/name (if set)
  • groupingD - The bin number/name (if set)

Example 1

Demonstrates the simplest usage to get all Locations for Warehouse 1. As you can see two Locations are returned the Default Locations and the Quarantine Location.

Request URI

/warehouse/1/location/

Request body

{
}

Response

{
	"response": [
		{
			"id": 1,
			"groupingA": "0",
			"groupingB": "0",
			"groupingC": "0",
			"groupingD": "0",
			"barcode": "9048550001"
		},
		{
			"id": 9,
			"groupingA": "QUARANTINE"
		}
	]
}

Example 2

Demonstrates a more complex usage requesting Locations from the warehouse with Id's 1 through 5 and 8.

Request URI

/warehouse/3/location/1-5,8

Request body

{
}

Response

{
	"response": [
		{
			"id": 1,
			"zoneId": 3,
			"groupingA": "0",
			"groupingB": "0",
			"groupingC": "0",
			"groupingD": "0"
		},
		{
			"id": 2,
			"groupingA": "2",
			"groupingB": "0",
			"groupingC": "0",
			"groupingD": "0"
		},
		{
			"id": 3,
			"zoneId": 4,
			"groupingA": "3",
			"groupingB": "4",
			"groupingC": "5",
			"groupingD": "0"
		},
		{
			"id": 4,
			"groupingA": "2",
			"groupingB": "1",
			"groupingC": "1",
			"groupingD": "1"
		},
		{
			"id": 5,
			"groupingA": "3",
			"groupingB": "2",
			"groupingC": "2",
			"groupingD": "2"
		},
		{
			"id": 8,
			"groupingA": "1",
			"groupingB": "1",
			"groupingC": "1",
			"groupingD": "1"
		}
	]
}