Location Content Breakdowns

Details about the materials stored within a location.

Attributes

id uuid
ID of the location breakdown.
blockReason string
Reason for blocking the material in this location from warehouse operations.
creationDate datetime
Date and time the material was created.
currentQuantity float
Current quantity of one type of material in the location.
dedicatedQuantity float
The quantity of Pick allocations, either from Manual Picks or allocated Pick Orders, that has not yet been processed.
expiryDate datetime
Used by a material property to track material expiry.
isBlocked boolean
Sets or resets if the material is blocked from warehousing operations, i.e. picking and putting.

Possible values:

0 = False
1 = True
lot integer
Lot number used by a material property for tracking materials.
productionDate datetime
Used by a material property to track material production date.
putDate datetime
Storage dates for parts, used for tracking "first in, first out."
qualification string
Used by a material property for tracking materials.
releaseDate datetime
Used by a material property to track material release date.
serialNumber integer
Unique serial number, recorded at the item level when a material is add or retrieved.

Endpoints

List Location Content Breakdowns

get /location_content_breakdowns

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

Arguments

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.

Default value: false

Request with curl

-d 'curl -L 'http://[subdomain.itempath.com or IP]/api/location_content_breakdowns?limit=2' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [JWT Access Token]''

Example Response

{
    "content_breakdowns": [
        {
            "blockReason": null,
            "creationDate": "2021-12-03T01:15:47.010000",
            "currentQuantity": 1.0,
            "dedicatedQuantity": 0.0,
            "expiryDate": "2021-12-02T20:15:44",
            "id": "445307F3-C989-4B56-A87D-0072BD7AC2C9",
            "isBlocked": 0,
            "lot": null,
            "productionDate": null,
            "putDate": "2021-12-02T20:15:44",
            "qualification": null,
            "releaseDate": null,
            "serialNumber": "1234"
        },
        {
            "blockReason": null,
            "creationDate": "2022-02-23T21:30:30.617000",
            "currentQuantity": 1.0,
            "dedicatedQuantity": 0.0,
            "expiryDate": null,
            "id": "FE6F54F4-AC36-4757-9C39-043AAF885F9D",
            "isBlocked": 0,
            "lot": null,
            "productionDate": null,
            "putDate": "2022-02-23T16:30:28",
            "qualification": null,
            "releaseDate": null,
            "serialNumber": "905"
        }
    ]
}

Show Location Content Breakdown

get /location_content_breakdowns/[ID]

Get a location content breakdown by ID from the PPG database and return a JSON response.

Arguments

Request with curl

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

Example Response

{
    "content_breakdown": {
        "blockReason": null,
        "creationDate": "2022-03-25T21:18:48.540000",
        "currentQuantity": 1.0,
        "dedicatedQuantity": 0.0,
        "expiryDate": null,
        "id": "2EDB0356-D367-40DD-9FF9-D26AE963155B",
        "isBlocked": 0,
        "lot": null,
        "productionDate": null,
        "putDate": "2022-03-25T17:18:46",
        "qualification": null,
        "releaseDate": null,
        "serialNumber": "101"
    }
}