Workflow Data Primitives

Workflow Activities manipulate Footprint information in the form of Data Primitives. The following is a listing of each Data Primitive available for use in Footprint.

For information about customizing Workflows in Footprint, see the Workflow guide.

CreateAndPlanReplenTasksHardAllocationRequest

This object contains the list of allocations requests for replenishments. Derived from HardAllocationRequest.

object CreateAndPlanReplenTasksHardAllocationRequest
object(int locationId)	Constructor for the Replenishment request.
int LocationToReplen	The index of the replensishment location, is the id that is visible in the Warehouse Explorer

GenerateManufacturingInventoryMoveTasksHardAllocationRequest

This object contains the list of allocations requests for Manufacturing inventory moves. Derived from HardAllocationRequest.

object GenerateManufacturingInventoryMoveTasksHardAllocationRequest
object(int pickSlipId)	Constructor for the Manufacturing request.
int PickSlipId	The index of the pick slip, is the id that is visible in the Wave.

GenericHardAllocationRequest

This object contains the list of allocations request for Generic cases. Derived from HardAllocationRequest.

object GenericHardAllocationRequest
object(string topic)	Constructor for the Generic Hard Allocation Request.
string Topic	The lookup code of the topic.

HardAllocationRequest

This object contains the list of allocations request details. Derived from AllocationRequest.

object HardAllocationRequest
PackageAllocationStrategyEnum? PackageAllocationStrategyEnum	The Package Allocation Strategy Enumerator for allocation. Like largest or order line.
AllocationStrategyEnum? AllocationStrategyEnum	The Lot Allocation Strategy Enumerator for allocation. Like FIFO, FEFO, LIFO, FMFO and so on...
int? GlobalMaterialId	The index of global material desired for allocation
List<int> GlobalMaterialMaterialsToIgnore	The List of the indexes of global materials to ignore during processing
List<int> LocationsToIgnore	The List of the indexes of locations to ignore during processing

InventoryAdjustmentTasksGenerationForMaterialTransferLineAllocationRequest

object InventoryAdjustmentTasksGenerationForMaterialTransferLineAllocationRequest
object(int materialTransferSourceLineId)	Constructor for the object.object(int materialTransferSourceLineId)
int MaterialTransferSourceLineId	The index of the material transfer source

InventoryPlanningTasksGenerationHardAllocationRequest

This object contains the list of allocations requests for Manufacturing inventory planning. Derived from HardAllocationRequest.

object InventoryPlanningTasksGenerationHardAllocationRequest
object(int manufacturingOrderId)	Constructor for the Manufacturing inventory planning request.
int ManufacturingOrderId	The index of the Manufacturing Order.

PickTasksGenerationForOutboundShipmentLineHardAllocationRequest

This object contains the list of allocations requests for replenishments. Derived from HardAllocationRequest.

object PickTasksGenerationForOutboundShipmentLineHardAllocationRequest
object(int shipmentLineId)	Constructor for the Shipment allocation request. Given a Shipment Line index.
int ShipmentLineId	The index of the shipment, is the id that is visible in the outbound shipment list.

AllocationRequest

This object contains the list of allocations request base details.

object AllocationRequest
int WarehouseId	The index of the warehouse desired for allocation
int MaterialId	The index of the material desired for allocation
InventoryQuantity PackagedQuantity	The desired Packaged Quantity for allocation. Provided in InventoryQuantity object type.
InventoryQuantity BaseQuantity	The desired Quantity in base packaging for allocation. Provided in InventoryQuantity object type.
int? LotId	The index of the lot desired for allocation. Does not need to be given
int? VendorLotId	The index of the vendor lot desired for allocation. Does not need to be given
List<int> SerialNumberIds	The list of indexes of serial numbers desired for allocation. Does not need to be given
int? LicensePlateId	The index of the license plate desired for allocation. Does not need to be given
AllocationRequestTypeEnum AllocationRequestType	The context enumerator of request that is given.

AllocationRequestTypeEnum

Allocation Request Type Enumerator. The Context of where the allocation request was called.

Enumerator AllocationRequestTypeEnum
SalesOrderProcessingSoftAllocationRequest = 1,
InventoryPlanningReservationSoftAllocationRequest = 2,
InboundThirdPartyAsnVirtuallyAllocateSoftAllocationRequest = 3,
ScaleTicketProcessOutboundLoadingSoftAllocationRequest = 4,
PickTasksGenerationForOutboundShipmentLineHardAllocationRequest = 5,
InventoryPlanningTasksGenerationHardAllocationRequest = 6,
CreateAndPlanReplenTasksHardAllocationRequest = 7,
GenerateManufacturingInventoryMoveTasksHardAllocationRequest = 8,
ManufacturingLoadAnticipatedAllocationsHardAllocationRequest = 9,
GenericHardAllocationRequest = 10,
GenericSoftAllocationRequest = 11,

CreateAndPlanReplenTasksAllocationContext

This object contains context for Creating And Planning Replenish Tasks Allocation. Derived from HardAllocationContext.

object CreateAndPlanReplenTasksAllocationContext
object(int locToReplenId)	Constructor for the context for Creating And Planning Replenish Tasks Allocation. Given the index of the location to replenish.
int LocationToReplenId	The index of the replenishment location, is the id that is visible in the Warehouse Explorer

GenerateManufacturingInventoryMoveTasksAllocationContext

This object contains context for Generate Manufacturing Inventory Move Tasks Allocation. Derived from HardAllocationContext.

object GenerateManufacturingInventoryMoveTasksAllocationContext
object(int pickSlipId)	Constructor for the context for Generate Manufacturing Inventory Move Tasks Allocation. Given the index of the pick slip.
int PickSlipId	The index of the pick slip, is the id that is visible in the Wave

GenerateManufacturingInventoryMoveTasksAllocationContext

This object contains context for Generate Manufacturing Inventory Move Tasks Allocation. Derived from HardAllocationContext.

object GenerateManufacturingInventoryMoveTasksAllocationContext
object(int pickSlipId)	Constructor for the context for Generate Manufacturing Inventory Move Tasks Allocation. Given the index of the pick slip.
int PickSlipId	The index of the pick slip, is the id that is visible in the Wave

InventoryAdjustmentTasksGenerationForMaterialTransferLineAllocationContext

This object contains context for Inventory Adjustment Tasks Generation For MaterialTransferLine Allocation. Derived from HardAllocationContext.

object InventoryAdjustmentTasksGenerationForMaterialTransferLineAllocationContext
object(int materialTransferSourceLineId)	Constructor for the context .
int MaterialTransferSourceLineId	The index of the Material Transfer Source Line Id.

InventoryPlanningTasksGenerationAllocationContext

This object contains context for Inventory Planning Tasks Generation Allocation. Derived from HardAllocationContext.

object InventoryPlanningTasksGenerationAllocationContext
object(int manufacturingOrderId)	Constructor for the context for Inventory Planning Tasks Generation Allocation. Given the index of the Manufacturing Order.
int ManufacturingOrderId	The index of the Manufacturing Order, is the id that is visible in Manufacturing

PickTasksGenerationAllocationContext

This object contains context for Pick Tasks Generation Allocation. Derived from HardAllocationContext.

object PickTasksGenerationAllocationContext
object(int shipmentLineId)	Constructor for the context for Pick Tasks Generation Allocation. Given the index of the Shipment Line.
int ShipmentLineId	The index of the Shipment Line, is the id that is visible in a shipment

PickTasksGenerationReallocationContext

This object contains context for Pick Tasks Generation Reallocation. Derived from PickTasksGenerationAllocationContext.

object PickTasksGenerationReallocationContext
object(int shipmentId, int taskId)	Constructor for the context for Pick Tasks Generation Reallocation. Given the index of the Task.
int TaskId	The index of the Task, is the id that is visible in a Task View

MaterialTransferAction

This object contains Material Transfer Action properties. Derived from PreAllocationAction.

object MaterialTransferAction
int WarehouseId	The index of the Warehouse, is the id that is visible in Warehouse setup
decimal PackagedAmount	The amount of inventory in the packaging
int SourceMaterialId	The index of the source material
int SourcePackagedId	The index of the source material packaging
int? SourceLotId	The index of the source lot. Can be empty.
int? SourceVendorLotId	The index of the source vendor lot. Can be empty.
int TargetMaterialId	The index of the target material. What the source is be transformed into
int TargetPackagedId	The index of the target material packaging. What the source is be transformed into
int? TargetLotId	The index of the target lot. What the source is be transformed into. Empty implies creation of new lot for target
int? TargetVendorLotId	The index of the target vendor lot. What the source is be transformed into. Empty implies creation of new lot for target
bool TransferAllAmountFromSourceLicensePlate	A Boolean that indicate if all material on a given license plate should be transferred thus ignoring the materials specified
Guid AllocationStrategyId	The index of the allocation strategy to use
MaterialTransferAction(int warehouseId, decimal packagedAmount, int sourceMaterialId, int sourcePackagedId, int? sourceLotId, int? sourceVendorLotId, int targetMaterialId, int targetPackagedId, int? targetLotId, int? targetVendorLotId)	Constructor for the context for Material Transfer Action. Given the index of the source and target.
MaterialTransferAction(int warehouseId, decimal packagedAmount, Material sourceMaterial, int sourcePackagedId, Lot sourceLot, VendorLot sourceVendorLot, Material targetMaterial, int targetPackagedId, Lot targetLot, VendorLot targetVendorLot)	Constructor for the context for Material Transfer Action. Given the objects of the source and target.

ReplenishmentAction

This object contains Replenishment Action properties. Derived from PreAllocationAction.

object ReplenishmentAction
int SourceLocationId	The index of the source Location. The location where the replenishment need to come from.
int TargetLocationId	The index of the target Location. The location where the replenishment need to go to.
int? LicensePlateId	The index of the license plate. Can be empty, if not direct user to get material form specific license plate.
int LotId	The index of the source Lot.
InventoryQuantity Quantity	The actual quantity needed. see InventoryQuantity object.
ReplenishmentAction(int sourceLocationId, int targetLocationId, int? licensePlateId, int lotId, InventoryQuantity quantity)	Constructor for the context for Material Transfer Action. Given the index of the source and target and the quantity object.

This object contains Hard Allocation Request properties. It is used to direct the workflows to what the desire materials and quantities are needed.

object HardAllocationRequest
int WarehouseId	The index of the Warehouse, is the id that is visible in Warehouse setup
InventoryQuantity Quantity	The actual quantity needed. see InventoryQuantity object.
List<int> LocationsToIgnore	The list of location indexes that direct the allocation to not use as sources of inventory. Can be empty.
int? LotId	The index of the desired lot. Can be empty.
int? VendorLotId	The index of the desired vendor lot. Can be empty.
int? LicensePlateId	The index of the license plate. Can be empty.
HardAllocationRequest(int warehouseId, InventoryQuantity quantity, int? lotId = null, int? vendorLotId = null, int? licensePlateId = null)	Constructor for the context for Hard Allocation Request. Given the index of the source and target and the quantity object.

AllocationSuggestion

object AllocationSuggestion
int? LocationId	The index of the Location that is to be allocated from. Can be empty if and only if License plate is given.
int? LicensePlateId	The index of the license plate. Can be empty. If it is empty then location and lot should not be. if it is not empty allocation use the given license plate as source.
int? LotId	The index of the Lot that is to be allocated
InventoryQuantity Quantity	The actual quantity found. see InventoryQuantity object.

HardAllocationResponse

This object contains Hard Allocation Response. It is the results of the allocation request and can be a combination of found inventory and list of inventory it could not find.

object HardAllocationResponse
List<HardAllocationSuggestion> HardAllocationSuggestions	The list of allocation suggestion. That is a list of locations or license plates that have the desired inventory
List<ManualAllocationSuggestion> ManualAllocationSuggestions	The list of manual allocation suggestion. This is where we require the user to manual allocate the inventory. Often this is a result where allocation could not be found
InventoryQuantit RemainingQuantity	The quantity of any inventory for the request that is remaining. Usually this is is zero as it is often dumped into manual allocation. see InventoryQuantity object.

HardAllocationSuggestion

This object contains Hard Allocation Suggestion. Derived from AllocationSuggestion.

object HardAllocationSuggestion
List<PreAllocationAction> PreAllocationActions	The list of pre allocation action that need to take place before allocating the inventory. This are action like MaterialTransferAction and or ReplenishmentAction.
DateTime? ExpirationDate	The expiration date of the allocated Lot. Can be empty
HardAllocationSuggestion()	Constructor for the Hard Allocation Suggestion.

BarcodeGivenValues

This object contains the expected values on a given barcode.

object BarcodeGivenValues
List<int> MaterialIds	The material ids.

BlindPickingContextEnum

The enumerator for the context of where the blind pick workflow was called from.

Enumerator BlindPickingContextEnum
PickingByLocation

BlindPickingRequest

Contains the Blind Picking Request. This is created to pass information to the blind picking workflow.

object BlindPickingRequest
List<int> TaskIds	The id of the tasks.
LicensePlateRequest SourceLicensePlateRequest	The id of the source license plate.
LicensePlateRequest TargetLicensePlateRequest	The License plate request. The license plate details we desire to create.
string Employee	The user that is performing the task on the mobile.
List<Barcode> Items	The list of scanned items.

BlindPickingResponse

Contains the Blind Picking Response.

object BlindPickingResponse
List<PickTaskConfirmationResult> PickTaskConfirmationResults	List of pick confirmation results.
string ErrorMessage	Error message.

CartonizationContainer

This object is the Cartonization Container.

object CartonizationContainer
object containerTypeId)	Constructor for the Cartonization Container. Given the index of the type of container.
int ContainerTypeId	The index of the container type.
List<CartonizationQuantity> Quantities	The list of materials, quantities and packages contained within the container. see CartonizationQuantity object.

CartonizationGroupQuantitiesCriteriaEnum

This is the enumerator for the criteria on how to Group Quantities for Cartonization.

Enumerator CartonizationGroupQuantitiesCriteriaEnum
Order,
OrderLine,
Material,
Packaging

CartonizationOrderRequest

This object contains Cartonization Order Request. It is the context called from the Outbound Order. Derived from CartonizationRequest.

object CartonizationOrderRequest
int OrderId	The index of the Outbound Order as see in a order list.

CartonizationQuantity

This object contains Cartonization Quantity.

object CartonizationQuantity
object(int orderId, int lineNo, int materialId, int packagingId)	Constructor for the Cartonization Quantity. Given the index of material, package, order and line.
int MaterialId	The index of the material.
int PackagingId	The index of the package.
int OrderId	The index of the Outbound Order as see in a order list.
int LineNo	The line number in the Outbound Order as see in a order list.
decimal Amount	The amount that needs to be cartonized.
CartonizationQuantity CreateCartonizationQuantity(decimal amount)	Copy Constructor for the Cartonization Quantity. Given the index of material, package, order and line.

CartonizationRequest

This object contains Cartonization Request. It is the context called from the Outbound shipment.

object CartonizationRequest
List<CartonizationQuantity> QuantitiesToCartonize	The list of materials, quantities and packages that are requested to be cartonized. See CartonizationQuantity object.

CartonizationResult

This object contains Cartonization results for the shipment. Often is the returned from workflows.

object CartonizationResult
List<CartonizationQuantity> UncartonizedQuantities;	List of CartonizationQuantity that could not be cartonized by a workflows
List<CartonizationContainer> Containers;	List of Cartonization Container that has the container types and what is contained in them each.
void Merge(CartonizationResult cartonizationResult)	A function that merges a given cartonization Result into the current cartonization Result
void Merge(List<CartonizationContainer> cartonizationContainers)	A function that merges a given list cartonization Containers into the current cartonization Result's list

CartonizationShipmentRequest

This object contains Cartonization Shipment Request. It is the context called from the Outbound Shipment. Derived from CartonizationRequest.

object CartonizationShipmentRequest
int ShipmnetId	The index of the Outbound shipment as see in a shipment list.

AsnOrderLineLicensePlatesContext

This object contains Asn Order Line License Plates Context for Recommending Lots and Vendor Lots. It is the context called from the ASN Outbound order. Derived from RecommendLotVendorLotContextBase.

object AsnOrderLineLicensePlatesContext
object(Order order)	Constructor for the Asn Order Line License Plates Context. Given the Order object.
Order Order	The ASN order object.
override RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Asn Order Line License Plates Context.

BlindReceivingTaskContext

This object contains Blind Receiving Task Context for Recommending Lots and Vendor Lots. It is the context called from the Blind Receiving workflow. Derived from RecommendLotVendorLotContextBase.

object BlindReceivingTaskContext
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Blind Receiving Task Context.

CreateInventoryContext

This object contains Create Inventory Context for Recommending Lots and Vendor Lots. It is the context called from the Create Inventory process. Derived from RecommendLotVendorLotContextBase.

object CreateInventoryContext
object(Location location)	Constructor for the Create Inventory Context. Given the Location object.
Location Location	The Location object.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Create Inventory Context.

CustomContext

This object contains Custom Context for Recommending Lots and Vendor Lots. It is the context called from the Custom process. Derived from RecommendLotVendorLotContextBase.

object CustomContext
object(string topic)	Constructor for the Custom Context. Given the Location object.
string Topic	The Topic.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Custom Context.

InboundOrderLineCreationContext

This object contains Inbound Order Line Creation Context for Recommending Lots and Vendor Lots. It is the context called from the Inbound Order Line Creation process. Derived from RecommendLotVendorLotContextBase.

object InboundOrderLineCreationContext
object(Order order)	Constructor for the Inbound Order Line Creation Context. Given the Order object.
Order Order	The Order object.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Inbound Order Line Creation Context.

ManufacturingAddFeedbackContext

This object contains Manufacturing Add Feedback Context for Recommending Lots and Vendor Lots. It is the context called from the Manufacturing Feedback process. Derived from RecommendLotVendorLotContextBase.

object ManufacturingAddFeedbackContext
object(ManufacturingOrder order, ManufacturingOrderLine orderLine, WorkShif workShift, Location feedbackLocation, ManufacturingEquipment equipment)	Constructor for the Manufacturing Add Feedback Context . Given the Manufacturing Order object, its order line, the workshift, the equipment, and the location object.
ManufacturingOrder Order	The Manufacturing Order object.
ManufacturingOrderLine OrderLine	The Manufacturing Order line object.
WorkShift WorkShift	The WorkShift object.
Location FeedbackLocation	The FeedbackLocation object.
ManufacturingEquipment Equipment	The FeedbackLocation object.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Manufacturing Add Feedback Context.

ManufacturingFinishedGoodLineContext

This object contains Manufacturing Finished Good Line Context for Recommending Lots and Vendor Lots. It is the context called from the Manufacturing process. Derived from RecommendLotVendorLotContextBase.

object ManufacturingFinishedGoodLineContext
object(ManufacturingOrder order, ManufacturingOrderLine orderLine)	Constructor for the Manufacturing Finished Good Line Context. Given the Manufacturing Order object, its order line.
ManufacturingOrder Order	The Manufacturing Order object.
ManufacturingOrderLine OrderLine	The Manufacturing Order line object.
override RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Manufacturing Finished Good Line Context.

MaterialTransferContext

This object contains Material Transfer Context for Recommending Lots and Vendor Lots. It is the context called from the Material Transfer process. Derived from RecommendLotVendorLotContextBase.

object MaterialTransferContext
object(MaterialTransfer materialTransfer, Lot sourceLot)	Constructor  for the Material  Transfer  Context. Given  the Material Transfer object,  its source lot.
MaterialTransfer MaterialTransfer	The Material Transfer object.
Lot SourceLot	The Source Lot from transfer object.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Material Transfer Context.

ReceivingCreateGlobalLotContext

This object contains Receiving Create Global Lot Context for Recommending Lots and Vendor Lots. It is the context called from the Receiving process. Derived from RecommendLotVendorLotContextBase.

object ReceivingCreateGlobalLotContext
object(Task receivingTask)	Constructor for the Receiving Create Global Lot Context. Given the Receiving Task object.
Task ReceivingTask	The Receiving Task object.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Receiving Create Global Lot Context.

ReceivingTaskContext

This object contains Receiving Task Context for Recommending Lots and Vendor Lots. It is the context called from the Receiving process. Derived from RecommendLotVendorLotContextBase.

object ReceivingTaskContext
object(Task receivingTask)	Constructor for the Receiving Task Context. Given the Receiving Task object.
Task ReceivingTask	The Receiving Task object.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Receiving Task Context.

RecommendLotVendorLotContextEnum

The enumerator for the context of where the recommended lot creation was called from.

Enumerator RecommendLotVendorLotContextEnum
CreateInventoryContext = 0,
ReceivingTaskContext = 1,
ReceivingCreateGlobalLotContext = 2,
BlindReceivingTaskContext = 3,
InboundOrderLineCreationContext = 4,
ManufacturingAddFeedbackContext = 5,
ManufacturingFinishedGoodLineContext = 6,
MaterialTransferContext = 7,
AsnOrderLineLicensePlatesContext = 8,
ScaleTicketReceivingContext = 9,
CustomContext = 10

ScaleTicketLineCreationContext

This object contains Scale Ticket Receiving Context for Recommending Lots and Vendor Lots. It is the context called from the Scale Ticket Receiving process. Derived from RecommendLotVendorLotContextBase.

object ScaleTicketLineCreationContext
object(ScaleTicket scaleTicket)	Constructor for the Scale Ticket Receiving Context. Given the Scale Ticket Task object.
ScaleTicket ScaleTicket	The Scale ticket object. Used in the receiving of materials on balance scale.
RecommendLotVendorLotContextEnum RecommendLotVendorLotContext	The enumerator value of the Scale Ticket Receiving Context.

LotRecommendationRequest

This object contains Lot Recommendation Request data for Recommending Lots and Vendor Lots. Derived from LotVendorLotRecommendationRequestBase.

object LotRecommendationRequest
string LookupCode	The suggested lot lookup code.
int? VendorLotId	The index of an existing vendor lot. Can be empty implying we would like to generate a new vendor lot.
int StatusId	The status of the lot.
LotVendorLotRecommendationRequestEnum RecommendationRequestType	The enumerator containing the request type. either a lot request or a vendor lot request.

LotVendorLotRecommendationRequestBase

object LotVendorLotRecommendationRequestBase
int MaterialId	The index of the material for the lot to be recommended for.
string VendorLotLookupCode	Either the suggested vendor lot lookup code or the actual lookup code
DateTime? ManufactureDate	The manufacturing date and time for the vendor lot. Can be empty if it was never given.
DateTime? ExpirationDate	The expiration date and time for the vendor lot. Can be empty if it was never given.
LotVendorLotRecommendationRequestEnum RecommendationRequestType	To indicate the recommendation type

LotVendorLotRecommendationRequestEnum

The enumerator of Lot, Vendor Lot Recommended request type.

Enumerator LotVendorLotRecommendationRequestEnum
LotRequest = 0,
VendorLotRequest = 1

LotCreationRequest

This object contains Lot Creation Request data to send to the creation workflow.

object LotCreationRequest
int? Id	The index of the Lot. Can be empty. If empty it is a request for it to be created
string LookupCode	The Lookup code that is desired.
int StatusId	The index of the desired status of the lot
string Description	The desired description for the lot
string Notes	The desired notes for the lot
int? VendorLotId	The index of the vendor Lot. Can be empty. If empty it is a request for it to be created.
VendorLotCreationRequest	Constructor for the Lot Creation Request.
bool UseExistingVendorLot	Boolean to indicate using existing vendor lot.

LotRecommendationResponse

This object contains Lot Recommendation Response data returned from the creation workflow.

object LotRecommendationResponse
Lot ExistingLot	This object the existing Lot object.
LotCreationRequest	This object contains Lot Creation Request data to send to the creation workflow.
bool UseExistingLot	Boolean to indicate using existing lot.

VendorLotCreationRequest

This object is for the vendor lot creation request.

object VendorLotCreationRequest
int? VendorLotId	the index of vendor lot. Can be empty.
string LookupCode	Either the suggested vendor lot lookup code or the actual lookup code
DateTime? ManufactureDate	The manufacturing date and time for the vendor lot. Can be empty if it was never given.
DateTime? ExpirationDate	The expiration date and time for the vendor lot. Can be empty if it was never given.
int MaterialId	The index of the material for the lot to be recommended for.

VendorLotRecommendationResponse

This object contains Vendor Lot Recommendation Response data returned from the creation workflow.

object VendorLotRecommendationResponse
VendorLot ExistingVendorLot	This object the existing Vendor Lot object.
VendorLotCreationRequest VendorLotCreationRequest	This object contains Vendor Lot Creation Request data to send to the creation workflow.
bool UseExistingVendorLot	Boolean to indicate using existing vendor lot.

ManufacturingRequest

this object contains the Manufacturing Request details.

object ManufacturingRequest
int Id	the index of Manufacturing Request.
int ProjectId	the index of Project.
int WarehouseId	the index of Warehouse.
Guid ScheduleId	the index of the schedule.
int StatusId	the index of Manufacturing Request status.
int? StagingLocationId	the index of location where the materials to make finished good are staged. Can be empty.
int? ManufacturingLocationId	the index of location where the finished good are to be placed. Can be empty.
string LookupCode	the lookup code of Manufacturing Request. Its readable form.

ManufacturingRequestFinishedGood

This object is for the Manufacturing Request Finished Good.

object ManufacturingRequestFinishedGood
int Id	the index of Manufacturing Request Finished Good.
int ManufacturingRequestId	the index of Manufacturing Request containing the finished good.
int MaterialId	the index of Material.
int PackagingId	the index of Packaging.
decimal ExpectedPackagedAmount	The amount of Finished goods to manufacture.
int? VendorLotId	the index of vendor lot. Can be empty.
int? LotId	the index of lot. Can be empty.
int? OutboundOrderId	the index of an outbound order that can be link to the manufacture of finished good. Can be empty.
int? StagingLocationId	the index of location where the materials to make finished good are staged. Can be empty.
int? ManufacturingLocationId	the index of location where the finished good are to be placed. Can be empty.

MessageControllerContextEnum

The enumerator for the context of where the message controller workflow was called from.

Enumerator MessageControllerContextEnum
InboundReceivingSelectShipment = 1,
InboundReceivingSelectTask = 2,
SelectPickTask = 3,
SelectEquipment = 4,
OutboundPickingSelectShipment = 5,
ShipmentFirstLoadTask = 6,
InboundBlindReceivingShipmentCreated = 7,
InboundASNReceivingConfirmTask = 8

MessageControllerMessageSeverityEnum

The enumerator for the severity of the message.

Enumerator MessageControllerMessageSeverityEnum
Info = 0,
Warning = 1,
Error = 2

MessageControllerInboundASNReceivingConfirmTaskInput

This object contains inbound ASN receiving confirm task input data for message controller. Derived from MessageControllerInputBase.

object MessageControllerInboundASNReceivingConfirmTaskInput
int TaskId	The Id of the task.
MessageControllerContextEnum Context	The context of the object.

MessageControllerInboundBlindReceivingShipmentCreatedInput

This object contains inbound blind receiving shipment created input data for message controller. Derived from MessageControllerInputBase.

object MessageControllerInboundBlindReceivingShipmentCreatedInput
int ShipmentId	The Id of the shipment.
MessageControllerContextEnum Context	The context of the object.

MessageControllerInboundReceivingSelectShipmentInput

This object contains inbound receiving select shipment input data for message controller. Derived from MessageControllerInputBase.

object MessageControllerInboundReceivingSelectShipmentInput
int ShipmentId	The Id of the shipment.
MessageControllerContextEnum Context	The context of the object.

MessageControllerInboundReceivingSelectTaskInput

This object contains inbound receiving select task input data for message controller. Derived from MessageControllerInputBase.

object MessageControllerInboundReceivingSelectTaskInput
int TaskId	The Id of the task.
MessageControllerContextEnum Context	The context of the object.

MessageControllerInputBase

This object contains the message controller workflow input base details.

abstract object class MessageControllerInputBase
int EquipmentId	The Id of the equipment.
MessageControllerContextEnum Context	The context of the object.

MessageControllerOutboundPickingSelectShipmentInput

This object contains outbound picking select shipment input data for message controller. Derived from MessageControllerInputBase.

object MessageControllerOutboundPickingSelectShipmentInput
int ShipmentId	The Id of the shipment.
MessageControllerContextEnum Context	The context of the object.

MessageControllerOutputBase

This object contains the message controller workflow output base details.

object MessageControllerOutputBase
string Message	The message.
MessageControllerMessageSeverityEnum MessageSeverity	The severity of the message.

MessageControllerSelectEquipmentInput

This object contains the selected equipment input data for message controller. Derived from MessageControllerInputBase.

object MessageControllerSelectEquipmentInput
MessageControllerContextEnum Context	The context of the object.

MessageControllerSelectPickTaskInput

This object contains the selected pick task input data for message controller. Derived from MessageControllerInputBase.

object MessageControllerSelectPickTaskInput
int TaskId	The Id of the task.

MessageControllerShipmentFirstLoadTask

This object contains shipment first load task data for message controller. Derived from MessageControllerInputBase.

object MessageControllerShipmentFirstLoadTask
int ShipmentId	The Id of the shipment.
MessageControllerContextEnum Context	The context of the object.

HardCodedProcessStrategiesEnum

This object describes the different strategies to process outbound orders or shipments.

Enumerator HardCodedProcessStrategiesEnum
FillOrStop = 1,	Fill or Stop strategy.
FillAndCancelOutstanding = 2,	Fill and cancel outstanding strategy.
FillAndBackorderOutstanding = 3,	Fill and set backorder lines to new shipment strategy.
FillAndManuallyAllocateOutstanding = 4	Fill and set backorder lines to manual allocation strategy.

OutboundProcessingBehavior

This object describes how to process an outbound order or shipment.

object OutboundProcessingBehavior
bool? ShipmentPerContainer	Indicates if we create one shipment per container resulted from cartonization.
string CartonizationWorkflowId	Represents the cartonization strategy.
bool? ConsiderMaterialSubstitution	Indicates if material substitution should be considered.
bool? ConsiderOtherProjectsInventory	Indicates if other projects inventory should be considered.
bool? SkipOperationalValidation	Indicates if the operational validation should be skipped.

ConnectShipPrintItem

This object contains the ConnectShip Print Item details. These are used to connect to the third party shipping software. Derived from PrintItem

object ConnectShipPrintItem
new ConnectShipPrintJob PrintJob	the ConnectShip Print Job object.
List<ConnectShipStock> StockList	the list of ConnectShip paper stock choices.
List<ConnectShipDocumentFormat> FormatList	the list of ConnectShip printing format choices.
List<ConnectShipPrintOutput> OutputList	the list of ConnectShip printing output choices.

LabelPrintItem

This object contains the Label Print Item details. Derived from PrintItem

object LabelPrintItem
object(LabelPrintJobTypeEnum labelPrintType)	Constructor for the Label Print Item . Given the enumerator specifying the print label system.
new LabelPrintJob PrintJob	the Label Print Job object.

PrintItem

This object contains the Print Item details.

object PrintItem
PrintJob PrintJob	the Label Print Job object.
List<string> PrinterList	the list of printer names.
bool PrinterEditable	Indicates to the print engine if the printer can be changed.
bool Selected	An indicator if the item has been selected.

PrintRequest

This object contains the Print request details.

abstract object PrintRequest
string SubContext	A string that indicates the action or area under the context from where this was invoked.
List<PrintItem> PrintItems	the list of print item to be performed based on context.
abstract string Context	A string that indicates from where this was invoked.

ReportPrintItem

This object contains the SQL report Print Item details. Derived from PrintItem

object ReportPrintItem
FoundationReportingServicesPrintJob PrintJob	the SQL report Print Job object.

SerialNumberPrintRequest

This object contains the Serial Number Print request details. Derived from PrintRequest.

object SerialNumberPrintRequest
List<int> SerialNumberIds	the list of serial number indexes to print.
override string Context	A string that indicates from where this was invoked.

ShippingContainerPrintRequest

This object contains the Shipping Container Print request details. Derived from PrintRequest.

object ShippingContainerPrintRequest
List<int> ShippingContainerIds	the list of shipping container indexes to print.
string Context	A string that indicates from where this was invoked.

object ShippingManifestPrintRequest : PrintRequest
List<int> ShippingManifestIds	the list of shipping Manifest indexes to print.
string Context	A string that indicates from where this was invoked.

RawCartonizationContainer

This object contains the Raw Cartonization Container. Raw implies there are no direct material identities or packages.

object RawCartonizationContainer
object(RawCartonizationContainerType cartonizationContainerType)	Constructor for the RawCartonizationContainer. Given the raw container type.
RawCartonizationContainerType CartonizationContainerType	The raw Cartonization Container Type
RawCartonizationQuantities CartonizationQuantities	The items and quantities within the Cartonization Container.
decimal? MaxVolume	The Maximum volume of the Container. Can be empty
decimal? MaxWeight	The Maximum weight of the Container. Can be empty
decimal? ActualVolume	The Actual volume in the Container calculated from what is placed in it. Can be empty
decimal? ActualWeight	The Actual weight in the Container calculated from what is placed in it. Can be empty
decimal? MaxVolumeUsagePercentage	The percentage of the maximum volume used in the Container calculated from what is placed in it. Can be empty
decimal? MaxWeightUsagePercentage	The percentage of the maximum weight used in the Container calculated from what is placed in it. Can be empty

RawCartonizationContainerType

This object contains the Raw Cartonization Container Type. The shipping container size definition.

object RawCartonizationContainerType
string Id	The index of the raw Cartonization Container Type
string Name	The name of the raw Cartonization Container Type
decimal? Length	The Length of the raw Cartonization Container Type. Can be empty.
decimal? Width	The Width of the raw Cartonization Container Type. Can be empty.
decimal? Height	The Height of the raw Cartonization Container Type. Can be empty.
decimal? MaxVolume	The MaxVolume of the raw Cartonization Container Type. Can be empty.
decimal? MaxWeight	The MaxWeight of the raw Cartonization Container Type. Can be empty.
object(string id, decimal? length, decimal? width, decimal? height, decimal? maxVolume, decimal? maxWeight)	Constructor for the RawCartonizationContainer. Given the index, dimensions, and maximums for the container.
string ToString(bool simple)	Function that convert the container to string. Useful in debugging workflows.
static string ToString(RawCartonizationContainerType instance, bool simple = true)	Function that convert the container to string. Useful in debugging workflows.

RawCartonizationPackingStrategyEnum

This object is the Raw Cartonization Packing Strategy Enumerator.

Enumerator RawCartonizationPackingStrategyEnum
VolumeWeightOnlyPacking,
TetrisPacking

RawCartonizationQuantities

This object contains the Raw Cartonization Quantities. It is the list container that holds all the RawCartonizationQuantity.

Derived from a List of RawCartonizationQuantity

object RawCartonizationQuantities
object(List<RawCartonizationQuantity> quantities)	Constructor for the List given another list.
object(RawCartonizationQuantities quantities)	Constructor for the List given another a single Raw Cartonization Quantity object.
bool Add(RawCartonizationQuantities addedQuantityList)	Add to the current list given another Raw Cartonization Quantities object. Returns true if successful.
bool Add(List<RawCartonizationQuantity> addedQuantities)	Add to the current list given another list. Returns true if successful.
bool Remove(RawCartonizationQuantities removedQuantityList)	Attempt to remove a given list of Raw Cartonization Quantity objects from the current list. Returns true if successful.
bool Remove(List<RawCartonizationQuantity> quantitiesToRemove)	Attempt to remove a given list of Raw Cartonization Quantity objects from the current list. Returns true if successful.
bool Remove(string quantityToRemoveId)	Attempt to remove a Raw Cartonization Quantity objects from the current list given the index of the Quantity object. Returns true if successful.
RawCartonizationQuantities Clone()	Clones the current List and returns the copied list.
bool Contains(string quantityId)	Searches list for given index of the Quantity and return true if found .
List<RawCartonizationQuantity> GetPercentage(decimal percentage)	Calculates the percentage of volume for all the quantities in the list.
RawCartonizationQuantities SortByCriteria(RawCartonizationSortCriteriaEnum sortCriteria, RawCartonizationSortDirectionEnum sortDirection = RawCartonizationSortDirectionEnum.Ascending)	Sorts the quantities in the list given sortCriteria and direction of sort.
string ToString(bool simple)	Outputs the list a string. Given a Boolean to indicate full output or a simple output. This function is useful in debugging
static string ToString(RawCartonizationQuantities instance, bool simple = true)	Outputs the list a string. Given the list to output and given a Boolean to indicate full output or a simple output. This function is useful in debugging

RawCartonizationQuantity

this object contains the Raw Cartonization Quantity. It is the single item and all it dimensions weight and volume properties.

object RawCartonizationQuantity
string Id	The identifier of the Raw Cartonization Quantity.
string Name	The Name of the Raw Cartonization Quantity. This is a mangle version of FootPrints shipment, material and packaging
decimal Amount	The Amount of the Raw Cartonization Quantity. That is the quantity of material.
decimal? Width	The Width of the Raw Cartonization Quantity. That is the Width of material. Can be empty.
decimal? Height	The Height of the Raw Cartonization Quantity. That is the Height of material. Can be empty.
decimal? Length	The Length of the Raw Cartonization Quantity. That is the Length of material. Can be empty.
decimal? Weight	The Weight of the Raw Cartonization Quantity. That is the Weight of material. Can be empty.
decimal? Volume	The Volume of the Raw Cartonization Quantity. That is the Volume of material. Can be empty.
string StackableGroupId	The string index of the stackable group of the Raw Cartonization Quantity. This allows different materials to be stacked (nested) together.
decimal? StackableWidth	The Stackable Width increment of the Raw Cartonization Quantity. That is the Stackable Width increment of material. Can be empty.
decimal? StackableHeight	The Stackable Height increment of the Raw Cartonization Quantity. That is the Stackable Height increment of material. Can be empty.
decimal? StackableLength	The Stackable Length increment of the Raw Cartonization Quantity. That is the Stackable Length increment of material. Can be empty.
decimal? StackableVolume	The Stackable Volume increment of the Raw Cartonization Quantity. That is the Stackable Volume increment of material. Can be empty.
bool IsStackable	Returns True if any of the stacking fields have a value indicating that this material should be stacked
RawCartonizationQuantity Clone()	Clones the Raw Cartonization Quantity. Returns the copy of Raw Cartonization Quantity object.
RawCartonizationQuantity CreateRawCartonizationQuantity(decimal amount)	Create a new Raw Cartonization Quantity given a new amount but copy all other properties from the original object.
string ToString(bool simple)	Outputs the list a string. Given a Boolean to indicate full output or a simple output. This function is useful in debugging

RawCartonizationResult

This object contains the Raw Cartonization Results usually computed in the workflow.

object RawCartonizationResult
RawCartonizationQuantities UncartonizedQuantities	A list of the Raw Cartonization Quantities that the workflow could not or decided it could not cartonize.
List<RawCartonizationContainer>	The list Raw Cartonization Containers.

RawCartonizationSortCriteriaEnum

This object is the Raw Cartonization Sort Criteria Enumerator.

Enumerator RawCartonizationSortCriteriaEnum
Volume,
Weight,
TotalVolume,
TotalWeight

RawCartonizationSortDirectionEnum

This object is the Raw Cartonization Sort Direction Enumerator.

Enumerator RawCartonizationSortDirectionEnum
Ascending,
Descending

ReceivingRequest

This object contains a receiving request.

object ReceivingRequest
List<ShipmentLine> ShipmentLines	The list of shipment lines that are requested to be received.

ReceivingResult

This object contains receiving results.

object ReceivingResult
List<Task> ReceivingTasks;	List of tasks.
ReceivingResult()	Constructor for the Receiving Results.

RecommendedInventoryLocationContextEnum

This object is the Recommended Inventory Location Context Enumerator.

Enumerator RecommendedInventoryLocationContextEnum
InventoryPutAwayContext = 1,
InventoryMoveContext = 2,
DirectedInventoryMoveContext = 3

InventoryMoveRequest

This object is the Inventory Move Request. It is passes the Recommendation workflow.

object InventoryMoveRequest
List<Platform.Workflow.Data.LotInventoryQuantity> LotQuantity	A list of the Lot Inventory Quantity objects that the detail lot, material, quantity, and packaging that need a recommendation for location.
Dictionary<Platform.Workflow.Data.LicensePlate, Platform.Workflow.Data.Task> LicensePlatesAndTasks	A paired list of the LicensePlates and the putaway tasks that need a recommendation for location.

BillOfLadingReportViewRequest

object BillOfLadingReportViewRequest: ReportViewRequest
BillOfLadingReportViewRequest(string lookupCode, int shipmentId)	The constructor.
int ShipmentId	The Id of the shipment.

object ReportViewRequest
ReportViewRequest(string lookupCode)	The constructor.
string ReportLookupCode	The lookup code of the report.

ReportViewResponse

object ReportViewResponse
string ReportLookupCode	The lookup code of the report.

GenericSoftAllocationRequest

This object is the Generic Soft Allocation Request. It is derived from SoftAllocationRequest

object GenericSoftAllocationRequest
GenericSoftAllocationRequest(string topic)	Constructor for the GenericSoftAllocationRequest.
string Topic	The Topic.

InboundThirdPartyAsnVirtuallyAllocateSoftAllocationRequest

This object is the Inbound ThirdParty ASN Virtually Allocate Soft Allocation Request. It is derived from SoftAllocationRequest

object InboundThirdPartyAsnVirtuallyAllocateSoftAllocationRequest
object(OrderLine outboundWarehouseTransferOrderLine)	Constructor for the InboundThirdPartyAsnVirtuallyAllocateSoftAllocationRequest given an OrderLine from the outbound warehouse transfer.
OrderLine OutboundWarehouseTransferOrderLine	Get the OrderLine object.

This object is the Inventory Planning Reservation Soft Allocation Request. It is derived from SoftAllocationRequest

object InventoryPlanningReservationSoftAllocationRequest : SoftAllocationRequest
object(int manufacturingOrderLineId)	Constructor for the InventoryPlanningReservationSoftAllocationRequest given index of the OrderLine from the manufacturing order.
int ManufacturingOrderLineId	Get the index of the OrderLine.

SalesOrderProcessingSoftAllocationRequest

This object is the Sales Order Processing Soft Allocation Request. It is derived from SoftAllocationRequest

object SalesOrderProcessingSoftAllocationRequest
object(int orderId)	Constructor for the SalesOrderProcessingSoftAllocationRequest given index of the outbound sales Order.
int OrderId	Get the index of the Outbound Sale Order.

ScaleTicketProcessOutboundLoadingSoftAllocationRequest

This object is the Scale Ticket Process Outbound Loading Soft Allocation Request. It is derived from SoftAllocationRequest

object ScaleTicketProcessOutboundLoadingSoftAllocationRequest
object(int scaleTicketId)	Constructor for the ScaleTicketProcessOutboundLoadingSoftAllocationRequest given index of the scale ticket.
int ScaleTicketId	Get the index of the Scale Ticket.

SoftAllocationRequest

object SoftAllocationRequest : AllocationRequest
bool ConsiderOtherProjectsInventory	Boolean indicator on whether allocation should Consider Other Projects Inventory.
bool AllowSoftAllocatedAgainstInactive	Boolean indicator on whether allocation should Allow Soft Allocated Against Inactive.
bool AllowAllocationAgainstIncoming	Boolean indicator on whether allocation should Allow Allocation Against Incoming.

SoftAllocationResponse

This object is the Soft Allocation Response. It returns the results from the workflow.

object SoftAllocationResponse
bool HasSufficientInventoryForSoftAllocation	Boolean indicator on whether allocation Has Sufficient Inventory For Soft Allocation.
string Reason	The Reason.
List<int> AvailableSerialNumbersWhenInventoryIsInsufficient	The list of the index Available Serial Numbers When Inventory Is Insufficient.
InventoryQuantity AvailableQuantityWhenInventoryIsInsufficient	The Available Quantity When Inventory Is Insufficient.
InventoryQuantity InactiveQuantityWhenInventoryIsInsufficient	The Inactive Quantity When Inventory Is Insufficient.
InventoryQuantity IncomingQuantityWhenInventoryIsInsufficient	The Incoming Quantity When Inventory Is Insufficient.

SurveyOrchestrationContextEnum

The enumerator for the context of where the survey orchestration workflow was called from.

Enumerator SurveyOrchestrationContextEnum
InboundReceivingSelectShipment = 1,
SaveInboundReceivingSelectShipment = 2,
InboundReceivingSelectTask = 3,
SaveInboundReceivingSelectTask = 4,
SelectPickTask = 5,
SaveSelectPickTask = 6,
SelectEquipment = 7,
SaveSelectEquipment = 8,
OutboundPickingSelectShipment = 9,
SaveOutboundPickingSelectShipment = 10,
ShipmentFirstLoadTask = 11,
SaveShipmentFirstLoadTask = 12,
SaveInboundReceivingConfirmTask = 13,
InboundReceivingConfirmTask = 14,
InboundBlindReceivingShipmentCreated = 15,
SaveInboundBlindReceivingShipmentCreated = 16,
InboundASNReceivingConfirmTask = 17,
SaveInboundASNReceivingConfirmTask = 18

SurveyOrchestrationInboundASNReceivingConfirmTaskInput

This object contains save inbound ASN receiving confirm task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationInboundASNReceivingConfirmTaskInput
int TaskId	The Id of the task.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationInboundBlindReceivingShipmentCreatedInput

This object contains save inbound blind receiving shipment created input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationInboundBlindReceivingShipmentCreatedInput
int ShipmentId	The Id of the shipment.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationInboundReceivingConfirmTaskInput

This object contains save inbound receiving confirm task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationInboundReceivingConfirmTaskInput
int TaskId	The Id of the task.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationInboundReceivingSelectShipmentInput

This object contains inbound receiving select shipment input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationInboundReceivingSelectShipmentInput
int ShipmentId	The Id of the shipment.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationInboundReceivingSelectTaskInput

This object contains inbound receiving select task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationInboundReceivingSelectTaskInput
int TaskId	The Id of the task.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationInputBase

object SurveyOrchestrationInputBase
string UserName	The user name.
int EquipmentId	The Id of the equipment.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationOutboundPickingSelectShipmentInput

This object contains outbound picking select shipment input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationOutboundPickingSelectShipmentInput
int ShipmentId	The Id of the shipment.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveInboundASNReceivingConfirmTaskInput

This object contains save inbound ASN receiving select task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationOutboundPickingSelectShipmentInput
int TaskId	The Id of the task.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveInboundBlindReceivingShipmentCreatedInput

This object contains save inbound blind receiving shipment created input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveInboundBlindReceivingShipmentCreatedInput
int ShipmentId	The Id of the shipment.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveInboundReceivingConfirmTaskInput

This object contains save inbound receiving select task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveInboundReceivingConfirmTaskInput
int TaskId	The Id of the task.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveInboundReceivingSelectShipmentInput

This object contains save inbound receiving select shipment input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveInboundReceivingSelectShipmentInput
int ShipmentId	The Id of the shipment.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveInboundReceivingSelectTaskInput

This object contains save inbound receiving select task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveInboundReceivingSelectTaskInput
int TaskId	The Id of the task.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveOutboundPickingSelectShipmentInput

This object contains save outbound picking select shipment input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveOutboundPickingSelectShipmentInput
int ShipmentId	The Id of the shipment.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveSelectEquipmentInput

This object contains the selected equipment input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveSelectEquipmentInput
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveSelectPickTaskInput

This object contains the selected pick task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveSelectPickTaskInput
int TaskId	The Id of the task.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSaveShipmentFirstLoadTask

This object contains save shipment first load task data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSaveShipmentFirstLoadTask
int ShipmentId	The Id of the shipment.
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSelectEquipmentInput

This object contains the selected equipment input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSelectEquipmentInput
Survey CompletedSurvey	The completed survey.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationSelectPickTaskInput

This object contains the selected pick task input data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationSelectPickTaskInput
int TaskId	The Id of the task.
SurveyOrchestrationContextEnum Context	The context of the object.

SurveyOrchestrationShipmentFirstLoadTask

This object contains shipment first load task data for survey orchestration. Derived from SurveyOrchestrationInputBase.

object SurveyOrchestrationShipmentFirstLoadTask
int ShipmentId	The Id of the shipment.
SurveyOrchestrationContextEnum Context	The context of the object.

TasksAssignmentRequestBase

object TasksAssignmentRequestBase
TasksAssignmentRequestTypeEnum TasksAssignmentRequestType	The Tasks Assignment Request Type property.

TasksAssignmentRequestTypeEnum

This object is the Tasks Assignment Request Type Enumerator.

Enumerator TasksAssignmentRequestTypeEnum
UserTasksAssignment = 1,
UserTasksAssignmentOnTaskCompletion = 2,
UserTasksAssignmentOnTaskCancellation = 3

UserTasksAssignmentOnTaskCancellationRequest

This object contains the User Task request triggered when Task Cancellation is clicked from the mobile. This is the input to the workflow. Derived from UserTasksAssignmentRequest.

object UserTasksAssignmentOnTaskCancellationRequest
int TaskId	The index of the task that was cancelled.

UserTasksAssignmentOnTaskCompletionRequest

This object contains the User Task request details. This is the input to the workflows. Derived from TasksAssignmentRequestBase.

object UserTasksAssignmentOnTaskCompletionRequest
int TaskId	The index of the task that was assigned.

UserTasksAssignmentRequest

This object contains the User Task request details. This is the input to the workflows. Derived from TasksAssignmentRequestBase.

object UserTasksAssignmentRequest
string UserId	The index of the user performing the request.
int WarehouseId	The index of the warehouse where the request is performed.
int EquipmentId	The index of the equipment where the request is performed.
int? WorkclassId	The workclassId that user selected in the login page.

EntityUdfValues

This object contains the UDF Field Values details.

object EntityUdfValues
string EntityName	The object to which the User defined field belongs to.
EntityKeyBase EntityKey	The index of object to which the User defined field belongs to. int UdfId
int UdfId	The index of the User defined field.
string UdfName	The name of the User defined field.
List<string> Values	The list of values for the User defined field.

SingleKeyEntityUdfValues

This object contains the UDF Field Values details.

object SingleKeyEntityUdfValues
string EntityName	The object to which the User defined field belongs to.
int EntityId	The index of object to which the User defined field belongs to.
int UdfId	The index of the User defined field.
string UdfName	The name of the User defined field.
List<string> UdfValue	The list of values for the User defined field.

UdfEntityTypeEnum

This object is the User define field Entity Type Enumerator.

Enumerator UdfEntityTypeEnum
Owner = 1,	Owner
Project = 2,	Project
Account = 3,	Account
BillingContract = 4,	Billing Contract
Contact = 5,	Contact
Invoice = 6,	Invoice
ScaleTicket = 7,	Scale Ticket
LocationContainer = 8,	Location Container
LicensePlate = 9,	License Plate
Order = 10,	Order
OrderClass = 11,	Order Class
ProcurementOrder = 12,	Procurement Order
ManufacturingOrder = 13,	Manufacturing Order
Shipment = 14,	Shipment
InboundShipment = 15,	Inbound Shipment
OutboundShipment = 16,	Outbound Shipment
MaterialGroup = 17,	Material Group
Material = 18,	Material
Lot = 19,	Lot
SerialNumber = 20,	Serial Number
OrderLine = 21	Order Line

UdfFieldDataTypeEnum

This object is the UDF Data Type Enumerator.

Enumerator UdfFieldDataTypeEnum
Text = 1,	Text
Numeric = 2,	Numeric
Boolean = 3,	Boolean
DateTime = 4,	DateTime
ListOfText = 5,	List of Text
ListOfNumeric = 6,	List of Numeric
ListOfDateTime = 7,	List of DateTime

UdfFieldPossibleValues

This object contains the UDF Field Possible Values details.

object UdfFieldPossibleValues
int Id	The index of the User defined Possible Value field.
int UdfFieldId	The index of the User defined field.
string UdfValue	The value of the user defined field.

UdfFields

This object contains the UDF Field details.

object UdfFields
int Id	The index of the User defined field.
UdfFieldDataTypeEnum TypeId	The index of the User defined field type.
string EntityName	The object to which the User defined field belongs to.
string Name	The name of the User defined field.
string Label	The label of the User defined field.
string Description	The description of the User defined field.
bool DisplayReadOnly	The Display Readonly flag of the User defined field.
bool DisplayVisible	The Display Visible flag of the User defined field.
int DisplayOrder	The Display Order flag of the User defined field.
List<UdfFieldPossibleValues> PossibleValues	The list of possible values of the User defined field.

UdfSingleKeyEntityTypeEnum

This object is the User Define Field Entity Single Key (Id) Type Enumerator.

Enumerator UdfSingleKeyEntityTypeEnum
Owner = 1,	Owner
Project = 2,	Project
Account = 3,	Account
BillingContract = 4,	Billing Contract
Contact = 5,	Contact
Invoice = 6,	Invoice
ScaleTicket = 7,	Scale Ticket
LocationContainer = 8,	Location Container
LicensePlate = 9,	License Plate
Order = 10,	Order
OrderClass = 11,	Order Class
ProcurementOrder = 12,	Procurement Order
ManufacturingOrder = 13,	Manufacturing Order
Shipment = 14,	Shipment
InboundShipment = 15,	Inbound Shipment
OutboundShipment = 16,	Outbound Shipment
MaterialGroup = 17,	Material Group
Material = 18,	Material
Lot = 19,	Lot
SerialNumber = 20	Serial Number

AccesorialTaskConfirmationPromptTriggerEnum

This object is the Accesorial Task Confirmation Prompt Trigger Enumerator.

Enumerator AccesorialTaskConfirmationPromptTriggerEnum
OnLastPickTaskConfirmation = 1,	On Last Pick Task Confirmation
OnLastLoadTaskConfirmation = 2,	On Last Load Task Confirmation
OnPutawayConfirmationByLP = 3,	On Putaway Confirmation By LP
OnLastUnitQtyReceived = 4	On Last Unit Qty Received

Account

This object contains the Account details.

object Account
int Id	The index of the account.
int EnterpriseId	The index of the Enterprise.
AccountTypeEnum AccountType	The type of account.
string Name	The Name of the account.
string LookupCode	The lookup code of the account.
int AllocationPriority	The allocation priority of the account.
bool AllowReceiving	Does the account allow inbound receiving then return true.
bool AllowShipping	Does the account allow outbound shipping then return true.
bool AllowReturnsIn	Does the account allow return receiving then return true.
bool RequiresReceivingRMA	Does the account require receiving RMA then return true.
bool RequiresShippingRMA	Does the account require Shipping RMA then return true.
int TaxScheduleId	The index of the tax schedule.
string Notes	The note for the account.
string ComplianceLabelFile	The file for the compliance.

AccountTypeEnum

This object is the Account Type Enumerator.

Enumerator AccountTypeEnum
Vendor = 1,
Customer = 2,
Warehouse = 3,
Order = 4,
Broker = 5,
Shipping = 6,
Terminal = 7

AllocationStrategyEnum

This object is the Allocation Strategy Enumerator.

Enumerator AllocationStrategyEnum
FirstExpiredFirstOut = 1,	First Expired First Out
FirstInFirstOut = 2,	First In First Out
FirstManufacturedFirstOut = 3,	First Manufactured First Out
LastExpiredFirstOut = 4	Last Expired First Out

Barcode

This object contains the Barcode details. This is used by the barcode workflow to gather all information from the parse workflow.

object Barcode
int? WeightUom	The index of the Weight unit of measure. Can be empty.
string MaterialLookupCode	The readable Lookup code for this material.
string UPC	The UPC for this material.
decimal? Quantity	The quantity. Can be empty.
string UOM	The unit of measure.
string LotLookupCode	The Lot lookup code.
string LotDescription	The description of the Lot.
string VendorLotLookupCode	The vendor Lot lookup code.
DateTime? ManufactureDate	The manufacture date of the lot. Can be empty.
DateTime? ExpirationDate	The expiration date of the lot. Can be empty.
string SerialNumber	The Serial Number.
decimal? NetWeight	The net weight. Can be empty.
decimal? GrossWeight	The gross weight. Can be empty.
string AccountLookupCode	The readable Lookup code for the account.

BarcodeParser

This object contains the Barcode Parser info. This is used by the barcode workflows.

object BarcodeParser
int Id	The index of the barcode parser.
string Code	The readable Lookup code for the barcode parser.
int? OwnerId	The index of the owner the barcode applies to. Can be empty.
int? ProjectId	The index of the project the barcode applies to. Can be empty.
int? AccountId	The index of the account the barcode applies to. Can be empty.
BarcodeGivenValues GivenValues	Contains the values associated to the context of a given barcode.

BarcodeParserContextEnum

This object is the Barcode Parser Context Enumerator. From where the get parser was called from.

Enumerator BarcodeParserContextEnum
Receiving = 1,
PreReceiving = 2,
SerialUpdate = 3,
Lot = 4,
BlindPicking = 5

BillingRateRequest

This object contains the Billing Rate Request. This is used by the billing contracts when generating the billing records.

object BillingRateRequest
decimal Rate	The billing Rate of the contract item
int CurrencyId	The index of the Currency for the rate value.
string Notes	The Note of the billing rate
decimal? MinimumCharge	The Minimum Charge of the contract item

BillingRequest

This object contains the Billing Request. This is used when creating billing records.

abstract object BillingRequest
int EventId	The index of the footprint event that is performing the billing process.
int ContractId	The index of the billing contract that is involved in the billing process.
int ContractLineId	The index of the billing contract line item that is involved in the billing process.
abstract string Context	The context from where this request has been called.
List<WorkflowDivertBilling> DivertedProjects	The project divert billing list.
bool BillOriginalButExcludeSelectedBillingCodes	Bill original project but exclude selected billing codes on diverted project(s)
bool IsDivert	Is the contract line strategy diverted?
int DivertSourceProjectId	Source project for the contract line strategy
int DivertTargetProjectId	Target project for the contract line strategy (if matches source, this is the original project)

BillingTaskRequest

This object contains the Billing Task Request. This is created from the workflow to inform footprint caller to create record.

object BillingTaskRequest
int WarehouseId	The index of the warehouse.
int BillingCodeId	The index of the billing code.
int? ProjectId	The index of the project. Can be empty initially but must be filled.
int? OperationCodeId	The index of the operation code. Can be empty initially but must be filled.
int? OrderId	The index of the order. Can be empty.
int? OrderLineNumber	The order line number. Can be empty.
int? ShipmentId	The index of the shipment. Can be empty.
int? ShipmentLineId	The shipment line number. Can be empty.
int? AccountId	The index of the account. Can be empty.
int? MaterialId	The index of the material. Can be empty.
int? LotId	The index of the lot. Can be empty.
int? LicensePlateId	The index of the license plate. Can be empty.
decimal Amount	The index of the Amount. The caller will use this and the rate below to calculate the actual value.
int? Uom	The index of the unit of measure. Can be empty.
string Notes	The notes for the billing record to create.
int? WorkOrderId	The index of the work order. Can be empty.
int? PackagingId	The index of the packaging. Can be empty.
int? VendorLotId	The index of the vendor lot. Can be empty.
BillingRateRequest BillingRateRequest	The billing rate object.
BillingTaskRequest()	Constructor for the billing task request.

BlindReceiveTaskResult

This object contains the Blind Receive Task Result. This is created from the blind receiving workflow to inform footprint mobile what record was created.

object BlindReceiveTaskResult
string OutputMessage	A message to display at caller of workflow.
int TaskId	The index of the task created.

BlindReceivingRequest

This object contains the Blind Receiving Request. This is created to pass information to the blind recieving workflow.

object BlindReceivingRequest
int WarehouseId	The index of the warehouse.
int LotId	The index of the Lot.
int PackagingId	The index of the packaging.
decimal PackagedAmount	The amount of the package material.
int TargetLocationId	The index of the target location.
LicensePlateRequest LicensePlateRequest	The License plate request object. The license plate details we desire to create.
int? ShipmentId	The index of the shipment. Can be empty.
string Employee	The user that is performing the task on the mobile.
string ReceiptNumber	The receipt number.

ConjunctionTypeEnum

This object is the Conjunction (and,or, ...) Type Enumerator.

Enumerator ConjunctionTypeEnum
OR,
AND,
None

Contact

This object contains the Contact details. This is created to pass information to the blind receiving workflow.

object Contact
int Id	The index of the Contact.
string OwnerEntity	The Owner Entity that is the type of object to which the contact is for like Owners, Warehouses, Account, and so on.
int OwnerId	The index of the Owner object.
ContactTypesEnum ContactType	The type of contact.
int AddressId	The index of the Address.
string ReferenceCode	The contact's reference code.
string LastName	The contact's last name.
string FirstName	The contact's first name.
string MiddleName	The contact's middle name.
string Title	The contact's job title.
string Greeting	The contact's greeting.
string PrimaryEmail	The contact's primary eMail address.
string AlternateEmail	The contact's alternate eMail address.
string PrimaryTelephone	The contact's primary telephone number.
string AlternateTelephone	The contact's alternate telephone number.
string PrimaryFax	The contact's primary fax number.
string AlternateFax	The contact's alternate fax number.
string Url	The contact's website.
string Notes	The notes for the contact.

ContactOwnerTypesEnum

This object is the Contact Owner Types Enumerator.

Enumerator ContactOwnerTypesEnum
Owner = 1,	Owner
Account = 2,	Account
OwnerTransfer = 3,	OwnerTransfer
Warehouse = 4,	Warehouse
Project = 16	Project

ContactTypesEnum

This object is the Contact Types Enumerator.

Enumerator ContactTypesEnum
Billing = 1,	Billing
Shipping = 2,	Shipping
Operations = 3,	Operations
Residential = 4,	Residential
Commercial = 5	Commercial

ContainerType

This object contains the Container Type object details. It contains the dimensions, weight, and volumes of the shipping containers in Footprint desktop.

object ContainerType
int Id	The index of the container type.
string Name	The name of the container type.
decimal? Length	The length of the container type. Can be empty.
decimal? Width	The width of the container type. Can be empty.
decimal? Height	The height of the container type. Can be empty.
MeasurementUnitEnum? DimensionUom	The unit of measure for the dimensions. For example inches, feet, meter, ect... Can be empty.
decimal? MaxVolume	The maximum volume of the container type might be less than length x width x height. Can be empty.
MeasurementUnitEnum? VolumeUom	The unit of measure for the volume. For example cubic inches, cubic feet, liter, ect... Can be empty.
decimal? MaxWeight	The maximum weight the container can hold. Can be empty.
MeasurementUnitEnum? WeightUom	The unit of measure for the weight. For example pound, ounce, gram, ect... Can be empty.
bool IsCatchAll	Is the container the default. That is if no other could be found then this is proposed as the default

DockAppointment

This object contains the Dock Appointment details.

object DockAppointment
int Id	The index of the Dock Appointment.
string LookupCode	The lookup code of the Dock Appointment.
int StatusId	The index of the Status of the Dock Appointment.
int? ScheduledWarehouseid	The index of the Scheduled Warehouse for the Dock Appointment. Can be empty.
int? ScheduledDoorLocationid	The index of the Scheduled Door Location for the Dock Appointment. Can be empty.
DateTime? ScheduledArrivalDate	The Scheduled Arrival Date for the Dock Appointment. Can be empty.
DateTime? ScheduledDepartureDate	The Scheduled Departure Date for the Dock Appointment. Can be empty.
DateTime? ScheduledOnDate	The Scheduled On Date for the Dock Appointment. Can be empty.
string ScheduledBy	The user that scheduled the Dock Appointment.
int? ActualWarehouseId	The index of the actual Warehouse for the Dock Appointment. Can be empty.
int? ActualDoorLocationid	The index of the actual door for the Dock Appointment. Can be empty.
DateTime? AssignedOnDate	The date the actual door was assigned for the Dock Appointment. Can be empty.
string AssignedBy	The user that assigned the actual Dock Appointment.

EntityStatusChangeInfoBase

object EntityStatusChangeInfoBase
int EntityId	The index of the entity.

EntityTypeEnum

This object is the Entity Type Enumerator.

Enumerator EntityTypeEnum
LocationContainer = 1,	Location Container
Lot = 2,	Lot
VendorLot = 3	Vendor Lot

GlobalMaterial

This object contains the Global Material details.

object GlobalMaterial
int Id	The index of the Global Material.
string Name	The Name of the global material.
string Description	The description of the global material.
bool EligibleForSerialControl	Can the global material be used as a serial material type?
GlobalMaterialTransferOptionEnum TransferOption	The Transfer Option of the global material.
bool? TransferAllAmountFromSourceLicensePlate	Should the global material transfer the entire amount on a license plate instead of given quantities?

GlobalMaterialTransferOptionEnum

This object is the Global Material Transfer Option Enumerator.

Enumerator GlobalMaterialTransferOptionEnum
NoTransfer = 1,	No Transfer
AllowTransferIfNoneFound = 2,	Allow transfer only if no inventory found
AllowTransfer = 3	Allow transfer

HttpRequestMethodEnum

This object is the Http Request Method Enumerator.

Enumerator HttpRequestMethodEnum
POST = 1,	POST
GET = 2,	GET
PATCH = 3,	PATCH

InboundShipmentBillingRequest

This object contains the InboundShipmentBillingRequest details. Derived from BillingRequest

object InboundShipmentBillingRequest
int InboundShipmentId	The index of the Inbound Shipment.
override string Context	The Context of closing the Inbound Shipment .

InspectionRequest

This object contains the Inspection Request details. It is the return form the inspection workflow. It is object that FootPrint will create an inspection from.

object InspectionRequest
int WarehouseId	The index of the Warehouse for the Inspection Request.
int? MaterialId	The index of the material for the Inspection Request. Can be empty.
int? LotId	The index of the Lot for the Inspection Request. Can be empty.
int? LicensePlateId	The index of the license plate for the Inspection Request. Can be empty.
int? LocationId	The index of the location for the Inspection Request. Can be empty.
int OperationCodeId	The index of the operation code for the Inspection Request. Can be empty.
string Notes	The Notes for the Inspection Request. Can be empty.

InspectionTask

This object contains the Inspection Task details.

object InspectionTask
int Id	The index of the Inspection Task.
int WarehouseId	The index of the Warehouse for the Inspection Task.
int StatusId	The index of the Status of the Inspection Task.
int? LotId	The index of the Lot of the Inspection Task. Can be empty.
int? MaterialId	The index of the material of the Inspection Task. Can be empty.
int OperationCodeId	The index of the operation code of the Inspection Task.
string Notes	The notes of the Inspection Task.
int? ShipmentId	The index of the shipment of the Inspection Task. Can be empty.
int? ShipmentLineId	The index of the shipment line of the Inspection Task. Can be empty.
int? OrderId	The index of the order of the Inspection Task. Can be empty.
int? OrderLineNumber	The number of the order line of the Inspection Task. Can be empty.
int? LicensePlateId	The index of the license plate of the Inspection Task. Can be empty.
int? LocationId	The index of the location of the Inspection Task. Can be empty.
bool? InspectionPassed	The result of the inspection task, whether it pass or failed. Can be empty.
TaskStatusEnum Status	The Status of the Inspection Task.

Inventory

This object contains the Inventory details.

object Inventory
Int32? WarehouseId	The index of the Warehouse for the Inventory.
Int32? LocationId	The index of the Location for the Inventory. Can be empty.
Int32? LicensePlateId	The index of the License Plate for the Inventory. Can be empty.
Int32 MaterialId	The index of the Material for the Inventory.
Int32? VendorLotId	The index of the Vendor Lot for the Inventory. Can be empty.
Int32? LotId	The index of the Lot for the Inventory. Can be empty.
DateTime? ExpirationDate	The Expiration Date of the Lot for the Inventory. Can be empty.
Int32 PackagedId	The index of the Packaging for the Inventory.
Decimal? TotalPackagedAmount	The Total Packaged Amount for the Inventory. Can be empty.
Decimal? TotalAmount	The Total Amount in base packaging for the Inventory. Can be empty.
Decimal? ActivePackagedAmount	The Active Packaged Amount for the Inventory. Can be empty.
Decimal? ActiveAmount	The Active Amount in base packaging for the Inventory. Can be empty.
Decimal? InactivePackagedAmount	The Inactive Packaged Amount for the Inventory. Can be empty.
Decimal? InactiveAmount	The Inactive Amount in base packaging for the Inventory. Can be empty.
Decimal? IncomingPackagedAmount	The Incoming Packaged Amount for the Inventory. That is all inventory from processed inbound orders. Can be empty.
Decimal? IncomingAmount	The Incoming Amount in base packaging for the Inventory. That is all inventory from processed inbound orders. Can be empty.
Int32? LicensePlateStatusId	The index of the status of the License Plate for the Inventory. Can be empty.
Int32? LotStatusId	The index of the status of the Lot for the Inventory. Can be empty.
Int32 MaterialStatusId	The index of the status of the material for the Inventory. Can be empty.
Int32 MaterialGlobalMaterialId	The index of the global material of the material referenced in the Inventory. Can be empty.
Int32? LocationStatusId	The index of the status of the Location for the Inventory. Can be empty.
Decimal? AllocatedPackagedAmount	The Allocated Packaged Amount for the Inventory. Can be empty.
Decimal? AllocatedAmount	The Allocated Amount in base packaging for the Inventory. Can be empty.
Decimal? SoftAllocatedPackagedAmount	The Soft Allocated Packaged Amount for the Inventory. Can be empty.
Decimal? SoftAllocatedAmount	The Soft Allocated Amount in base packaging for the Inventory. Can be empty.
Decimal? SoftIncomingPackagedAmount	The Soft Incoming Packaged Amount for the Inventory. That is all inventory from created inbound orders. Can be empty.
Decimal? SoftIncomingAmount	The Soft Incoming Amount in base packaging for the Inventory. That is all inventory from processed inbound orders. Can be empty.
Decimal? AvailablePackagedAmount	The Available Packaged Amount for the Inventory. Can be empty.
Decimal? AvailableAmount	The Available Amount in base packaging for the Inventory. Can be empty
Decimal? CurrentlyAvailablePackagedAmount	The Currently Available Packaged Amount for the Inventory. Can be empty.
Decimal? CurrentlyAvailableAmount	The Currently Available Amount in base packaging for the Inventory. Can be empty.
Boolean IsNew	Is this new Inventory.
DateTime? LicensePlateCreateDate	The Create Date of the License Plate for the Inventory. Can be empty.
Object Tag	The Tag of the Material for the Inventory.
Boolean SuppressEntityEvents	Suppress the events for the Inventory.

InventoryAggregationEnum

This object is the Inventory Aggregation Enumerator.

Enumerator InventoryAggregationEnum
Lot = 0,	Lot
Material = 1,	Material
LocationLot = 2,	Location Lot
LocationMaterial = 3,	Location Material
LicensePlateLot = 4,	License Plate Lot
LicensePlateMaterial = 5	License Plate Material

InventoryDetail

This object contains the Inventory Details. Returned from the inventory ledger activity.

object InventoryDetail
int? WarehouseId	The index of the Warehouse for the Inventory detail. Can be Empty.
int? LocationId	The index of the Location for the Inventory detail. Can be empty based on context of call.
int? LicensePlateId	The index of the License Plate for the Inventory detail. Can be empty based on context of call.
int MaterialId	The index of the Material for the Inventory detail.
int? VendorLotId	The index of the Vendor Lot for the Inventory detail. Can be empty based on context of call.
int? LotId	The index of the Lot for the Inventory detail. Can be empty based on context of call.
int PackagedId	The index of the Packaging for the Inventory detail.
decimal? TotalPackagedAmount	The Total Packaged Amount for the Inventory detail. Can be empty based on context of call.
decimal? TotalAmount	The Total Amount in base package for the Inventory detail. Can be empty based on context of call.
decimal? ActivePackagedAmount	The Active Amount Packaged for the Inventory detail. Can be empty based on context of call.
decimal? ActiveAmount	The Active Amount in base package for the Inventory detail. Can be empty based on context of call.
decimal?InactivePackagedAmount	The Inactive Packaged Amount for the Inventory detail. Can be empty based on context of call.
decimal? InactiveAmount	The Inactive Amount in base package for the Inventory detail. Can be empty based on context of call.
decimal? IncomingPackagedAmount	The Incoming Packaged Amount for the Inventory detail. Based on processed inbound orders. Can be empty based on context of call.
decimal? IncomingAmount	The Incoming Amount in base package for the Inventory detail. Based on processed inbound orders. Can be empty based on context of call.
int? LicensePlateStatusId	The index of the status of the License Plate for the Inventory detail. Can be empty.
int? LotStatusId	The index of the status of the Lot for the Inventory detail. Can be empty.
int MaterialStatusId	The index of the status of the material for the Inventory detail. Can be empty.
int? LocationStatusId	The index of the status of the Location for the Inventory detail. Can be empty.
decimal? AllocatedPackagedAmount	The Allocated Packaged Amount for the Inventory detail. Can be empty based on context of call.
decimal? AllocatedAmount	The Allocated Amount in base package for the Inventory detail. Can be empty based on context of call.
decimal? SoftAllocatedPackagedAmount	The Soft Allocated Packaged Amount for the Inventory detail. Can be empty based on context of call.
decimal? SoftAllocatedAmount	The Soft Allocated Amount in base package for the Inventory detail. Can be empty based on context of call.
decimal? SoftIncomingPackagedAmount	The Soft Incoming Packaged Amount for the Inventory detail. Can be empty based on context of call.
decimal? SoftIncomingAmount	The Soft Incoming Amount in base package for the Inventory detail. Can be empty based on context of call.
decimal? AvailablePackagedAmount	The Available Packaged Amount for the Inventory detail. Can be empty based on context of call.
decimal? AvailableAmount	The Available Amount in base package for the Inventory detail. Can be empty based on context of call.
decimal? CurrentlyAvailablePackagedAmount	The Currently Available Packaged Amount for the Inventory detail. Can be empty based on context of call.
decimal? CurrentlyAvailableAmount	The Currently Available Amount in base package for the Inventory detail. Can be empty based on context of call.
string PackagingName	The Name of the Packaging in the Inventory detail.
string PackagingShortName	The short name of the Packaging in the Inventory detail.
string LicensePlateLookupCode	The License Plate Lookup Code where the Inventory detail is on.
DateTime LicensePlateCreateDate	The Create Date of License Plate where the Inventory detail is on.
string LocationName	The Location name of the Inventory detail.
string LocationShortName	The location's short name of the Inventory detail.
bool LocationEligibleForAllocation	The location's flag indicating that it is Eligible For Allocation of the Inventory detail.
bool IsLooseLocation	The location's flag indicating that it is loose bin like type.
Int64? GlobalAllocationSequence	The Location Global Allocation Sequence number of the Inventory detail.
Int64? GlobalPickSequence	The Location Global Pick Sequence number of the Inventory detail.
Int64? GlobalPutAwaySequence	The Location Global putaway Sequence number of the Inventory detail.
string LotLookupCode	The Lot lookup code.
string VendorLotLookupCode	The vendor Lot lookup code.
string VendorLotVat	The vat detail of the vendor lot.
string LotNotes	The notes of the Lot.
string LotDescription	The Lot description.
string VendorLotNotes	The notes of the vendor Lot.
string VendorLotDescription	The vendor Lot description of the Inventory detail.
DateTime LotCreateDate	The creation date of the Lot.
DateTime? LotRecieveDate	The date when the Lot was first recieved.
DateTime LotManufactureDate	The date when the Lot was manufactured.
DateTime LotExpirationDate	The date when the Lot will expire.
int GlobalMaterialId	The index of the global material of the material referenced in the Inventory detail. Can be empty.
string GlobalMaterialName	The name of the global material of the material referenced in the Inventory detail. Can be empty.
int MaterialGroupId	The index of the material group of the material referenced in the Inventory detail. Can be empty.
string MaterialLookupCode	The lookup code of material referenced in the Inventory detail. Can be empty.
string MaterialDescription	The description of material referenced in the Inventory detail. Can be empty.
string MaterialName	The name of material referenced in the Inventory detail. Can be empty.
bool IsFixedWeight	Does the material have a fixed weight or does it vary for item to item?
int? ProjectId	The index of the project referenced in the Inventory detail. Can be empty.
string ProjectName	The name of the project referenced in the Inventory detail. Can be empty if the index is empty.
string ProjectLookupCode	The lookup code of the project referenced in the Inventory detail. Can be empty if the index is empty.
int OwnerId	The index of the Owner referenced in the Inventory detail.
string OwnerName	The name of the owner referenced in the Inventory detail.
string OwnerLookupCode	The lookup code of the owner referenced in the Inventory detail.
string WarehouseName	The name of the warehouse referenced in the Inventory detail.
decimal MaterialPackagingGrossWeight	The gross weight of the material in its packaged form referenced in the Inventory detail.
decimal MaterialPackagingNetWeight	The net weight of the material in its packaged form referenced in the Inventory detail.
int MaterialPackagingWeightUom	The index of weight unit of measure of the material in its packaged form referenced in the Inventory detail.
string MaterialPackagingWeightUomName	The name of weight unit of measure of the material in its packaged form referenced in the Inventory detail.
string MaterialPackagingWeightUomShortName	The short name of weight unit of measure of the material in its packaged form referenced in the Inventory detail.
decimal MaterialPackagingVolume	The volume of the material in its packaged form referenced in the Inventory detail.
int MaterialPackagingVolumeUom	The index of volume unit of measure of the material in its packaged form referenced in the Inventory detail.
string MaterialPackagingVolumeUomName	The name of volume unit of measure of the material in its packaged form referenced in the Inventory detail.
string MaterialPackagingVolumeUomShortName	The short name of volume unit of measure of the material in its packaged form referenced in the Inventory detail.

InventoryQuantity

This object contains the Inventory Quantity. A quatity is consider a material, package and amount.

object InventoryQuantity
InventoryQuantity(int materialId, int packagingId)	Constructor for the InventoryQuantity. Given the index of the material and index of the packaging.
int MaterialId	The index of the Material.
int PackagingId	The index of the Packaging.
decimal PackagedAmount	The Packaged Amount of the material.
decimal BaseAmount	The Amount of the material reduced to base packaging.

InventoryStatusChangeRequest

This object contains the Inventory Status Change Request. this object is uses in the inventory status change workflow.

object InventoryStatusChangeRequest
InventoryTypeEnum InventoryType	The inventory type
int? LotId	The index of the Lot for the Inventory. Can be empty.
int? LicensePlateId	The index of the License Plate for the Inventory. Can be empty.
int? MaterialId	The index of the Material for the Inventory. Can be empty.
int? LocationId	The index of the Location for the Inventory. Can be empty.
int? SerialNumberId	The index of the serial number for the Inventory. Can be empty.
int DesiredStatusId	The index of the desired status for the Inventory to be changed to.
List<int> ReasonCodeIds	The list of the reason code indexes to apply to the Inventory to be changed to.
string Notes	The notes for the Inventory change.
List<int> ReasonCodeIdsToAdd	The list of the reason code indexes to add to the existing Inventory status.
List<int> ReasonCodeIdsToRemove	The list of the reason code indexes to remove to the existing Inventory status.
bool ClearAllReasonCodes	Flag to indicate to Inventory status change to clear all the reason codes.

InventoryTypeEnum

This object is the Inventory Type Enumerator.

Enumerator InventoryTypeEnum
Lot,	Lot
Material,	Material
LicensePlate,	License Plate
Location,	Location
SerialNumber	Serial Number

InventoryStatusEnum

This object is the Inventory Status Enumerator.

Enumerator InventoryStatusEnum
Active = 1,	Active
Hold = 2,	Hold
Discontinued = 3,	Discontinued
Damaged = 4	Damaged

LicensePlate

This object contains the License Plate.

object LicensePlate
int Id	The index of the License Plate.
int WarehouseId	The index of the Warehouse for the License Plate.
int LocationId	The index of the Location for the License Plate.
int TypeId	The index of the Type for the License Plate.
int StatusId	The index of the Status for the License Plate.
string LookupCode	The lookup code for the License Plate.
decimal? NetWeight	The net weight for the License Plate. It is the sum of all net weights of all materials of the plate. It can be Empty.
decimal? GrossWeight	The gross weight for the License Plate. It is the sum of all gross weights of all materials of the plate. It can be Empty.
int? WeightUom	The index of weight unit of measure for the License Plate. It can be Empty.
decimal? Length	The length for the License Plate. This has no relationship to the materials that are on the plate. It can be Empty.
decimal? Width	The Width for the License Plate. This has no relationship to the materials that are on the plate. It can be Empty.
decimal? Height	The Height for the License Plate. This has no relationship to the materials that are on the plate. It can be Empty.
int? DimensionsUom	The index of dimension unit of measure for the License Plate. It can be Empty.
int? ShipmentId	The index of the shipment for the License Plate. If this has a value it indicates that this is a shipping plate
bool Archived	Is the License Plate Archived? If this has a value it indicates that it has been shipped or has been deleted
List<LicensePlateContent> LicensePlateContents	The list of contents of the License Plate. see LicensePlateContents object.
InventoryStatusEnum Status	The status of the License Plate.
DateTime CreatedSysDateTime	The date the License Plate was created.
decimal? NetVolume	The net volume for the License Plate. It is the sum of all net volume of all materials of the plate. It can be Empty.
decimal? GrossVolume	The gross volume for the License Plate. It is the sum of all gross volume of all materials of the plate. It can be Empty.
int? VolumeUOM	The index of volume unit of measure for the License Plate. It can be Empty.
int? LicensePlateContainerTypeId	The index of container type for the License Plate. It can be Empty if never assigned in the desktop.

LicensePlateContent

This object contains the License Plate Content.

object LicensePlateContent
int LicensePlateId	The index of the License Plate.
int LotId	The index of the Lot.
int MaterialId	The index of the Material.
int PackagedId	The index of the packaging.
decimal PackagedAmount	The packaged amount.
DateTime? LicensePlateContentExpirationDate	The expiration date of the lot but this is the value that might be accelerated by the location of the license plate. If this is empty then the lot expiration should be used.
DateTime FirstTimeLotReceivedOnLicensePlateDate	The First Time this Lot has been Received On this LicensePlate.

LicensePlateNotFoundContextEnum

License plate not found context.

Enumerator LicensePlateNotFoundContextEnum
MobileLpMoveLookup = 1,
MobileAdjustInventoryLpLookup = 2

LicensePlateRequest

This object contains the License Plate Request. Used to pass information to the allocation workflow

object LicensePlateRequest
string LookupCode	The lookup code of the License Plate.
int LicensePlateId	The index of the License Plate.
List<SerialNumberRequest> SerialRequests	The license plate container type Id.
int? LicensePlateContainerTypeId	The license plate container type Id.
int? LicensePlateStatusId	The license plate status Id.

LocatedQuantity

This object contains the Located Quantity.

object LocatedQuantity
int LocationId	The index of the location.
InventoryQuantity Quantity	The quantity in the location. see InventoryQuantity object.
LocatedQuantity(int locationId, InventoryQuantity quantity)	Constructor for the LocatedQuantity. Given the index of the location and inventory quantity.

Location

This object contains the definition of a location.

object Location
int Id	The index of the location.
int WarehouseId	The index of the Warehouse for the location.
int StatusId	The index of the status of the location.
int TypeId	The index of the type of the location.
string Name	The name of the location.
string ShortName	The short name of the location.
long? GlobalPutawaySequence	The Global Putaway Sequence number of the location. Can be empty.
bool SkipValidationRules	A flag on the location to indicate that it should ignore volume and weight restrictions
int? ParentId	The index of the location that this given location is contained within.
List<LicensePlate> LicensePlates	The list of license plates that are within this location. See LicensePlates object.
InventoryStatusEnum Status	The status of the location.

LocationTypeEnum

This object is the Location Type Enumerator.

Enumerator LocationTypeEnum
Zone = 1,	Zone
Area = 2,	Area
Inventory = 3,	Inventory
Equipment = 4,	Equipment
DockDoor = 5,	Dock Door
YardLocation = 6	Yard Location

Lot

This object contains the definition of a Lot.

object Lot
int Id	The index of the lot.
int MaterialId	The index of the material.
int TypeId	The index of the type.
int VendorLotId	The index of the vendor lot.
int StatusId	The index of the status of the lot.
string LookupCode	The lookup code of the lot.
string Description	The description of the lot.
DateTime? CreateDate	The date the lot was created. Can be Empty
DateTime? ReceiveDate	The date the lot was first receive. Can be Empty
DateTime? LastReceiveDate	The date the lot was last received. Can be Empty
DateTime? VendorManufactureDate	The date the lot was manufactured. Can be Empty
DateTime? VendorExpirationDate	The date when the lot will expire. Can be Empty
int GlobalMaterialId	The index of the global material of the material referenced in the lot. Can be empty.
int? ProjectId	The index of the project referenced in the lot. Can be empty.
string MaterialLookupCode	The lookup code of material referenced in the lot. Can be empty.
bool IsFixedWeight	Does the material have a fixed weight or does it vary for item to item?
int ControllerTypeId	The index of the controller type for the material referenced in the lot. Can be empty.
int MaterialStatusId	The index of the status of material referenced in the lot. Can be empty.
int MaterialGroupId	The index of the material group of the material referenced in the lot. Can be empty.
string MaterialName	The name of material referenced in the lot. Can be empty.
string MaterialDescription	The description of material referenced in the lot. Can be empty.
string LotControllerTypeName	The name of the controller type for the material referenced in the lot. Can be empty.
string GlobalMaterialName	The name of the global material for the material referenced in the lot. Can be empty.
string MaterialTypeName	The type for the material referenced in the lot. Can be empty.
string ProjectName	The name of the project referenced in the lot. Can be empty.
string ProjectLookupCode	The lookup code of the project referenced in the lot. Can be empty.
int OwnerId	The index of the owner referenced in the lot. Can be empty.
string OwnerName	The name of the owner referenced in the lot. Can be empty.
string OwnerLookupCode	The lookup code of the owner referenced in the lot. Can be empty.
string VendorLotLookupCode	The lookup code of the vendor lot referenced in the lot.
string VendorLotDescription	The description of the vendor lot referenced in the lot.
string VendorLotNotes	The note of the vendor lot referenced in the lot. Can be empty.
string VendorLotVat	The vat details of the vendor lot referenced in the lot. Can be empty.
bool HasInventory	Is there any inventory in the warehouse for this lot?
InventoryStatusEnum Status	The status of the lot.

LotInventoryQuantity

This object contains the Lot Inventory Quantity. This is the amount of inventory for a specific lot

object LotInventoryQuantity
Lot	The lot of the specific Lot Inventory Quantity. see the Lot object.
InventoryQuantity Quantity	The quantity of the specific Lot Inventory Quantity. See the InventoryQuantity object.

ManufacturingEquipment

This object contains the Manufacturing Equipment details.

object ManufacturingEquipment
int Id	The index of the Manufacturing Equipment.
string Type	The type of the Manufacturing Equipment.
string Name	The name of the Manufacturing Equipment.
string Code	The code of the Manufacturing Equipment.

ManufacturingOrder

This object contains the Manufacturing Order details.

object ManufacturingOrder
int Id	The index of the Manufacturing Order.
string LookupCode	The Lookup Code of the Manufacturing Order.

ManufacturingOrderLine

This object contains the Manufacturing Order line.

object ManufacturingOrderLine
int Id	The index of the Manufacturing Order line.
int? ParentId	The index of the parent Manufacturing Order line. If this is empty then it has no parent.
int? FinishedGoodLineId	The index of the Finish good line this is a component of.
int OrderId	The index of the Manufacturing Order.
int OrderLineTypeId	The index of the Order line type.
int StatusId	The index of the status on the Order line.
int LineNumber	The line number.
string ReferenceNumber	The reference number.
int MaterialId	The index of the material.
int PackagingId	The index of the packaging.
decimal PackagedAmount	The packaged amount.
decimal Amount	The amount in base packaging.
int? VendorLotId	The index of the vendor lot.
int? LotId	The index of the lot.
int? WaveId	The index of the wave.
string Notes	The notes on the Order line.
int? StagingLocationId	The index of the staging location.
bool? ProcessInSinglePickSlip	Should the Order line be processed in a single pick slip?
int? ManufacturingLocationId	The index of the manufacturing location.
decimal? ExpectedThroughput	The expected throughout on the Order line.
decimal? CrewComplement	The crew complement on the Order line.
bool? AllowFractions	Should the Order line allow fraction of items?

ManufacturingOrderLineStatusEnum

This object is the Manufacturing Order Line Status Enumerator.

Enumerator ManufacturingOrderLineStatusEnum
Created = 1,	Created
Canceled = 2,	Canceled
Batching = 3,	Batching
Reserved = 4,	Reserved
Processing = 5,	Processing
Incoming = 6	Incoming

ManufacturingOrderLineTypeEnum

This object is the Manufacturing Order Line Type Enumerator.

Enumerator ManufacturingOrderLineTypeEnum
FinishedGood = 1,	Finished Good
Component = 2,	Component
WorkInProgress = 3	Work In Progress

MatchingOptionEnum

This object is the Matching Option Enumerator.

Enumerator MatchingOptionEnum
Any = 0,	Any
Exact = 1,	Exact
Subset = 2	Subset

Material

This object contains the Material details.

object Material
int Id	The index of the Material.
int ProjectId	The index of the project for the Material.
int StatusId	The index of the status for the Material.
int MaterialGroupId	The index of the Material Group for the Material.
string MaterialGroupName	The name of the Material Group for the Material.
string Name	The name of the Material.
string LookupCode	The lookup code of the Material.
bool? IsWip	Is this Material a work in progress? That is it is not a final product but an intermediate material.
bool? FinishedGoodMaterial	Is this Material Finished product? That is it is final product of a manufacturing process.
MaterialControllerTypeEnum ControllerType	The Controller Type of the Material.
AllocationStrategyEnum? AllocationStrategy	The Lot Allocation Strategy of the Material.
PackageAllocationStrategyEnum PackageAllocationStrategy	The Package Allocation Strategy of the Material.
Guid? AllocationStrategyWorkflowId	The index of the Allocation Strategy Workflow for the Material. This take precident over the hardcore choices
int GlobalMaterialId	The index of the Global Material for the Material.
long? ShelfLifeSpan	The Shelf Life Span in days of the Material.
long? MinimumDatingSpan	The Minimum Dating Span of the Material.
int? ReallocationExpirationDateWindow	The Reallocation Expiration Date Window in days of the Material.
decimal? StandardUnitsPerHour	The Standard Units of this material produced per Hour when it is been manufactured.
decimal? HoursAllowedInAmbient	The Hours Allowed for this material to be In Ambient temperature locations.
bool AutopopulateVendorLot	Should this Material Auto populate Vendor Lot code when a new lot is create?
bool AutopopulateLot	Should this Material Auto populate Lot code when a new lot is create?
bool IsFixedWeight	Is this Material of fixed weight?
bool IsFixedLength	Is this Material of fixed length?
bool IsFixedVolume	Is this Material of fixed volume?
InventoryStatusEnum Status	The status of the Material.

MaterialAccount

This object contains the Material Account details. It is on the account tab of the material screen.

object MaterialAccount
int MaterialId	The index of the Material.
int AccountId	The index of the Account.
string AccountLookupCode	The lookup code of the Account.
string MaterialLookupCode	The lookup code of the Material.
string MaterialAliasLookupCode	The aliased lookup code of the Material.
string MaterialAliasName	The aliased name of the Material.
string MaterialAliasDescription	The aliased description of the Material.
decimal SalesOrderDiscount	The discount for this account for the given Material.

MaterialControllerTypeEnum

This object is the Material Controller Type Enumerator.

Enumerator MaterialControllerTypeEnum
MaterialLot = 1,	Material Lot
Lots = 2,	Lots
MaterialLotSerial = 3,	Material Lot Serial
LotsSerial = 4	Lots Serial

MaterialSubstitution

This object contains the Material Substitution details. It is on the Substitution tab of the material screen.

object MaterialSubstitution
int Id	The index of the Material Substitution.
int MaterialId	The index of the Material.
int PackagingId	The index of the Packaging.
int SubstitutionMaterialId	The index of the Substitution Material. That is what this current material can be replaced with.
int SubstitutionPackagingId	The index of the Substitution Material packaging. That is what this current material can be replaced with.
int? Priority	The priority order in which Substitution should take place.
decimal Ratio	The ratio in which Substitution should take place.

MaterialTransfer

The lookup code of the Material Transfer.

object MaterialTransfer
int Id	The index of the Material Transfer.
string LookupCode	The lookup code of the Material Transfer.
int SourceProjectId	The index of the Source Project in Material Transfer.
int TargetProjectId	The index of the Target Project in Material Transfer.
int SourceOrderId	The index of the Source Order in Material Transfer.
int TargetOrderId	The index of the Source Order in Material Transfer.

MeasurementUnitEnum

This object is the Measurement Unit Enumerator.

Enumerator MeasurementUnitEnum
Unit = 1,	Unit
Meter = 2,	Meter
Centimeter = 3,	Centimeter
Foot = 4,	Foot
Inch = 5,	Inch
Cubic_Meter = 6,	Cubic Meter
Cubic_Centimeter = 7,	Cubic Centimeter
Cubic_Feet = 8,	Cubic Feet
Cubic_Inch = 11,	Cubic Inch
Kilogram = 12,	Kilogram
Gram = 13,	Gram
Pound = 14,	Pound
Ounce = 15,	Ounce
Fahrenheit = 16,	Fahrenheit
Celsius = 17,	Celsius
Currency = 18,	Currency
Ton = 19,	Ton
Troy_Ounce = 20,	Troy Ounce
Metric_Ton = 21,	Metric Ton
Liter = 22,	Liter
Milliliter = 23,	Milliliter
Gallon = 24,	Gallon

OperationCode

This object contains the Operation Code details.

object OperationCode
int Id	The index of the Operation Code.
string SystemLabel	The system label of the Operation Code.
string Name	The name of the Operation Code.
OperationTypeEnum OperationType	The index of Operation Type for the Operation Code.
bool SystemDefined	Is this a user defined or a system Operation Code.

OperationCodeEnum

This object is the Operation Code Enumerator.

Enumerator OperationCodeEnum
InventoryAdjustment = 1,	Inventory Adjustment
Receiving = 2,	Receiving
PutAway = 3,	PutAway
LoadContainerTemperatureCapture = 4,	Load Container Temperature Capture
LicensePlateMove = 5,	License Plate Move
LicensePlateAdjustment = 6,	License Plate Adjustment
InventoryCreation = 7,	Inventory Creation
Picking = 8,	Picking
PackingInventory = 9,	Packing Inventory
ShipmentConfirmation = 10,	Shipment Confirmation
ObsoleteOwnerTransferPick = 11,	Obsolete Owner Transfer Pick
ObsoleteSerializedLPMove = 12,	Obsolete Serialized LP Move
InventoryMove = 14,	Inventory Move
ObsoleteOwnerTransferSerializedLPMove = 15,	Obsolete Owner Transfer Serialized LP Move
InventoryInspectionMove = 16,	Inventory Inspection Move
SerialNumberCreation = 17,	Serial Number Creation
SerialNumberMove = 18,	Serial Number Move
SerialNumberPurge = 19,	Serial Number Purge
ObsoleteSerializedInventoryMove = 20,	Obsolete Serialized Inventory Move
ObsoleteOwnerTransferSerializedMove = 21,	Obsolete Owner Transfer Serialized Move
SerialNumberModification = 22,	Serial Number Modification
ManualPickAllocation = 23,	Manual Pick Allocation
ShipmentLoading = 24,	Shipment Loading
UnPickLicensePlate = 25,	UnPick License Plate
UnPickInventory = 26,	UnPick Inventory
SerialNumberShipOut = 27,	Serial Number Ship Out
DefaultStorageOperationCode = 28,	Default Storage Operation Code
AutomaticPick = 29,	Automatic Pick
MeasurementSampling = 30,	Measurement Sampling
AutomaticCompositePick = 31,	Automatic Composite Pick
SealConfirmation = 32,	Seal Confirmation
LicensePlateStatusChange = 33,	License Plate Status Change
LocationStatusChange = 34,	Location Status Change
LotStatusChange = 35,	Lot Status Change
MaterialStatusChange = 36,	Material Status Change
ReceiveTransLoad = 37,	Receive Trans Load
PhyscialCount = 38,	Physical Count
BatchMove = 39,	Batch Move
ProductionInput = 40,	Production Input
ProductionOutput = 41,	Production Output
ProductionScrap = 42,	Production Scrap
PickDrop = 44,	Pick Drop
ShipmentLineWeightUpdate = 45,	Shipment Line Weight Update
SerialNumberWeightVolumeUpdate = 46,	Serial Number Weight Volume Update
ManufacturingComponentConsumed = 47,	Manufacturing Component Consumed
ManufacturingComponentScrapped = 48,	Manufacturing Component Scrapped
ManufacturingFinishedGoodCreated = 49,	Manufacturing Finished Good Created
ReasonCodeAdded = 50,	Reason Code Added
RemoveReasonCode = 51,	Remove Reason Code
AcceleratedExpiration = 53,	Accelerated Expiration
AcceleratedExpirationOverride = 54,	Accelerated Expiration Override
ManufacturingFeedback = 55,	Manufacturing Feedback
Replenishment = 57,	Replenishment
InventoryCount = 58,	Inventory Count
InventoryRecount = 59,	Inventory Recount
ManufacturingFinishedGoodReworked = 60,	Manufacturing Finished Good Reworked
ManufacturingComponentReworked = 61,	Manufacturing Component Reworked
ManufacturingRework = 62,	Manufacturing Rework
ManufacturingOrderWait = 63,	Manufacturing Order Wait
ManufacturingOrderReady = 64,	Manufacturing Order Ready
ManufacturingOrderCanceled = 65,	Manufacturing Order Canceled
ManufacturingOrderProcessing = 66,	Manufacturing Order Processing
ManufacturingOrderCompleted = 67,	Manufacturing Order Completed
ManufacturingOrderReopened = 68,	Manufacturing Order Reopened
VendorLotExpirationOverride = 69,	Vendor Lot Expiration Override
ManufacturingOrderBackorder = 70,	Manufacturing Order Backorder
ManualBatchAllocation = 71,	Manual Batch Allocation
ManufacturingInventoryMove = 72,	Manufacturing Inventory Move
CreateOrder = 73,	Create Order
AddOrderLine = 74,	Add Order Line
AddClaim = 75,	Add Claim
CreateManufacturingWave=76,	Create Manufacturing Wave
Annotate=77,	Annotate
MissingLicensePlateNotification=78,	Missing License Plate Notification
LicensePlatePick =79,	License Plate Pick
SerialNumberValidated=80,	Serial Number Validated
ScaleTicketCreated=81,	Scale Ticket Created
EmptyWeightCaptured=82,	Empty Weight Captured
LoadedWeightCaptured=83,	Loaded Weight Captured
ScaleTicketPrinted = 84,	Scale Ticket Printed
IncorrectLoadingCountNotification = 85,	Incorrect Loading Count Notification
LicensePlateValidated = 86,	License Plate Validated
LicensePlateNotValidated = 87,	License Plate Not Validated
CLPValidationLicensePlateMove = 88,	CLP Validation License Plate Move
ManufacturingLicensePlateMove = 89,	Manufacturing License Plate Move
ManufacturingInventoryMoveNotification = 90,	Manufacturing Inventory Move Notification
ReplenishmentNotification = 91,	Replenishment Notification
PickingNotification = 92,	Picking Notification
LicensePlatePickNotification = 93,	License Plate Pick Notification
ReplenishmentLicensePlateMove = 94,	Replenishment License Plate Move
ReturnToStockSession = 95,	Return To Stock Session
ReturnToStockCount = 96,	Return To Stock Count
ReturnToStockReconciliation = 97,	Return To Stock Reconciliation
ReturnToStockInventoryAdjustment = 98,	Return To Stock Inventory Adjustment
ReturnToStockInventoryCreation = 99,	Return To Stock Inventory Creation
LicensePlateInvalid = 100,	License Plate Invalid
InvalidLPSerialNumbersCount = 101,	Invalid LP Serial Numbers Count
SerialNumbersCountValidated = 102,	Serial Numbers Count Validated
InvalidSerialNumberOnLP = 103,	Invalid Serial Number On LP
UnblockLpSerialNumberValidation = 104,	Unblock Lp Serial Number Validation
InventoryPackagingConversion = 105,	Inventory Packaging Conversion
WeightVerificationSucceeded = 106,	Weight Verification Succeeded
WeightVerificationFailed = 107,	Weight Verification Failed
IncorrectPutawayCountNotification = 108,	Incorrect Putaway Count Notification
CorrectPutawayCountNotification = 109,	Correct Putaway Count Notification
PackingShippingLicensePlate = 110,	Packing Shipping License Plate
PackingShippingContainer = 111,	Packing Shipping Container
InventoryBlindCount = 112,	Inventory Blind Count
InboundShipmentCancellation = 113,	Inbound Shipment Cancellation
OutboundShipmentCancellation = 114,	Outbound Shipment Cancellation
SerialNumberStatusChange = 115,	Serial Number Status Change
ShipmentLineVolumeUpdate = 118	Shipment Line Volume Update

OperationTypeEnum

This object is the Operation type Enumerator.

Enumerator OperationTypeEnum
Accelerated_Expiration_of_Inventory = 30,	Accelerated Expiration of Inventory
AccessorialCharges = 15,	Accessorial Charges
Adjust = 1,	Adjust
BatchMove = 22,	Batch Move
CLPValidation = 40,	CLP Validation
Custom = 46,	Custom
InboundShipmentCancellation = 44,	Inbound Shipment Cancellation
Inspection = 29,	Inspection
InventoryCount = 32,	Inventory Count
InventoryMove = 9,	Inventory Move
InventoryPackagingConversion = 42,	Inventory Packaging Conversion
InventoryPlanning = 35,	Inventory Planning
InventoryStatusChange = 19,	Inventory Status Change
LicensePlateChange = 17,	License Plate Change
LicensePlateMove = 5,	License Plate Move
ManualAllocation = 11,	Manual Allocation
Manufacturing = 27,	Manufacturing
Manufacturing_Scrap = 33,	Manufacturing Scrap
Manufacturing_WIP = 31,	Manufacturing Work In Progress
MeasurementSampling = 16,	Measurement Sampling
Notification = 37,	Notification
OutboundShipmentCancellation = 45,	Outbound Shipment Cancellation
Pack = 7,	Pack
PhysicalCount = 21,	Physical Count
Pick = 6,	Pick
PickDrop = 24,	Pick Drop
Production = 23,	Production
PutAway = 3,	PutAway
ReasonCode = 28,	Reason Code
Receive = 2,	Receive
ReturnToStock = 41,	Return To Stock
ScaleTicketing = 39,	Scale Ticketing
SealConfirmation = 18,	Seal Confirmation
SerialNumberOperation = 10,	Serial Number Operation
SerialNumberValidation = 38,	Serial Number Validation
SerialNumberWeightVolumeUpdate = 26,	Serial Number Weight or Volume Update
ShipConfirm = 8,	Ship Confirm
ShipmentLineWeightUpdate = 25,	Shipment Line Weight Update
ShipmentLoad = 12,	Shipment Load
StorageBilling = 14,	Storage Billing
Task_Annotation = 36,	Task Annotation
TemperatureCapture = 4,	Temperature Capture
TransLoadReceive = 20,	Trans Load Receive
UnPick = 13,	UnPick
VendorLotExpirationOverride = 34,	Vendor Lot Expiration Override
WeightVerification = 43,	Weight Verification
ShipmentLineVolumeUpdate = 48	Shipment Line Volume Update

Order

This object contains the Order details.

object Order
int Id	The index of the Order.
int OrderClassId	The index Order Class for the Order.
string CreatedBy	The User that Created the Order.
int StatusId	The index of the status for the Order.
int ProjectId	The index of project for the Order.
DateTime CreationDate	The date the Order was created.
string LookupCode	The lookup code of the Order.
int? AccountId	The index of the account for the Order.
int? ContactId	The index of the contact for the Order.
string AccountName	The account name for the Order.
int? PreferredCarrierId	The index of the Preferred Carrier for the Order.
string PreferredCarrierName	The name of the Preferred Carrier for the Order.
string OwnerReference	The owner reference for the Order.
string Notes	The notes for the Order.
int? MasterOrderId	The index of the master order that contains the Order.
DateTime? RequestedDeliveryDate	The Requested Delivery Date for the Order.
OrderStatusEnum Status	The status of the Order.

OrderClass

This object contains the Order Class details.

object OrderClass
int Id	The index of the Order Class.
string LookupCode	The lookup code of the Order Class.
OrderTypeEnum OrderType	The Order Type of the Order Class.
OrderClassTypeEnum OrderClassType	The Order Class Type of the Order Class.
bool AllowInactiveInventory	Does the order class Allow Inactive Inventory to be used?
bool PickToClean	Does the order class Pick To Clean to be used?
bool AllowOverPick	Does the order class Allow Over Pick to be used?
bool AllowReversePick	Does the order class Allow Reverse Pick to be used?
bool RequireSerialValidationForShipping	Does the order class Require Serial Validation For Shipping?
bool BypassSoftAllocationCheck	Does the order class Bypass Soft Allocation Check?
bool RequireItemsCountForSerialValidation	Does the order class Require Items Count For Serial Validation?
bool RequirePutAwayCount	Does the order class Require PutAway Count?
bool AllowAllocationAgainstIncoming	Does the order class Allow Allocation Against Incoming?
bool? BuiltToOrder	Does the order class Built To Order to be used?
bool AllowLotOverride	Does the order class Allow Lot Override?

OrderClassTypeEnum

This object is the order class type Enumerator.

Enumerator OrderClassTypeEnum
PurchaseOrder = 1,	Purchase Order
InboundTransfer = 2,	Inbound Transfer
CustomerReturn = 3,	Customer Return
BlindPurchaseOrder = 4,	Blind Purchase Order
SalesOrder = 5,	Sales Order
TransferOut = 6,	Transfer Out
ReturnToVendor = 7,	Return To Vendor
InboundOwnerTransfer = 8,	Inbound Owner Transfer
OutboundOwnerTransfer = 9,	Outbound Owner Transfer
InboundTransLoad = 10,	Inbound TransLoad
OutboundTransLoad = 11,	Outbound TransLoad
Inbound_ASN_Order = 12,	Inbound ASN Order
Inbound_RMA = 13,	Inbound RMA
Inbound_Procurement_Order = 14,	Inbound Procurement Order
Inbound_Material_Transfer = 15,	Inbound material Transfer
Outbound_Material_Transfer = 16,	Outbound Material Transfer
Inbound_Warehouse_Transfer = 17,	Inbound warehouse Transfer
Outbound_Warehouse_Transfer = 18,	Outbound Warehouse Transfer
rd_Party_ASN = 19,	third Party ASN
rd_Party_Outbound = 20	third Party Outbound

OrderLine

This object contains the Order Line details.

object OrderLine
int OrderId	The index of the Order for the order line.
int LineNumber	The Line Number for the order line.
int MaterialId	The index of the material for the order line.
int? LotId	The index of the lot for the order line.
int? VendorLotId	The index of the vendor lot for the order line.
int StatusId	The index of the status for the order line.
decimal? Price	The price for the order line. Can be empty.
decimal? Cost	The cost for the order line. Can be empty.
decimal Amount	The Amount for the order line.
int PackagedId	The index of the packaging for the order line.
decimal PackagedAmount	The packaged amount for the order line.
decimal? TotalCost	The total cost for the order line.
decimal? TotalPrice	The total price for the order line.
int? ShipmentId	The index of the shipment for the order line. Can be empty
string MaterialName	The material name for the order line.
string MaterialLookUp	The material lookup code for the order line.
string MaterialDescription	The material description for the order line.
int MaterialGroupId	The index of the material group for the order line.
string MaterialGroupName	The material group name for the order line.
OrderLineStatusEnum Status	The status for the order line.
string OrderLineNotes	The notes for the order line.
string OrderLineMarks	The marks for the order line.
string OrderLineResidueHoldId	The index of residue hold for the order line.
string OrderLinePurchaseOrder	The purchase order for the order line.
string OrderLinesEstablishmentId	The index of establishment for the order line.
string Color	The color for the order line.
string Style	The style for the order line.
string Size	The size for the order line.
string MaterialAlias	The material alias for the order line.
bool? QualityControlRequired	Is quality control required for order line?
string QualityControlStatus	The Quality Control Status for the order line.
string QualityControlNotes	The Quality Control notes for the order line.
System.DateTime? DueDate	The due date for the order line. Can be empty.
System.DateTime OrderLineCreatedSysDateTime	The Created Date for the order line.
decimal? GrossWeight	The Gross Weight for the order line. Can be empty.
decimal? NetWeight	The Net Weight for the order line. Can be empty.
int? WeightUOM	The unit of measure of the Weight for the order line. Can be empty.
decimal? WeightTolerancePercentage	The Weight Tolerance Percentage for the order line. Can be empty.
int? AllocationStrategyId	The index of lot Allocation Strategy for the order line. Can be empty
int? PackageAllocationStrategyId	The index of packaging Allocation Strategy for the order line. Can be empty
int? ExpectedPackageId	The index of Expected Package for the order line. Can be empty
decimal? ExpectedPackageAmount	The Expected Package Amount for the order line. Can be empty.
System.Guid? AllocationStrategyWorkflowId	The index of Allocation Strategy Workflow for the order line. Can be empty
int? ParentLineNumber	The Parent Line Number for the order line. Can be empty.
bool HasChildren	Does the order line have children? Can be empty.
int? LicensePlateId	The index of License Plate for the order line. Can be empty

OrderLineStatusEnum

This object is the Order Line Status Enumerator.

Enumerator OrderLineStatusEnum
Created = 1,	Created
Cancelled = 2,	Cancelled
Accepted = 4,	Accepted
Planned = 8,	Planned
Working = 16,	Working
Completed = 32,	Completed
BackOrdered = 64,	Back Ordered
InsufficientInventory = 128,	Insufficient Inventory
Error = 256,	Error
Virtually_Allocated = 512	Virtually allocated

OrderStatusChangeInfo

This is the Order Status Change Informational object. Derived from EntityStatusChangeInfoBase.

object OrderStatusChangeInfo
OrderStatusEnum OldStatus	The Old Status of the Order Status Change.
OrderStatusEnum NewStatus	The New Status of the Order Status Change.
Order	The Order of the Order Status Change.

OrderStatusEnum

This object is the Order Status type Enumerator.

Enumerator OrderStatusEnum
Created = 1,	Created
Processing = 2,	Processing
Completed = 4,	Completed
Cancelled = 8,	Cancelled
Error = 16,	Error
Virtually_Allocated = 32,	Virtually Allocated
Hold = 64,	Hold
Wait = 128,	Wait
Ready = 256,	Ready
Backorder = 512,	Backorder
Feedback_Started = 1024,	Feedback Started
Approval_Required = 2048	APPROVE

OrderTypeEnum

This object is the Order Type Enumerator.

Enumerator OrderTypeEnum
Inbound = 1,	Inbound
Outbound = 2	Outbound

OutboundPackagedQuantities

This object contains the Outbound Packaged Quantities details.

object OutboundPackagedQuantities
Dictionary<OrderLine, Dictionary<Package, decimal>> OutboundOrderPackagedQuantities	The Outbound Order Packaged Quantities.
Dictionary<ShipmentLine, Dictionary<Package, decimal>> OutboundShipmentPackagedQuantities	The Outbound Shipment Packaged Quantities.

OutboundShipmentBillingRequest

This object contains the Outbound Shipment Billing Request details. Derived from Billing Request

object OutboundShipmentBillingRequest
int OutboundShipmentId	The index of the Outbound Shipment.
override string Context	The Context of Outbound Shipment Billing Request.

OwnerStatusEnum

This object is the Owner status Enumerator.

Enumerator OwnerStatusEnum
Active,	Active
Disabled,	Disabled
Hold	Hold

Package

This object contains the Package details.

object Package
int Id	The index of the Package.
int MaterialId	The index of the material for the Package.
string Name	The Name of the Package.
int? PalletHigh	The Pallet High of the Package.
int? PalletTie	The Pallet Tie of the Package.
bool ReadyToShip	Is the Package in a ready to shipment format that needs no other shipping container?
int? SubPackagingId	The index of the Subordinate Package. If this is empty then this the base package.
string SubPackagingName	The name of the Subordinate Package.
decimal SubPackagingQuantity	The how much of the Subordinate Package quantity makes up this Package.
decimal? StandardCost	The Standard Cost of the Package quantity. Can be empty.
decimal? StandardPrice	The Standard Price of the Package quantity. Can be empty.
bool IsDefaultPackaging	Is the Package the default? That is it should be automatically in order lines, of inbound, outbound or the like.
bool IsBasePackaging	Is the Package the base? Not further divisible.
decimal? BasePackagingQuantity	The how much of the base Package quantity makes up this Package. If this is empty then this the base package.
int? BasePackagingId	The index of the base Package. If this is empty then this the base package.
decimal Weight	The Weight of the material Package.
decimal ShippingWeight	The Shipping Weight of the material Package.
decimal TareWeight	The Tare Weight of the material Package.
int WeightUOM	The unit of measure Weight of the material Package.
decimal Length	The Length of the material Package.
decimal Width	The Width of the material Package.
decimal Height	The Height of the material Package.
int DimensionUOM	The unit of measure Dimension of the material Package.
decimal Volume	The Volume of the material Package.
int VolumeUOM	The unit of measure Volume of the material Package.
string StackableGroupId	The Stackable Group of the material Package. That is other materials of this group will be stacked together.
decimal? StackableLength	The Stackable Length of the material Package. How much length is add on when stacking material?
decimal? StackableWidth	The Stackable Width of the material Package. How much Width is add on when stacking material?
decimal? StackableHeight	The Stackable Height of the material Package. How much Height is add on when stacking material?
decimal? StackableVolume	The Stackable Volume of the material Package. How much Volume is add on when stacking material?
int? FullPallet	The quantity of a Full Pallet for the material Package.

PackageAllocationStrategyEnum

This object is the Package Allocation Strategy Enumerator.

Enumerator PackageAllocationStrategyEnum
OrderLinePackageFirst = 1,	Order Line Package First
LargestPackageFirst = 2,	Largest Package First
None = 3,	None
OrderLinePackageFirstClearLocations = 4,	Order Line Package First Clear Locations
LargestPackageFirstClearLocations = 5	Largest Package First Clear Locations

PickSlip

This object contains the Wave details.

object PickSlip
int Id	The index of the wave.
int StatusId	The index of the status for the pickSlip.
string LookupCode	The LookupCode for the pickSlip.
int WaveId	The index of the wave.
string Notes	The note for the pickSlip.
DateTime? ScheduledForReleaseOn	The date and time this pickSlip to be released

PickSlipClusterLookup

This object contains the Pick Slip Cluster Lookup details.

object PickSlipClusterLookup
int ClusterId	The index of the Pick Slip Cluster.
int PickSlipId	The index of the Pick Slip in the Cluster.
int StatusId	The index of the status of the Cluster
string CreatedBy	The user the created the Cluster
DateTime CreatedDateTime	The date and time the created the Cluster.
PickSlipClusterLookupStatusEnum PickSlipClusterStatus	The status of the Cluster.

PickSlipClusterLookupChangeInfo

This object contains the Pick Slip Cluster Lookup Change Information. Derived from EntityStatusChangeInfoBase

object PickSlipClusterLookupChangeInfo
PickSlipClusterLookupStatusEnum OldStatus	The Old Status of the Pick Slip Cluster Change Information.
PickSlipClusterLookupStatusEnum NewStatus	The New Status of the Pick Slip Cluster Change Information.
PickSlipClusterLookup	The Pick Slip Cluster Lookup object.

PickSlipClusterLookupStatusEnum

This object is the PickSlip Cluster Lookup Status Enumerator.

Enumerator PickSlipClusterLookupStatusEnum
Created = 1	Created

PickSlipsCluster

This object contains the Pick Slip Cluster details.

object PickSlipsCluster
int Id	The index of the Pick Slip Cluster.
string LookupCode	The lookup code of the Pick Slip Cluster.
int StatusId	The index of the status for Pick Slip Cluster.
string CreatedBy	The user whom created the Pick Slip Cluster.
DateTime CreationDate	The date and time the Pick Slip Cluster was created.

PickSlipStatusChangeInfo

This object contains the Pick Slip Information. Derived from EntityStatusChangeInfoBase

object PickSlipStatusChangeInfo
PickSlipStatusEnum OldStatus	The Old Status of the Pick Slip Information.
PickSlipStatusEnum NewStatus	The New Status of the Pick Slip Information
PickSlip PickSlip	The Pick Slip object

PickSlipStatusEnum

This object is the PickSlip Status Enumerator.

Enumerator PickSlipStatusEnum
Created = 1,	Created
Released = 2,	Released
Completed = 4,	Completed
Cancelled = 8	Cancelled

PickTaskConfirmationResult

Contains the Pick Task Confirmation Result.

object PickTaskConfirmationResult
int? ChainHeadTaskId	Id of the parent task.
int? CompletedChildTaskId	Id of the confirmed task.
decimal? CountBackAfterPickingAmount	Number of items that should be counted after picking. Null if not count is needed.

PostCustomCommandAction

This object contains the Post Custom Command Action details.

object PostCustomCommandAction
string Url	The Url the Post Custom Command Action details.
string Parameters	The Parameters the Post Custom Command Action details.

Project

This object contains the Project details.

object ReasonCode
int Id	The index of the Project.
int OwnerId	The index of the owner of the Project.
OwnerStatusEnum OwnerStatus	The status of the Owner.
OwnerStatusEnum Status	The status of the Project.
string  Name	The Name of the Project.
stringLookupCode	The Lookup Code of the Project.
bool IsDefault	Is this the default of the Project in the owner?

ReasonCode

This object contains the Reason Code details.

object ReasonCode
int Id	The index of the Reason Code.
string Label	The Label of the Reason Code.
string LookUp	The LookUp of the Reason Code.

RecurringStorageLicensePlateContent

This object contains the Recurring Storage License Plate Content details.

object RecurringStorageLicensePlateContent
Guid ScheduleId	The index of the Schedule of the Recurring Storage License Plate Content.
int BillingContractId	The index of the Billing Contract of the Recurring Storage License Plate Content.
int? BillingContractLineId	The index of the Billing Contract line of the Recurring Storage License Plate Content.
int LicensePlateId	The index of the License Plate of the Recurring Storage License Plate Content.
int LotId	The index of the Lot of the Recurring Storage License Plate Content.
int VendorLotId	The index of the vendor Lot of the Recurring Storage License Plate Content.
int MaterialId	The index of the material of the Recurring Storage License Plate Content.
Boolean FixedWeightMaterial	The Fixed Weight Material of the Recurring Storage License Plate Content.
DateTime CreateDate	The date and time of the Recurring Storage License Plate Content is created.
Decimal PackagedAmount	The packaged amount of the Recurring Storage License Plate Content.
int PackagingId	The index of the package of the Recurring Storage License Plate Content.
Decimal PackagedNetWeight	The packaged net weight of the Recurring Storage License Plate Content.
Decimal PackagedGrossWeight	The packaged gross weight of the Recurring Storage License Plate Content
int PackagedWeightUom	The unit of measure of the packaged weight for the Recurring Storage License Plate Content
Decimal PackagedGrossVolume	The packaged gross volume of the Recurring Storage License Plate Content.
Decimal PackagedNetVolume	The packaged net volume of the Recurring Storage License Plate Content.
int PackagedVolumeUom	The unit of measure of the packaged volume for the Recurring Storage License Plate Content.
Decimal BasePackagedAmount	The base packaged amount of the Recurring Storage License Plate Content.
int BasePackagingId	The index of the base package of the Recurring Storage License Plate Content

ScaleTicket

This object contains the Scale Ticket details.

object ScaleTicket
int Id	The index of the Scale Ticket.

ScaleTicketReceivingRequest

This object contains the Scale Ticket Receiving Request details.

object ScaleTicketReceivingRequest
int ScaleTicketId	The index of the Scale Ticket.

ScaleTicketReceivingRequestLine

This object contains the Scale Ticket Receiving Request Line details.

object ScaleTicketReceivingRequestLine
int LocationId	The index for Location the Scale Ticket Receiving Request Line.
int? LicensePlateId	The index for License Plate the Scale Ticket Receiving Request Line.
decimal PackagedAmount	The Packaged Amount for the Scale Ticket Receiving Request Line
int PackagingId	The index for Packaging the Scale Ticket Receiving Request Line.
int ProjectId	The index for Project for the Scale Ticket Receiving Request Line
int? ShipmentId	The index for Shipment for the Scale Ticket Receiving Request Line.
int? ShipmentLineId	The index for Shipment Line for the Scale Ticket Receiving Request Line.
int? OrderId	The index for Order for the Scale Ticket Receiving Request Line
int? OrderLineNumber	The index for Order line for the Scale Ticket Receiving Request Line.
int? AccountId	The index for Account for the Scale Ticket Receiving Request Line
int MaterialId	The index for Material for the Scale Ticket Receiving Request Line
int? VendorLotId	The index for Vendor Lot for the Scale Ticket Receiving Request Line
int? LotId	The index for Lot for the Scale Ticket Receiving Request Line
int ScaleTicketLineId	The index for Scale Ticket Line for the Scale Ticket Receiving Request Line.
int WarehouseId	The index for Warehouse for the Scale Ticket Receiving Request Line

ScaleTicketReceivingTasksResult

This object contains the Scale Ticket Receiving Tasks Result.

object ScaleTicketReceivingTasksResult
string OutputMessage	The output message from the Scale Ticket Receiving Tasks Result.
List<int> TaskIds	The list of task indexes the Scale Ticket Receiving Tasks Result.

SerialNumber

This object contains the Serial Number details.

object SerialNumber
int Id	The index of the Serial Number.
int? MaterialId	The index of material for the Serial Number.
string LookupCode	The Lookup Code of the Serial Number.
int? LicensePlateId	The index of License Plate the Serial Number is on.
int? LotId	The index of lot of the Serial Number.
int? PackagingId	The index of Packaging of the Serial Number.
decimal? NetWeight	The Net Weight of the Serial Number.
decimal? GrossWeight	The gross Weight of the Serial Number
MeasurementUnitEnum? WeightUOM	The unit of the measure for the Weight of the Serial Number.
decimal? Height	The Height of the Serial Number
decimal? Width	The Width of the Serial Number.
decimal? Length	The Length of the Serial Number
MeasurementUnitEnum? DimensionsUOM	The unit of the measure for the Dimensions of the Serial Number
decimal? GrossVolume	The gross volume of the Serial Number
decimal? NetVolume	The net volume of the Serial Number
MeasurementUnitEnum? VolumeUOM	The unit of the measure for the volume of the Serial Number.
bool Archived	Is the Serial Number archived?
string Notes	The notes for the Serial Number
int StatusId	The index of status of the Serial Number.
InventoryStatusEnum Status	The status of the Serial Number

SerialNumberRequest

This object contains the Serial Number Request details.

object SerialNumberRequest
string LookupCode	The Lookup Code of the Serial Number.
decimal? NetWeightValue	The Net Weight of the Serial Number.
decimal? GrossWeightValue	The gross Weight of the Serial Number.
int? WeightUOM	The unit of the measure for the Weight of the Serial Number.
decimal? NetVolumeValue	The net volume of the Serial Number.
decimal? GrossVolumeValue	The gross volume of the Serial Number.
int? VolumeUOM	The unit of the measure for the volume of the Serial Number.
decimal? Length	The Length of the Serial Number.
decimal? Width	The Width of the Serial Number.
decimal? Height	The Height of the Serial Number.
int? DimensionUOM	The unit of the measure for the Dimensions of the Serial Number.

Shipment

This object contains the Shipment details.

object Shipment
int Id	The index of the Shipment.
int TypeId	The index of type for the Shipment.
int StatusId	The index of status for the Shipment.
int? ActualWarehouseId	The index of actual warehouse for the Shipment.
string LookupCode	The lookup code for the Shipment.
int ExpectedWarehouseId	The index of expected warehouse for the Shipment.
int? CarrierId	The index of carrier for the Shipment.
string CarrierName	The carrier name for the Shipment.
string Notes	The notes for the Shipment.
int? AccountId	The index of account for the Shipment.
string AccountName	The account name for the Shipment.
DateTime? ShippedDate	The date time the shipment was shipped.
DateTime? PickupDate	The date time the shipment was picked up.
DateTime? DateNeeded	The date time the shipment was needed.
int? CarrierServiceTypeId	The index of carrier service type for the Shipment.
string CarrierServiceTypeName	The name of carrier service type for the Shipment.
int? LoadContainerId	The index of Load Container for the Shipment.
string LoadContainerSize	The size of Load Container for the Shipment.
int? ContactId	The index of Contact for the Shipment.
int? WaveId	The index of wave for the Shipment.
ShipmentStatusEnum Status	The status for the Shipment.
OrderTypeEnum Type	The type for the Shipment.
string ReferenceNumber	Reference # for the Shipment.

ShipmentLine

This object contains the Shipment line details.

object ShipmentLine
int Id	The index of the shipment line.
int ShipmentId	The index of the Shipment for the shipment line.
int OrderId	The index of the order for the shipment line.
int OrderLineNumber	The order line number of the shipment line.
int LineNumber	The line number of the shipment line.
int StatusId	The index of the status for the shipment line.
decimal ExpectedAmount	The expected amount on the shipment line.
decimal ExpectedPackagedAmount	The expected packaged amount on the shipment line.
int ExpectedPackageId	The index of the Expected Package for the shipment line.
decimal ActualAmount	The actual amount on the shipment line.
decimal ActualPackagedAmount	The actual packaged amount on the shipment line.
int ActualPackagedId	The index of the Actual Packaged for the shipment line.
decimal? NetWeight	The Net Weight of the shipment line.
decimal? GrossWeight	The Gross Weight of the shipment line.
int? WeightUom	The unit of measure for Weight of the shipment line.
int MaterialId	The index of the material for the shipment line.
string MaterialName	The Material Name on the shipment line.
string MaterialLookUp	The Material lookup code on the shipment line.
string MaterialDescription	The Material description on the shipment line.
int MaterialGroupId	The index of the Material Group for the shipment line.
string MaterialGroupName	The Material group Name on the shipment line.
ShipmentStatusEnum Status	The status of the shipment line.

ShipmentStatusChangeInfo

This object contains the Shipment Status Change Information details. Derived from EntityStatusChangeInfoBase

objectShipmentStatusChangeInfo
ShipmentStatusEnum OldStatus	The Old Status for the Shipment
ShipmentStatusEnum NewStatus	The new Status for the Shipment.
Shipment Shipment	The shipment in the Shipment Status Change Information.

ShipmentStatusEnum

This object is the Shipment Status Enumerator.

Enumerator ShipmentStatusEnum
Created = 1,	Created
Released = 2,	Released
Executing = 4,	Executing
Completed = 8,	Completed
Cancelled = 16,	Cancelled

ShippingContainer

This object contains the Shipping Container details.

object ShippingContainer
int Id	The index of the Shipping Container.
int? ShippingContainerParentId	The index of the Parent container of the Shipping Container.
int? ShippingContainerTypeId	The index of the container type of the Shipping Container.
string ShippingContainerTypeName	The name of the container type of the Shipping Container.
string LookupCode	The lookup code of the Shipping Container.
string ContainerNumber	The Container Number of the Shipping Container.
bool IsContainer	Is this a the Shipping Container or a self shippable material package
string Packaging	If it is self shippable material what is it package name.
decimal? Weight	The Weight of the Shipping Container.
string WeightUom	The unit of measure for the Weight of the Shipping Container.
decimal? Volume	The Volume of the Shipping Container.
string VolumeUom	The unit of measure for the Volume of the Shipping Container.
decimal? Length	The Length of the Shipping Container
decimal? Height	The Height of the Shipping Container
decimal? Width	The Width of the Shipping Container
string DimensionUom	The unit of measure for the Dimension of the Shipping Container
int? ShipperContactId	The index of the Shipper Contact of the Shipping Container
int? CarrierId	The index of the Carrier of the Shipping Container
DateTime? ShippingDate	The Shipping Container date and time of shipping
decimal? ShippingCost	The Shipping Cost of the Shipping Container.
int? ShippingCurrencyId	The index of the shipping currency of the Shipping Container.
string ManifestedPackageCode	The Manifested Package Code of the Shipping Container
string ManifestedPackageBundleCode	The Manifested Package Bundle Code of the Shipping Container

ShippingIntegrationMapping

This object contains the Shipping Integration Mapping details.

object ShippingIntegrationMapping
string FootPrintEntityId	The index of the FootPrint Entity in the Shipping Integration Mapping.
ShippingIntegrationMappingTypeEnum MappingType	The Mapping Type in the Shipping Integration Mapping.
string ExternalEntityId	The index of the External Entity in the Shipping Integration Mapping.

ShippingIntegrationMappingTypeEnum

This object is the Shipping Integration Mapping Type Enumerator.

Enumerator ShippingIntegrationMappingTypeEnum
Carrier,	Carrier
CarrierService,	Carrier Service
Shipper,	Shipper
MeasurementUnit,	Measurement Unit
Currency,	Currency
Country,	Country

ShippingManifest

This object contains the Shipping Manifest details.

object ShippingManifest
int Id	The index of the Shipping Manifest.
int ShipperContactId	The index of Shipper Contact for the Shipping Manifest.
int CarrierId	The Carrier of the Shipping Manifest.
DateTime ShippingDate	The Date the Shipping Manifest was shipped.
decimal? ShippingCost	The cost of the Shipping Manifest.
bool Closed	is the Shipping Manifest closed?
int? ShippingCurrencyId	The index of Shipping Currency for the Shipping Manifest.
string ClosedManifestCode	The Closed Manifest Code of the Shipping Manifest.

ShippingPackage

This object contains the Shipping Package details.

object ShippingPackage
static ShippingPackage Create(int shippingContainerId, string shippingContainerLookupCode, ShippingPackage parent = null)	The create method of the Shipping Package. Given the index of the shipping Container, shipping Container Lookup Code, and the Shipping Package parent.
private ShippingPackage(int shippingContainerId, string shippingContainerLookupCode, ShippingPackage parent = null)	The constructor of the Shipping Package.
int ShippingContainerId	The index of the Shipping Container for the Shipping Package.
string ShippingContainerLookupCode	The index of the Shipping Container lookup code for the Shipping Package.
ShippingPackage Parent	The parent package for the Shipping Package.
int? PackageTypeId	The index of the Package Type for the Shipping Package.
decimal? Length	The Length of the Shipping Package.
decimal? Width	The Width of the Shipping Package
decimal? Height	The Height of the Shipping Package
int? DimensionUomId	The index of the Dimension unit of measure for the Shipping Package.
decimal? Weight	The Weight of the Shipping Package
int? WeightUomId	The index of the Weight unit of measure for the Shipping Package.
decimal? DeclaredValue	The Declared Value of the Shipping Package
int? DeclaredValueCurrencyId	The index of the Declared Value Currency for the Shipping Package
int? FreightClassId	The index of the Freight Class for the Shipping Package
string NmfcNumber	The NMFC Number of the Shipping Package.
string NmfcSubNumber	The NMFC Sub Number of the Shipping Package.
string CommodityDescription	The Commodity Description of the Shipping Package
int? PackagedItemCount	The Packaged Item Count of the Shipping Package

SignAlgorithmEnum

This object is the signing algorithm Enumerator.

Enumerator SignAlgorithmEnum
HMACSHA1 = 1,	HMACSHA1

Survey

This object contains the Survey details.

object Survey
int Id	The index of the Survey.
int SurveyDefintionId	The index of the Survey Definition.
int EquipmentId	The index of the Equipment.
int SurveyOperationContextId	The index of the operation context in which this Survey is answered.
string SurveyOperationContextData	The operation context data in which this Survey is answered.
string UserId	The Id of the user.
List<SingleKeyEntityUdfValues> Answers	The associated list of answers for the survey.

SurveyDefinition

This object contains the Survey Definition details.

object SurveyDefinition
int Id	The index of the Survey Definition.
string Name	The name of the Survey.
string Description	The description of the Survey.
bool Enabled	The enable state of the Survey.
List<UdfFields> Questions	The associated list of questions for the survey.

Tag

This object contains the Tag details.

object Tag
int Id	The index of the tag.
string Name	The name of the tag.

Task

This object contains the Task details.

object Task
int Id	The index of the task.
int? ReasonCodeId	The index of the Reason Code for the task.
int WarehouseId	The index of the warehouse for the task.
int StatusId	The index of the status for the task.
int? ProjectId	The index of the project for the task.
int? MaterialId	The index of the material for the task.
int? LotId	The index of the lot for the task.
int? VendorLotId	The index of the vendor lot for the task
int? SerialNumberId	The index of the serial number for the task.
int? ExpectedSourceLicensePlateId	The index of the Expected Source License Plate for the task.
int? ExpectedTargetLicensePlateId	The index of the Expected Target License Plate for the task
int? ActualSourceLicensePlateId	The index of the Actual Source License Plate for the task
int? ActualTargetLicensePlateId	The index of the Actual Target License Plate for the task
int? ExpectedSourceLocationId	The index of the Expected Source Location for the task.
int? ExpectedTargetLocationPlateId	The index of the Expected Target Location Plate for the task
int? ActualSourceLocationId	The index of the Actual Source Location for the task
int? ActualTargetLocationId	The index of the Actual Target Location for the task
int? ShipmentId	The index of the shipment for the task.
int? ShipmentLineId	The index of the shipment line for the task.
int? OrderId	The index of the order for the task.
int? OrderLineNumber	The order line number for the task.
string ManufacturingOrderLookupCode	The lookup code of the Manufacturing Order for the task.
int? ManufacturingOrderId	The index of the Manufacturing Order for the task.
int? ManufacturingOrderLineId	The index of the Manufacturing Order Line for the task
decimal? ExpectedInventoryAmount	The base Inventory Amount the task Expected
decimal? ExpectedInventoryPackagedId	The index of the package for the base Expected Inventory Amount on the task.
decimal? ExpectedPackagedAmount	The Packaged Amount the task Expected
decimal? ExpectedPackagedId	The Packaged Amount the task Expected
decimal? ActualInventoryAmount	The base Inventory Amount the task actually used.
decimal? ActualInventoryPackagedId	The index of the package for the base Actual Inventory Amount on the task
decimal? ActualPackagedAmount	The packaged Inventory Amount the task actually used
decimal? ActualPackagedId	The index of the Actual Packaged for the task.
string Employee	The employee that performed the task.
string Notes	The notes of the task.
int? RecommendedTargetLocationId	The index of the Recommended Target Location for the task.
int? RecommendedTargetLicensePlateId	The index of the Recommended Target License Plate for the task
int OperationCodeId	The index of the Operation Code for the task.
int ChainHead	The index of the parent task for which this task is a child
DateTime CreatedSysDateTime	The date and time this task had been created
DateTime ModifiedSysDateTime	The date and time this task had been last modified
DateTime? ReleaseDateTime	The date and time this task had been release
DateTime? CancelledDateTime	The date and time this task had been cancelled.
DateTime? CompletedDateTime	The date and time this task had been completed.
DateTime? StartDateTime	The date and time this task had been started.
DateTime? ExpectedExpirationDate	The Expected Expiration Date of the task.
DateTime? ActualExpirationDate	The Actual Expiration Date of the task.
TaskStatusEnum Status	The status of the task.
decimal? NetWeight	The NetWeight on the task
decimal? GrossWeight	The GrossWeight on the task
int? WeightUOM	The WeightUOM on the task
decimal? NetVolume	The NetVolume on the task
decimal? GrossVolume	The GrossVolume on the task
int? VolumeUOM	The VolumeUOM on the task
decimal? Height	The Height on the task
decimal? Width	The Width on the task
decimal? Length	The Length on the task
int? DimensionsUOM	The DimensionsUOM on the task

TaskStatusChangeInfo

This object contains the Task Status Change Information details.

object TaskStatusChangeInfo
TaskStatusEnum OldStatus	The old status of the task for the Task Status Change Information.
TaskStatusEnum NewStatus	The new status of the task for the Task Status Change Information.
Task Task	The task for the Task Status Change Information.

TaskStatusEnum

This object is the Shipment Status Enumerator.

Enumerator TaskStatusEnum
Release = 1,	Release
Completed = 2,	Completed
Cancelled = 3,	Cancelled
Planned = 4	Planned

TemperatureCategory

This object contains the Temperature Category details.

object TemperatureCategory
int Id	The index of the Temperature Category.
string LookupCode	The Lookup Code of the Temperature Category.

TemperatureCategoryRuleLine

This object contains the Temperature Category Rule Line details.

object TemperatureCategoryRuleLine
int WarehouseId	The index of the warehouse for the Temperature Category Rule Line.
int TemperatureCategoryId	The index of the Temperature Category for the Temperature Category Rule Line.
int Priority	The Priority for the Temperature Category Rule Line.
TemperatureCategory Temperature	The Temperature for the Temperature Category Rule Line.

TemperatureReadingRecords

This object contains the Temperature Reading Records details.

object TemperatureReadingRecords
int ReadingPointId	The index of the reading point.
string ReadingPointName	The Reading Point Name of the Temperature Reading Records.
int ReadingTypeId	The index of Reading Type of the Temperature Reading Records.
string ReadingTypeName	The Reading Type Name of the Temperature Reading Records.
string Employee	The Employee that created the Temperature Reading Records.
DateTime DateCaptured	The date and time the Temperature Reading Records were captured.
decimal Temperature1	The first temperature of the Temperature Reading Records.
string Temperature1MeasurementUnit	The unit of measure of first temperature for the Temperature Reading Records.
decimal? Temperature2	The second temperature of the Temperature Reading Records.
string Temperature2MeasurementUnit	The unit of measure of second temperature for the Temperature Reading Records.
decimal? Temperature3	The third temperature of the Temperature Reading Records.
string Temperature3MeasurementUnit	The unit of measure of third temperature for the Temperature Reading Records.
string Notes	The notes of the Temperature Reading Records.

VendorLot

This object contains the Vendor Lot details.

object VendorLot
int Id	The index of the vendor lot.
int MaterialId	The index of the material for the vendor lot.
string LookupCode	The Lookup Code of the vendor lot.
DateTime? ManufactureDate	The Date the vendor lot was Manufactured.
DateTime? ExpirationDate	The date the vendor lot will Expiration.

Warehouse

This object contains the Warehouse details.

object Warehouse
int Id	The index of the Warehouse.
string Name	The name of the Warehouse.
int? DefaultReceivingLocationId	The index of the Default Receiving Location for the Warehouse.
int? DefaultAsnReceivingLocationId	The index of the Default Asn Receiving Location for the Warehouse.

Wave

This object contains the Wave details.

object Wave
int Id	The index of the wave.
string Description	The Description for the wave.
int StatusId	The index of the status for the wave.
bool BatchPick	The batchPick indicator for the wave.
DateTime? ReleaseDate	The date and time this wave was releated.
string Notes	The notes of the wave.
int? StagingLocationId	The index of the Staging Location for the wave.
int WarehouseId	The index of the warehouse for the wave.
int PriorityId	The index of the priority for the wave.
int? PreviousStatusId	The index of the previous status for the wave.
DateTime CreatedSysDateTime	The date and time this task had been created.
DateTime ModifiedSysDateTime	The date and time this task had been last modified.

WaveStatusChangeInfo

This object contains the Wave Status Change Infomation details.

object WaveStatusChangeInfo
WaveStatusEnum OldStatus	The old status of the task for the Wave Status Change Infomation.
WaveStatusEnum NewStatus	The new status of the task for the Wave Status Change Infomation.
Wave Wave	The task for the Wave Status Change Infomation.

WaveStatusEnum

Enumerator WaveStatusEnum
Created = 1,	Created
Processed = 2,	Processed
Released = 3,	Released
Completed = 4,	Completed
Cancelled = 5,	Cancelled
Processing = 6	Processing

WorkflowDivertBilling

This object is for defining project divert billing options.

object WorkflowDivertBilling
int OriginalProjectId	The Original Project Id to Divert From.
int DivertedProjectId	The Diverted Project Id to Divert To.
List<int> BillingCodeIds;	List of Billing Codes that the Diverted Project Id is allowed to Divert for.

WorkShift

This object contains the WorkShift details.

object WorkShift
int Id	The index of the WorkShift.
string Name	The name of the WorkShift.
string Code	The code of the WorkShift.

Last Updated:

06/06/2025