Location POST
URI
https://{DATACENTER}.brightpearlconnect.com/public-api/{ACCOUNT}/warehouse-service/warehouse/{ID}/location/ Refer to our documentation on URI syntax for more information on how to construct URIs.
Description
This method enables you to create new warehouse locations.
The following parameters are accepted for this method:
-
URI Parameters:
- warehouse ID - The ID of the warehouse you wish to create a new Location within.
-
Body Parameters:
- zoneId - The warehouse zone this location should be assigned to (OPTIONAL)
- barcode - The barcode this location should be assigned to (OPTIONAL)
- groupingA - The Aisle Number/Name
- groupingB - The Bay Number/Name (OPTIONAL)
- groupingC - The Shelf Number/Name (OPTIONAL)
- groupingD - The Bin Number/Name (OPTIONAL)
The return from the method is the ID of the newly created Location if successful.
NOTE
Barcode can be numerical only and can not exceed the maximum length of 32 characters. Must be unique if supplied.
The groupings used to identify locations are hierarchical so:
- you cannot specify a Bin without specifying a shelf first.
- you cannot specify a Shelf without specifying a Bay.
- you cannot specify a Bay without specifying a Aisle.
Example 1
Simplest use of the create Location method.
This will create a new location with Aisle name 'alise1'.
Request URI
/warehouse/1/location/ Request body
{
"groupingA": "alise1"
}Response
{
"response": {
"id": 13
}
}Example 2
More complex use of the create Location method.
This will create a new location with aisle number 1, bay number 23, shelf number 32 and bin number 1.
Request URI
/warehouse/1/location/ Request body
{
"groupingA": "1",
"groupingB": "23",
"groupingC": "32",
"groupingD": "1"
}Response
{
"response": {
"id": 4
}
}Example 3
If zone 5 exists in warehouse 2, this will create a location assigned to that zone.
Request URI
/warehouse/2/location/ Request body
{
"zoneId": 5,
"groupingA": "1",
"groupingB": "23",
"groupingC": "32",
"groupingD": "1",
"barcode": "90561003"
}Response
{
"response": {
"id": 12
}
}