Location Contents

Details about a location (bin) and the materials stored there.

Attributes

id uuid
ID of the location contents record.
binId uuid
ID of the bin where the material is stored.
countingCycle integer
Number of days between counting.
countDate datetime
When this location area was last counted.
creationDate datetime
When this location area was created.
currentQuantity float
Current quantity of one type of material in the location.
isCounted boolean
Whether all materials in this location content have an accurate count.
locationId uuid
ID of the location this belongs to.
locationName string
Name of the location where the material is stored.
materialId uuid
ID of the material in this location area.
nextCountDate datetime
When this location area will be counted next.
storageUnitId uuid
ID of the storage unit of this location.
storageUnitName string
Name of the storage unit of this location.
type integer
Number representing the type of location.

Possible values:

1 = Permanent
2 = Temporary
typeDescription string
Explanation of the location type number.

Possible values:

Permanent (1)
Temporary (2)
warehouseName string
Name of the warehouse of this location.

Possible values:

1 = Permanent
2 = Temporary

Endpoints

List Location Contents /api/location_contents

get

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

Body Parameters

binId uuid
ID of the bin where the material is stored.
carrierId uuid
ID of the carrier where this location is found.
countDate dateTime
Date and time the material was counted.
creationDate dateTime
Date and time the material was created.
currentQuantity float
Current quantity of one type of material in the location.
id uuid
ID of the location contents record.
isCounted boolean
Whether all materials in this location content have an accurate count.
locationId uuid
ID of the location where the material is stored.
locationName string
Name of the location.
materialId uuid
ID of the material stored in this location.
shelfId uuid
ID of the shelf where this location is found.
storageUnitId uuid
ID of the storage unit of this location.
storageUnitName string
Name of the storage unit of this location.
type integer
Type of location.

Possible values:

1 = Permanent
2 = Temporary
warehouseName string
Name of the warehouse of this location.
warehouseId uuid
ID of the warehouse of this location.
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.

Default value:
false

Request with curl

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

Example Response

						{
    "contents": [
        {
            "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
            "countDate": null,
            "countingCycle": null,
            "creationDate": "2021-11-22T19:22:39.303000",
            "currentQuantity": 1,
            "id": "77EF2454-17C5-4F69-B6C2-00A4FE9F0519",
            "isCounted": 0,
            "locationId": "FD8EEE72-5F90-4B9A-B0F0-C41BCE2F39E1",
            "locationName": "VLM-01-001/01-11/01",
            "materialId": "8E7EC42A-F2B2-4B64-BF71-750F006DEF8D",
            "nextCountDate": null,
            "type": 2,
            "typeDescription": "Temporary",
            "warehouseName": "Warehouse"
        },
        {
            "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
            "countDate": "2022-01-24T10:35:28",
            "countingCycle": null,
            "creationDate": "2020-07-04T16:18:49.887000",
            "currentQuantity": 99,
            "id": "6F2ADABF-9EC7-4EA2-8BB3-04308F1C6A90",
            "isCounted": 0,
            "locationId": "5ABE61D6-F0DF-48F6-8CE8-093C726C2404",
            "locationName": "VLM-02-001/01-02/03",
            "materialId": "D7952417-E513-45EB-95F6-D979790E4E5E",
            "nextCountDate": null,
            "type": 2,
            "typeDescription": "Temporary",
            "warehouseName": "Warehouse"
        }
    ]
}

Show Location Content /api/location_contents/[id]

get

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

Body Parameters

Request with curl

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

Example Response

						{
    "content": {
        "binId": "A1641D84-EDB6-4D13-80BB-AE05C74042D9",
        "countDate": null,
        "countingCycle": null,
        "creationDate": "2022-01-10T19:44:16.800000",
        "currentQuantity": 1,
        "id": "E8C2F396-4C91-4EF3-AE5B-050087E481EA",
        "isCounted": 0,
        "locationId": "ED2AECC5-0EFE-42D7-B838-B1F251A7EC1F",
        "locationName": "VLM-01-002/01-08/04",
        "materialId": "8E7EC42A-F2B2-4B64-BF71-750F006DEF8D",
        "nextCountDate": null,
        "type": 2,
        "typeDescription": "Temporary",
        "warehouseName": "Warehouse"
    }
}