Shelves

Shelves are individual storage areas within PowerPick.

Attributes

name string LIMIT: 50
Name or number of the shelf.
id uuid
Unique identifier of the shelf.
carrierId uuid
Unique identifier of the carrier.
depth integer
Shelf depth. The preset unit of measurement is millimeters.
depthSteps integer
Shelf depth position is used when applying optical position indicators.
maxHeight integer
Maximum permitted height of the shelf. The preset unit of measurement is millimeters.
maxWeight integer
Permitted weight limit of the shelf, if working with weight control. The preset unit of measurement is grams.
minHeight integer
Minimum permitted height of the shelf. The preset unit of measurement is millimeters.
number integer
Name or number of the shelf.
sequenceNumber integer
Assigned by the order in which the shelf was added to the database.
width integer
Shelf width. The preset unit of measurement is millimeters.
widthSteps integer
Shelf width position is used when applying optical position indicators.
xCoordinate integer
The x-coordinate of the shelf. Will be 0 unless there is more than one shelf side-by-side on the carrier.
yCoordinate integer
The y-coordinate of the shelf. Will be 0 unless there is more than one shelf side-by-side on the carrier.
zCoordinate integer
The z-coordinate of the shelf. Will be 0 unless there is more than one shelf stacked on the carrier.
zoneId uuid
Unique identifier of the zone.

Endpoints

List Shelves /api/shelves

get

Get a list of shelves from the PPG database. View the guide on adding filters to List API calls.

Body Parameters

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. 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, array
Order the response by the selected field. Multiple values can be passed, separated by a comma.

Request with curl

curl "http://[subdomain.itempath.com or IP]/api/shelves" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'

Example Response

{
    "shelves": [
        {
            "carrierId": "E86CD628-B369-4A7F-A9A2-7312F66EE12B",
            "depth": 1800,
            "depthSteps": null,
            "id": "1572279F-02C5-46DC-BDA2-117770206BCB",
            "maxHeight": null,
            "maxWeight": null,
            "minHeight": null,
            "name": "02",
            "number": 2,
            "sequenceNumber": 31,
            "width": 12000,
            "widthSteps": null,
            "xCoordinate": 0,
            "yCoordinate": 0,
            "zCoordinate": 100,
            "zoneId": null
        },
        {
            "carrierId": "86BC8F3D-323A-4952-B785-6A34C004A74A",
            "depth": 1800,
            "depthSteps": null,
            "id": "42F546CB-9BE6-4BA3-A902-13062A7383E8",
            "maxHeight": null,
            "maxWeight": null,
            "minHeight": null,
            "name": "01",
            "number": 1,
            "sequenceNumber": 28,
            "width": 12000,
            "widthSteps": null,
            "xCoordinate": 0,
            "yCoordinate": 0,
            "zCoordinate": 0,
            "zoneId": null
        }
    ]
}

Show Shelf /api/shelf/[id]

get

Body Parameters

carrierId uuid
depth Integer
depthSteps Integer
id Uuid
maxHeight Integer
maxWeight Integer
minHeight Integer
name String
number Integer
sequenceNumber Integer
width Integer
widthSteps Integer
xCoordinate Integer
yCoordinate Integer
zCoordinate Integer
zoneId uuid

Request with curl

curl "http://[subdomain.itempath.com or IP]/api/shelf/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"

Example Response

{ "shelf": { "name": " string " , "id": uuid , "carrierId": uuid , "depth": integer , "depthSteps": integer , "maxHeight": integer , "maxWeight": integer , "minHeight": integer , "number": integer , "sequenceNumber": integer , "width": integer , "widthSteps": integer , "xCoordinate": integer , "yCoordinate": integer , "zCoordinate": integer , "zoneId": uuid , } }