Bins

Details about bins within Power Pick storage units.

Attributes

  • name string LIMIT: 50

    The name of the bin.

  • id uuid

    Unique identifier for the object.

  • color integer

    Color assigned to the bin, in decimal format, e.g. 16777215 for white. Used in the graphical view in location management.

  • depth integer

    Front-to-back dimension of the bin. With Flexcon dividers, this is usually a multiple of 212.5 (2.125″ slots), rounded down, e.g. 212 or 637).

  • cellName string LIMIT: 50

    Name of the cell in which the bin is located, e.g. A1.

  • height integer

    Optional bin height. Not divider height but height of the highest material in this bin type. Used mainly for Material Storage Rules to group low or high materials together.

  • insideDepth integer

    Inner front-to-back dimension of the bin.

  • insideWidth integer

    Inner left-to-right dimension of the bin.

  • type integer

    Type of bin.

    Possible values:

    1 = Bin
    2 = Container
    3 = Divisible Bin
    4 = Cell
    5 = Free space

    Default value: 1

  • width integer

    Left-to-right dimension of the bin. With Flexcon dividers, this is usually a multiple of 200 (2″ slots).

  • xSlots integer

    Number of 2" slots in the bin's Flexcon divider on the x-axis.

  • ySlots integer

    Number of 2.125" slots in the bin's Flexcon divider on the y-axis.

Endpoints

List Bins /api/bins
get

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

Body Parameters

  • name string

    Name of the bin.

  • type

    Type of bin.

    Possible values:

    1 = Bin
    2 = Container
    3 = Divisible Bin
    4 = Cell
    5 = Free space

  • 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.

    Default value:

    1000

  • page integer

    Page numbering is zero-based and uses the value of the "limit" argument. (For example, if limit=20, then page=0 will display the hits from 1 to 20.)

  • 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/bins" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]" -d '{ }'
Example Response
{
    "bins": [
        {
            "cellName": null,
            "color": null,
            "depth": 1700,
            "height": 400,
            "id": "098758D1-BDBA-434E-A345-72943D4C6FAC",
            "insideDepth": null,
            "insideWidth": null,
            "name": "BIN-12x16x04",
            "type": 1,
            "width": 1200,
            "xSlots": null,
            "ySlots": null
        },
        {
            "cellName": null,
            "color": 16777215,
            "depth": 850,
            "height": 400,
            "id": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
            "insideDepth": null,
            "insideWidth": null,
            "name": "BIN-08x08x04",
            "type": 1,
            "width": 800,
            "xSlots": null,
            "ySlots": null
        }
    ]
}
Show Bin /api/bins/[id]
get

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

Body Parameters

  • 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://[subdomain.itempath.com or IP]/api/bins/[id]" \ -X get \ -H "Content-Type: application/json" \ -H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{ "bin": { "name": " S-09X03 " , "id": 1CFA1626-B75F-408B-9F41-0006A8EBE9E3 , "color": 16777215 , "depth": 212 , "cellName": " A1 " , "height": integer , "insideDepth": integer , "insideWidth": integer , "type": 1 , "width": 1600 , "xSlots": integer , "ySlots": integer , } }