Locations

A Location is a space where materials are kept.

Attributes

  • id uuid

  • name string

    The name of the location.

  • quantity integer

    Amount of items at this location.

  • isCounted boolean

    Whether all materials in this location have an accurate count.

  • fillLevel integer

    A percentage of how full the location is (between 0 and 100)

  • isMarkedFull integer

    Whether the location has manually been marked as full within PowerPick.

  • shelfId uuid

    Id of the shelf this belongs to.

  • binId uuid

  • binDepth integer

  • binWidth integer

  • expectedQuantity float

  • currentQuantity float

  • depth integer

  • width integer

  • xCoordinate integer

  • yCoordinate integer

  • type integer

  • subType integer

  • orientationType integer

  • shelfId uuid

Endpoints

List Locations

get /api/locations

Arguments

  • name integer

    Only return items that have the given name.

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 1000, and the default is 250.

  • offset integer

    Will return items, but only those after the integer amount.

  • countOnly boolean

    When true, will only return a count of the amount of items in the query.

  • orderBy string

    Order the response by the selected field. Multiple values can be passed, separated by a comma.

  • currentQuantity

  • expectedQuantity

  • fillLevel

  • type

  • orientationType

  • xCoordinate

  • isCounted boolean

    Whether all contents of this location have an accurate count. True or False.

Request with curl
curl "http://[Your IP] /api/locations" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{"locations": [{ "id": " uuid ", "name": " string ", "quantity": " 61.0 ", "isCounted": " true ", "fillLevel": " 60 ", "isMarkedFull": " integer ", "shelfId": " uuid ", "binId": " uuid ", "binDepth": " integer ", "binWidth": " integer ", "expectedQuantity": " float ", "currentQuantity": " float ", "depth": " integer ", "width": " integer ", "xCoordinate": " integer ", "yCoordinate": " integer ", "type": " integer ", "subType": " integer ", "orientationType": " integer ", "shelfId": " uuid ", }]}]}

Show Location

get /api/locations/[id]

Get a single location from the PPG database and return a JSON response.

Request with curl
curl "http://[Your IP] /api/locations/[id]" \ -X get \-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{"location": { "id": uuid , "name": " string " , "quantity": 61.0 , "isCounted": true , "fillLevel": 60 , "isMarkedFull": integer , "shelfId": uuid , "binId": uuid , "binDepth": integer , "binWidth": integer , "expectedQuantity": float , "currentQuantity": float , "depth": integer , "width": integer , "xCoordinate": integer , "yCoordinate": integer , "type": integer , "subType": integer , "orientationType": integer , "shelfId": uuid , } }