- 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
Bins
Attributes
-
id
uuid
Unique identifier for the object.
-
name
string
The name of the bin.
- type integer
- width integer
- depth integer
- height integer
- color integer
Endpoints
List Bins
get /api/binsGet the bins from the PPG database and return a JSON response.
Arguments
-
name
string
The name of the bin.
-
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.
-
countOnly
boolean
When "true", will only return a count of the amount of items in the query.
Default value: false
Request with curl
curl "http://[Your IP]
/api/bins" \
-X
get
\
-H "Content-Type: application/json" \
-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{
"bins": [{
"id": "
1CFA1626-B75F-408B-9F41-0006A8EBE9E3
",
"name": "
S-09X03
",
"type": "
1
",
"width": "
integer
",
"depth": "
integer
",
"height": "
integer
",
"color": "
16777215
",
}]
}]
}
Show Bin
get /api/bins/[id]Get a single bin from the PPG database and return a JSON response.
Arguments
- cellName string
- colour
- depth integer
- height integer
- id UUID
- insideDepth integer
- insideWidth integer
- name string
- type integer
- width integer
- xSlots
- ySlots
Request with curl
curl "http://[Your IP]
/api/bins/[id]" \
-X
get
\
-H "Content-Type: application/json" \
-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{
"bin": {
"id":
1CFA1626-B75F-408B-9F41-0006A8EBE9E3
,
"name":
"
S-09X03
"
,
"type":
1
,
"width":
integer
,
"depth":
integer
,
"height":
integer
,
"color":
16777215
,
}
}