1. Resource Central arrow-right
  2. Storage Units

Storage Units

Attributes

  • name string LIMIT: 50

    Name of the storage unit.

  • id uuid

    Unique identifier of the storage unit.

  • depthSteps integer

    The number of position lights/picklights that are arranged across the depth for this type of storage unit.

  • description string LIMIT: 80

    Description of the storage unit.

  • grossDepth integer

    The outer depth of the storage unit, used for static racks. The preset unit of measurement is millimeters.

  • grossWidth integer

    The outer width of the storage unit, used for static racks. The preset unit of measurement is millimeters.

  • isManualSequenceNumbers boolean

    If the sequence numbers of the storage unit shelves/carriers are manually set.

    Possible values:

    0 = False
    1 = True

  • maxWeight integer

    Permitted weight limit of the storage unit, if working with weight control. The preset unit of measurement is grams.

  • netDepth integer

    The usable depth of the storage unit. The preset unit of measurement is millimeters.

  • netWidth integer

    The usable width of the storage unit. The preset unit of measurement is millimeters.

  • type integer

    Storage unit type.

    Possible values:

    1 = Static Rack
    2 = Ground Storage
    3 = Vertical Carousel
    4 = Horizontal Carousel
    5 = Shuttle (VLM)
    6 = Single File (Material Flight)
    7 = Material Handling Unit
    8 = Production
    9 = Vertical Buffer

  • warehouseId uuid

    Unique identifier of the warehouse.

  • widthSteps integer

    The number of position lights/picklights that are arranged across the width for this type of storage unit.

Endpoints

List Storage Units /api/storage_units
get

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

Body Parameters

  • name string

    Name of the storage unit.

  • type integer

    Storage unit type.

    Possible values:

    1 = Static Rack
    2 = Ground Storage
    3 = Vertical Carousel
    4 = Horizontal Carousel
    5 = Shuttle (VLM)
    6 = Single File (Material Flight)
    7 = Material Handling Unit
    8 = Production
    9 = Vertical Buffer

  • warehouseId uuid

    Unique identifier of the warehouse.

  • 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/storage_units" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{
    "storage_units": [
        {
            "depthSteps": 34,
            "description": null,
            "grossDepth": null,
            "grossWidth": null,
            "id": "18E22E33-11CA-4712-AECF-7A29123C88A5",
            "isManualSequenceNumbers": 0,
            "maxWeight": null,
            "name": "VLM-02",
            "netDepth": 3400,
            "netWidth": 9600,
            "type": 5,
            "warehouseId": "8126B842-3EDF-4A2D-B11E-2679219FA5A6",
            "widthSteps": 96
        },
        {
            "depthSteps": 180,
            "description": null,
            "grossDepth": 1800,
            "grossWidth": 12000,
            "id": "4E650810-D8E2-444B-813D-BA0254A37A6C",
            "isManualSequenceNumbers": 0,
            "maxWeight": null,
            "name": "RACK-1",
            "netDepth": 1800,
            "netWidth": 12000,
            "type": 1,
            "warehouseId": "8126B842-3EDF-4A2D-B11E-2679219FA5A6",
            "widthSteps": 12
        }
    ]
}
Show Storage Unit /api/storage_unit/[id]
get

Get info from a specific storage unit from the PPG database and return a JSON response.

Body Parameters

  • name string

  • type integer

  • id uuid

  • depthSteps Integer

  • description String

  • grossDepth Integer

  • grossWidth Integer

  • isManualSequenceNumbers Integer

  • maxWeight Integer

  • netDepth Integer

  • netWidth Integer

  • widthSteps Integer

  • warehouseId uuid

Request with curl
curl "http://[subdomain.itempath.com or IP]/api/storage_unit/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "storage_unit": { "name": " string " , "id": uuid , "depthSteps": integer , "description": " string " , "grossDepth": integer , "grossWidth": integer , "isManualSequenceNumbers": boolean , "maxWeight": integer , "netDepth": integer , "netWidth": integer , "type": integer , "warehouseId": uuid , "widthSteps": integer , } }