Shelves

Shelves are the individual storage areas within PPG.

Attributes

  • id string

    Unique identifier for the object.

Endpoints

List Shelves

get /api/shelves

Arguments

  • 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

  • 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/shelves" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "shelves": [{ "id": " string ", }] }] }

Show Shelf

get /api/shelf/[id]

Arguments

  • 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://[Your IP] /api/shelf/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "shelf": { "id": " string " , } }