REL documentation
Resource:inventory for management purposesC# Rel Const:Rels.InventorySvc.InventoryURI template:{?pgsiz,pgnum,rql,sort,senameorvaluecontains}Obtain URI from:
To get inventory for management purposes
Success status: 200
| Name | Data Type | Description |
|---|---|---|
| pgsiz | int | must be positive; limit 1000, specifying more is an error; default 100; max records to return per response; use "next" or "prev" link to paginate |
| pgnum | int | considering pgsiz, returns the pgnum-th page, 1-indexed |
| rql | string | see RQL documentation |
| sort | string | see RQL documentation |
| senameorvaluecontains | string |
| Type | Description | |
|---|---|---|
| TotalResults | int | |
| ResourceList | IList<Inventory.Models.InventoryItem> | |
| ReceiverId | int | |
| ReceivedDate | DateTime | |
| ReceiveItemId | int | |
| CustomerIdentifier | Generic.Models.CustomerIdentifier | |
| ExternalId | string | |
| Name | string | |
| Id | int | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| ItemIdentifier | Generic.Models.ItemIdentifier | |
| Sku | string | |
| Id | int | |
| ItemDescription | string | |
| Description2 | string | item's Description2 property |
| Upc | string | |
| Qualifier | string | |
| InventoryUnitOfMeasureIdentifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| SecondaryUnitOfMeasureIdentifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| InventoryUnitsPerSecondaryUnit | decimal? ... | |
| ReceivedQty | decimal | |
| OnHandQty | decimal | |
| AvailableQty | decimal | |
| OnHoldQty | decimal | |
| SecondaryReceivedQty | decimal? ... | |
| SecondaryOnHandQty | decimal? ... | |
| SecondaryAvailableQty | decimal? ... | |
| SecondaryOnHoldQty | decimal? ... | |
| WeightImperial | decimal? ... | |
| WeightImperialOnHand | decimal? ... | |
| WeightImperialAvailable | decimal? ... | |
| WeightMetric | decimal? ... | |
| WeightMetricOnHand | decimal? ... | |
| WeightMetricAvailable | decimal? ... | |
| SavedElements | IEnumerable<Generic.Models.SavedElement> | |
| Name | string | |
| Value | string | |
| PackagingUnitOfMeasureIdentifier | Generic.Models.UnitOfMeasureIdentifier | |
| Name | string | |
| Id | int | |
| PrimaryUnitsPerPackagingUnit | int | |
| AvailablePackaging | Int64 | |
| OnHandPackaging | Int64 | |
| InventoryAgeDays | int | |
| LotNumber | string | |
| SerialNumber | string | |
| ExpirationDate | DateTime? ... | |
| Cost | decimal? ... | |
| SupplierIdentifier | Generic.Models.ContactIdentifier | |
| Name | string | |
| Id | int | |
| LocationIdentifier | Generic.Models.LocationIdentifier | |
| NameKey | Generic.Models.LocationNameKey | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| Name | string | |
| Id | int | |
| PalletIdentifier | Generic.Models.PalletIdentifier | |
| NameKey | Generic.Models.PalletNameKey | |
| FacilityIdentifier | Generic.Models.FacilityIdentifier | |
| Name | string | |
| Id | int | |
| Name | string | |
| Id | int | |
| PalletTypeIdentifier | Generic.Models.PalletTypeIdentifier | |
| Name | string | |
| Id | int | |
| Imperial | Generic.Models.Dimension | optional when creating; if only Imperial specified, Metric is calculated |
| Length | decimal? ... | |
| Width | decimal? ... | |
| Height | decimal? ... | |
| Weight | decimal? ... | |
| OnHold | bool | |
| OnHoldReason | string | |
| OnHoldDate | DateTime? ... | |
| OnHoldUserIdentifier | Generic.Models.UserIdentifier | |
| Name | string | |
| Id | int | |
| Quarantined | bool | |
| StockRowVersion | string | |
| ReferenceNum | string | |
| PONum | string | |
| TrailerNumber | string | |
| Links | IList<WebApi.Hal.Link> | |
| - /rels/inventory/receiveitemfilesummaries | ||
| Links | IList<WebApi.Hal.Link> | |
| - next | ||
| - prev |
{
"totalResults": 1,
"_embedded": {
"item": [
{
"receiverId": 1,
"receivedDate": "2016-12-25T23:00:00",
"receiveItemId": 3,
"customerIdentifier": {
"externalId": "str",
"name": "str",
"id": 3
},
"facilityIdentifier": {
"name": "str",
"id": 2
},
"itemIdentifier": {
"sku": "str",
"id": 2
},
"itemDescription": "str",
"description2": "str",
"upc": "str",
"qualifier": "str",
"inventoryUnitOfMeasureIdentifier": {
"name": "str",
"id": 2
},
"secondaryUnitOfMeasureIdentifier": {
"name": "str",
"id": 2
},
"inventoryUnitsPerSecondaryUnit": 1.0,
"receivedQty": 8.0,
"onHandQty": 9.0,
"availableQty": 10.0,
"onHoldQty": 11.0,
"secondaryReceivedQty": 1.0,
"secondaryOnHandQty": 1.0,
"secondaryAvailableQty": 1.0,
"secondaryOnHoldQty": 1.0,
"weightImperial": 1.0,
"weightImperialOnHand": 1.0,
"weightImperialAvailable": 1.0,
"weightMetric": 1.0,
"weightMetricOnHand": 1.0,
"weightMetricAvailable": 1.0,
"savedElements": [
{
"name": "str",
"value": "str"
}
],
"packagingUnitOfMeasureIdentifier": {
"name": "str",
"id": 2
},
"primaryUnitsPerPackagingUnit": 12,
"availablePackaging": 13,
"onHandPackaging": 14,
"inventoryAgeDays": 15,
"lotNumber": "str",
"serialNumber": "str",
"expirationDate": "2016-12-25T23:00:00",
"cost": 1.0,
"supplierIdentifier": {
"name": "str",
"id": 2
},
"locationIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"palletIdentifier": {
"nameKey": {
"facilityIdentifier": {
"name": "str",
"id": 2
},
"name": "str"
},
"id": 1
},
"palletTypeIdentifier": {
"name": "str",
"id": 2
},
"imperial": {
"length": 1.0,
"width": 1.0,
"height": 1.0,
"weight": 1.0
},
"onHold": true,
"onHoldReason": "str",
"onHoldDate": "2016-12-25T23:00:00",
"onHoldUserIdentifier": {
"name": "str",
"id": 2
},
"quarantined": true,
"rowVersion": "str",
"stockRowVersion": "str",
"referenceNum": "str",
"poNum": "str",
"trailerNumber": "str"
}
]
}
}
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@extensiv.com with any questions about this documentation.