Resource:
inventory expiring
C# Rel Const:
Rels.InventorySvc.InventoryExpiring
URI template:
expiring{?threshold,includeHeld,custID}
get inventory within expiration threshold
Success status: 200
| Name
(* = required)
|
Data Type | Description |
| threshold
*
|
Inventory.Models.InventoryExpiryThresholdSource |
expiration threshold can be configured by customer or at the item level |
| - ByItem | |
| - ByCust | |
| includeHeld
|
bool |
false: ignore receive items already held; true: include even if already held |
| custID
|
int |
optional customerid to filter the list of expiring items by |
|
Type |
Description |
| ReceiveItemIdentifiers |
IEnumerable<Generic.Models.ReceiveItemIdentifier>
|
identifies receive items to be affected
|
| Id |
int
|
|
| Threshold |
Inventory.Models.InventoryExpiryThresholdSource
|
source for where threshold configuration came from to produce the list
|
|
Inventory.Models.InventoryExpiryThresholdSource |
source for # of days before inventory expires to send alert |
|
- 0: ByItem |
get # of days from the item definition |
|
- 1: ByCust |
get # of days from the customer record |
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/inventory/inventoryhold
|
to place inventory on hold |
Sample accept: application/hal+json
{
"receiveItemIdentifiers": [
{
"id": 1
}
],
"threshold": 0
}
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@3plcentral.com with any questions about this documentation.
REL documentation