Storage Rules

Storage rules for materials and locations in Power Pick.

Attributes

name string LIMIT: 50
Name of the storage rule.
id uuid
Unique identifier of the storage rule.
description string LIMIT: 80
Description of the storage rule.
isDefaultBin boolean
Sets or resets the default (or favourite) bin the material should be stored in, unless overridden.

Possible values:

0 = False
1 = True
maxNumberLocations integer
The maximum number of locations that can have this storage rule.
minNumberLocations integer
The minimum number of locations that can have this storage rule.
minStockPerBin float
Minimum stock permitted per bin amount. Used to compare with other storage rules minimums and maximums to determine which bin to put the material into.
packSize integer
Deprecated. The number of units in a pack.
packSizeUsageType integer
Deprecated. Used especially for pick requests.

Possible values:

0 = NotSet
1 = AcceptAsRequested
2 = RoundDownAndShorten
3 = RoundUpOverstock
4 = RoundUpReturnDifference
requiredCapacity integer
The required capacity (0 to 100) for bins used to store a material.

Endpoints

List Storage Rules /api/storage_rules

get

Get a list of storage rules 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.

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.
materialId string, array
Filter the response by the provided material ID.
binId string, array
Filter the response by the provided bin ID.

Request with curl

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

Example Response

						{
    "storage_rules": [
        {
            "description": null,
            "id": "89680347-B470-44AC-B5D4-0D46BC7DAA60",
            "isDefaultBin": 0,
            "maxNumberLocations": null,
            "minNumberLocations": null,
            "minStockPerBin": 10.0,
            "packSize": null,
            "packSizeUsageType": 1,
            "requiredCapacity": 100
        },
        {
            "description": null,
            "id": "FA4330C6-F644-4978-9724-2394CDC9EABC",
            "isDefaultBin": 0,
            "maxNumberLocations": null,
            "minNumberLocations": null,
            "minStockPerBin": null,
            "packSize": null,
            "packSizeUsageType": 1,
            "requiredCapacity": 100
        }
    ]
}

Show Storage Rule /api/storage_rule/[id]

get

Request with curl

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

Example Response

						{
    "storage_rule": {
        "description": null,
        "id": "13623EBB-F11F-4D60-A7B8-298024F8EB77",
        "isDefaultBin": 0,
        "maxNumberLocations": null,
        "minNumberLocations": null,
        "minStockPerBin": 11.0,
        "packSize": null,
        "packSizeUsageType": 1,
        "requiredCapacity": 100
    }
}

Create Storage Rules /api/storage_rules

post

Create a storage rule in Power Pick database.

Body Parameters

alwaysUseNewLocation boolean
If true, sets the storage rule will default to using a new location for puts.

Possible values:

0 = False
1 = True
binId string
REQUIRED

The unique ID of the bin. Storage rules are uniquely identified by materialId and binId.
description string LIMIT: 80
Description of the storage rule.
isDefaultBin boolean
Sets or resets the default (or favourite) bin the material should be stored in, unless overridden.

Possible values:

0 = False
1 = True
materialId string
REQUIRED

The unique ID of the item(s).
maxNumberLocations integer
The maximum number of locations that can have this storage rule.
maxStockPerBin float
REQUIRED

Maximum stock permitted per bin amount. Used to compare with other storage rules minimums and maximums to determine which bin to put the material into.
maxStockPerLocation float
The maximum stock permitted per location. Used with other storage rules minimums and maximums to determine which location to put the material into.
minNumberLocations integer
The minimum number of locations that can have this storage rule.
minStockPerBin float
REQUIRED

Minimum stock permitted per bin amount. Used to compare with other storage rules minimums and maximums to determine which bin to put the material into.
minStockPerLocation float
The minimum stock per location. Used with other storage rules minimums and maximums to determine which location to put the material into.
packSize integer
Deprecated. The number of units in a pack.
packSizeUsageType float
Deprecated. Used especially for pick requests.

Possible values:

0 = NotSet
1 = AcceptAsRequested
2 = RoundDownAndShorten
3 = RoundUpOverstock
4 = RoundUpReturnDifference
requiredCapacity integer
REQUIRED

The required capacity (0 to 100) for bins used to store a material.

Request with curl

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

						-d '{
    "materialId": "8395D795-EA64-49EA-BFEE-708F4E5B2700",
    "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
    "description":"",
    "isDefaultBin": true,
    "minStockPerBin": 20,
    "maxStockPerBin": 50,
    "requiredCapacity": 30,
    "packSize": 5,
    "packSizeUsageType": "2",
    "minNumberLocations": 1,
    "maxNumberLocations": 10,
    "minStockPerLocation": 20,
    "alwaysUseNewLocation": true
}'

Example Response

						{
    "storage_rule": {
        "alwaysUseNewLocation": 1,
        "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
        "description": "",
        "id": "12F7328B-26A4-4EB0-A9F3-35102A945B01",
        "isDefaultBin": 1,
        "materialId": "8395D795-EA64-49EA-BFEE-708F4E5B2700",
        "maxNumberLocations": 10,
        "maxStockPerBin": 50.0,
        "minNumberLocations": 1,
        "minStockPerBin": 20.0,
        "minStockPerLocation": 20.0,
        "packSize": 5,
        "packSizeUsageType": 2,
        "requiredCapacity": 30
    }
}