- 5 Minutes to read
- PDF
Inventory Request Object
- 5 Minutes to read
- PDF
Inventory Request Object
Tasks
Description: Displays the task objects associated with the inventory request. Must use parameter includeTasks=true in the GET Inventory Requests call.
Data Type: Array
Required: No
RequestGroup
Description: Identifier for inventory requests that can be fulfilled at the same time. For example, if 2 items are requested from the same warehouse or vendor, they will have the same RequestGroup identifier.
Data Type: String
Required: No
InventoryRequestID
Description: Unique identifier for the inventory request.
Data Type: Int
Required: No unless making changes to an existing request.
SourceProcess
Description: Either Replenishment, Procurement, or Request Inventory.
Data Type: String
Required: No
Priority
Description: Defaults to 10. Can be updated with the inventory request import.
Data Type: Int
Required: No
SourceWarehouseName
Description: The warehouse that inventory will be coming from during replenishments/transfers.
Data Type: String
Required: No
SourceZone
Description: The zone in the warehouse that inventory will be coming from during replenishments/transfers.
Data Type: String
Required: No
ItemNumber
Description: The item that the inventory request is for.
Data Type: String
Required: Yes
Quantity
Description: The quantity of the item requested.
Data Type: Decimal
Required: Yes
UomDesc
Description: The unit of measurement for the item.
Data Type: String
Required: No
CoreValue
Description: The core value of the item if it is SERIAL, LOT, or DATE tracked.
Data Type: String
Required: No
AllocationSetName
Description: The allocation set of the item, if applicable.
Data Type: String
Required: No
DestinationWarehouseName
Description: The warehouse the inventory request is for.
Data Type: String
Required: Yes
DestinationBinNumber
Description: The bin in the warehouse the inventory request will go to.
Data Type: String
Required: No
DestinationZone
Description: The zone in the warehouse the inventory request will go to.
Data Type: String
Required: No
StatusDescription
Description: The status of the inventory request (Pending, Available, Started, Complete, Deleted, Cancelled, Declined).
Data Type: String
Required: No
RequestExpiration
Description: The date the inventory request will expire if not fulfilled.
Data Type: Date
Required: No
RetainLP
Description: Toggles whether the inventory will remain on its License Plate throughout the transfer.
Data Type: Boolean
Required: No - defaults to false.
CreatedByUser
Description: The user that initiated the inventory request.
Data Type: String
Required: No, however it is useful for tracking.
DateCreated
Description: The date the inventory request was initiated.
Data Type: Date
Required: No - Autogenerated.
LastModifiedByUser
Description: The user who most recently updated the inventory request.
Data Type: String
Required: No
LastModified
Description: Date the inventory request was most recently updated.
Data Type: Date
Required: No
VendorNumber
Description: The identifier of the vendor for procurement requests.
Data Type: String
Required: No
AutogenerateTasks
Description: A toggle for whether the respective tasks (sales/purchase/transfer order) should be created immediately upon submitting an inventory request.
Data Type: Boolean
Required: No
Examples:
When using the POST request to import inventory requests:
{
"InventoryRequestID": "", //Optional unless making changes to an existing request
"SourceProcess": "", //Optional
"Priority": "", //Optional
"SourceWarehouseName": "", //Optional - Character limit 100
When using the GET request to view inventory requests:
[
{
"Tasks": [
{
"TaskDescription": "Purchase Order",
"TaskNumber": "PROC1012",
"ItemNumber": "1233",
"Quantity": 50.00,
"UomDesc": "LB",
"StatusDescription": "Complete",
"SourceWarehouseName": "Warehouse",
"DestinationWarehouseName": "Warehouse",
"DestinationBinNumber": "",
"DestinationZone": ""
}
],
"RequestGroup": "W-2406-001",
"SourceProcess": "Procurement",
"Priority": "10",
"SourceWarehouseName": "Warehouse",
"StatusDescription": "Complete",
"DateCreated": "2024-06-12T15:14:53",
"LastModified": "2024-06-12T15:14:53 ",
"VendorNumber": "DefaultVendor"
}
]