- API Reference
- Access Points
- API Calls
- Batches
- Bins
- Carriers
- Clients
- Cost Centers
- Images (Supplements)
- Kits
- Kit Lines
- Locations
- Location Contents
- Materials
- Material Codes
- Material Properties
- Orders
- Order Lines
- Reports
- Report Rows
- Settings
- Shelves
- Snapshots
- Stations
- Storage Rules
- Storage Units
- Transactions
- Users
- Warehouses
- Work Order Lines
- Zones
Locations
A Location is a space where materials are kept.
Attributes
-
name
string
The name of the location.
- id uuid
-
binId
uuid
ID of the bin of this location.
-
binDepth
integer
Inner front-to-back dimension of the bin.
-
binWidth
integer
Inner left-to-right dimension of the bin.
-
currentQuantity
float
Current quantity of one type of material in the location.
-
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 PowerPick.
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 -
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.
- depth integer
- width integer
Endpoints
List Locations
get /api/locationsArguments
-
name
string
Only return items that have the given name.
-
binDepth
integer
Inner front-to-back dimension of the bin.
-
binWidth
integer
Inner left-to-right dimension of the bin.
-
currentQuantity
integer
Current quantity of one type of material in the location.
-
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 PowerPick.
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º -
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 -
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.
-
limit
integer
A limit on the number of objects to be returned. Limit can range between 1 and 1000.
Default value: 250
-
page
integer
Page-numbering is based on the value of the "limit" argument. If limit=20, then page=0 will display the hits from 1 to 20. (Page numbers are zero-based.) Using page without a limit returns all items.
-
orderBy
string
Order the response by the selected field. Multiple values can be passed, separated by a comma.
-
countOnly
boolean
When "true", will only return a count of the amount of items in the query.
Default value: false
Show Location
get /api/locations/[id]Get a single location from the PPG database and return a JSON response.