- Resource Central
- Locations
Locations
A location is a space where materials are kept.
Attributes
-
name
string
The name of the location.
-
id
uuid
Unique identifier of the location.
-
binDepth
integer
Inner front-to-back dimension of the bin.
-
binId
uuid
ID of the bin of this location.
-
binWidth
integer
Inner left-to-right dimension of the bin.
-
currentQuantity
float
Current quantity of one type of material in the location.
-
depth
integer
Front-to-back dimension of the location. With Flexcon dividers, this is usually a multiple of 212.5 (2.125" slots), rounded down, e.g. 212 or 637.
-
expectedQuantity
float
The allocated quantity of Put transactions for a material to this location.
-
fillLevel
integer
A percentage of how full the location is (between 0 and 100).
-
isCounted
boolean
Whether all contents of this location have an accurate count.
-
isMarkedFull
integer
Whether the location has manually been marked as full within Power Pick.
Possible values:
0 = False
1 = True -
orientation
integer
Specification that the bin is to be stored on the shelf rotated.
Possible values:
1 = No rotation
2 = Rotated 90º
3 = Rotated 180º
4 = Rotated 270ºDefault value: 1 (No rotation)
-
quantity
integer
Amount of items at this location.
-
shelfId
uuid
ID of the shelf of this location.
-
type
integer
Type of location.
Possible values:
1 = Bin
2 = Container
3 = Divisible Bin
4 = Cell
5 = Free space -
typeDescription
string
Description of the type of location.
Possible values:
"Bin" = 1
"Container" = 2
"Divisible Bin" = 3
"Cell" = 4
"Free space" = 5 -
width
integer
Left-to-right dimension of the location. With Flexcon dividers, this is usually a multiple of 200 (2" slots).
-
xCoordinate
integer
Width coordinate. Usually a multiple of 200 (2" slots).
-
yCoordinate
integer
Depth coordinate. Usually multiple of 212.5 (2.125" slots), rounded down, e.g. 850 or 1700.
-
zoneId
uuid
ID of the zone of this location.
Endpoints
Get a list of locations from the Power Pick database. View the guide on adding filters to List API calls.
Body Parameters
-
binDepth
integer
Inner front-to-back dimension of the bin.
-
binId
uuid
ID of the bin of this location.
-
binWidth
integer
Inner left-to-right dimension of the bin.
-
currentQuantity
integer
Current quantity of one type of material in the location.
-
depth
integer
Front-to-back dimension of the location. With Flexcon dividers, this is usually a multiple of 212.5 (2.125" slots), rounded down, e.g. 212 or 637.
-
expectedQuantity
integer
The allocated quantity of Put transactions for a material to this location.
-
fillLevel
integer
A percentage of how full the location is (between 0 and 100).
-
isCounted
boolean
Whether all contents of this location have an accurate count.
-
isMarkedFull
integer
Whether the location has manually been marked as full within Power Pick.
Possible values:
0 = False
1 = True -
name
string
Only return items that have the given name.
-
orientation
integer
Specification that the bin is to be stored on the shelf rotated.
Possible values:
1 = No rotation
2 = Rotated 90º
3 = Rotated 180º
4 = Rotated 270º -
shelfId
ID of the shelf of this location.
-
type
integer
Type of location.
Possible values:
1 = Bin
2 = Container
3 = Divisible Bin
4 = Cell
5 = Free space -
typeDescription
string
Description of the type of location.
Possible values:
"Bin" = 1
"Container" = 2
"Divisible Bin" = 3
"Cell" = 4
"Free space" = 5 -
width
Left-to-right dimension of the location. With Flexcon dividers, this is usually a multiple of 200 (2" slots).
-
xCoordinate
integer
Width coordinate. Usually a multiple of 200 (2" slots).
-
yCoordinate
integer
Depth coordinate. Usually multiple of 212.5 (2.125" slots), rounded down, e.g. 850 or 1700.
-
zoneId
ID of the zone of this location.
-
countOnly
boolean
When "true", will only return a count of the amount of items in the query.
Default value:
false -
limit
integer
A limit on the number of objects to be returned.
Default value:
1000 -
page
integer
Page numbering is zero-based and uses the value of the "limit" argument. (For example, if limit=20, then page=0 will display the hits from 1 to 20.)
-
orderBy
string, array
Order the response by the selected field. Multiple values can be passed, separated by a comma.
{
"locations": [
{
"binDepth": 1200,
"binId": "098758D1-BDBA-434E-A345-72943D4C6FAC",
"binWidth": 1200,
"currentQuantity": null,
"depth": null,
"expectedQuantity": null,
"fillLevel": 0,
"id": "8482D674-FEF7-464C-A62B-5D0618580D17",
"isCounted": true,
"isMarkedFull": 0,
"name": "VLM-02-007/01-04/02",
"orientation": 1,
"shelfId": "3DCAB44E-496F-4302-AFAE-E70773F1B20F",
"type": 1,
"typeDescription": "Bin",
"width": null,
"xCoordinate": 3600,
"yCoordinate": 1700,
"zoneId": null
},
{
"binDepth": 1200,
"binId": "098758D1-BDBA-434E-A345-72943D4C6FAC",
"binWidth": 1200,
"currentQuantity": 40.0,
"depth": null,
"expectedQuantity": 0.0,
"fillLevel": 100,
"id": "250A6889-2550-4B19-8D5C-AFE06DC54CF7",
"isCounted": false,
"isMarkedFull": 1,
"name": "VLM-02-007/01-04/01",
"orientation": 1,
"shelfId": "3DCAB44E-496F-4302-AFAE-E70773F1B20F",
"type": 1,
"typeDescription": "Bin",
"width": null,
"xCoordinate": 3600,
"yCoordinate": 0,
"zoneId": null
}
]
}
Get a single location from the PPG database and return a JSON response.