Files
mcp-wms-api/docs/entities/easywms_reading_entites_outboundorder.md
T
2026-05-20 09:38:07 +02:00

19 KiB
Raw Blame History

OutboundOrder

Full name: Mecalux.ITSW.EasyWMS.Modules.Expeditions.Reading.Domain.OutboundOrder

Summary

Represents an outbound order - Is used for managing and tracking outbound orders. It includes key details.

Properties

Name Type Description
AccountCode string Gets or sets the [Account] code. The account code for the outbound order (An account is each of a company´s delivery points). Example: "ACC_NIKE_01025"
AccountId Guid? Gets or sets the [Account] identifier. The account identifier for the outbound order (An account is each of a company´s delivery points). Example: 85f988c3-t2f4-44fc-bd2d-ca3db667812t.
Address Address Gets or sets the [Address]. The delivery address for the outbound order - Represents a physical address with properties (Street, number, door, floor, letter, city, neighborhood, country, zipcode and comments about the address).
AgencyCode string Gets or sets the [Agency] code. The carrier code for the outbound order (Transport agency code. There must be the transport agency code). Example: "SEUR"
AgencyId Guid? Gets or sets the [Agency] identifier. The carrier identifier for the outbound order (Transport agency code. There must be the transport agency code). Example: 15f9e8c3-g2f4-44fc-bd2d-ca3db667617y.
AllowDynamicReplenishment bool Indicates whether the outbound order allows dynamic replenishment. If allows dynamic replenishment (true). Otherwise (false). Example: false
AnyOutboundLineInWorkWave bool Flag that indicates if any of it's line is associated to a wave. Example: false
AnyStockShipped bool Indicates if the order has any stock shipped. Rule to get: Count all of the outbound order lines with the identifier of the outbound order, if the order has lines with quantity shipped or quantity shipped substitute greater than zero (true); otherwise (false) Example: true
AssignedUser string The user for whom the outbound order is assigned. Example: "mecalux001"
AutoCreated bool [CANNOT BE USED] Indicates if the outbound order has been auto created. Currently it is always false.
AutoRelease bool Indicates whether the outbound order should be auto released. If the outbound order should be auto released (true). Otherwise (false). Example: true
AutoReleaseDate DateTime? Indicates when the outbound order will be automatically released if the auto release flag is set to true. Example: 03/25/2025 0:00:00.
AutoReserve bool [NOT IMPLEMENTED] Indicates if the outbound order should reserve stock automatically.
AutoReserveDate DateTime? [NOT IMPLEMENTED] Indicates when the outbound order will be automatically reserved if the auto reserve flag is set to true
CalculatedNumAdjustStockIssues long Gets or sets the total number of adjust stock issues.
CalculatedNumCommunicationErrorIssues long Gets or sets the total number of communication error issues.
CalculatedNumExpiredDatesIssues long Gets or sets the total number of expired dates issues.
CalculatedNumNeedReplenishmentIssues long Gets or sets the total number of need replenishment issues.
ClientContainerTypeCode string The favourite container type code for picking. Example: "American".
ClientContainerTypeId Guid? The favourite container type identifier for picking. Example: 75f828c3-f2f4-44fc-bd2d-ca3db667896r.
Code string Required
It is a unique code that identifies the outbound order. Example: "ORDER_SU1".
CreationDateOnERP DateTime? The ERP creation date for the outbound order. Example: 01/25/2024 0:00:00.
CurrentOperation string The operation for the outbound order. The possible values are the ones in OutboundOrderOperation. Example: "Releasing"
CustomAttribute CustomAttribute Gets or sets the [Common.Domain.CustomAttribute]. The outbound order's custom attributes.
DeliveryInstruction string [USED IN MULTI-CARRIER SHIPPING APP] The delivery instructions Example: "Ensure the package is not exposed to direct sunlight or rain".
Description string It is a description of the outbound order. Example: "Includes special packaging".
Document string The outbound order document Example: "DOC01".
ERPCode string The ERP code for the outbound order. Example: "ERP_US_001"
ExpectedDockStationCode string The expected dock station code for the outbound order. (A dock is an area in the warehouse where trucks (or any other vehicle used to transport goods). Example: "DOCK_01".
ExpectedDockStationId Guid? The expected dock station identifier for the outbound order. (A dock is an area in the warehouse where trucks (or any other vehicle used transport goods). Example: 88f828c3-f334-44fc-bd2d-fa3db667896t.
FirstTroubleDate DateTime? The first trouble date. It is null if no trouble has occurred. Example: 02/25/2025 0:00:00.
FollowSequence bool Indicates whether the line number should be used as a sequencing method for the preparation. If the line number should be used as a sequencing method for the preparation (true). Otherwise (false). Example: false
GroupType string The group type of the outbound order. The possible values are the ones in GroupType + an empty string when it is not a group. Example: Merge
HasTroubles bool Indicates whether the outbound order has troubles. Example: true.
IncompleteOrder bool Indicates whether the outbound order is incomplete (An incomplete order is when a order is not fully fulfilled, missing items, incorrect items, or partial delivery). Example: false.
InternalInfo InternalInfo Gets or sets the [Application.Common.Domain.InternalInfo]. The internal system information of the outbound order.
IsActive bool Indicates if the outbound order is active in the system Example: true.
IsSingleUnit bool Indicates if the outbound order is single unit. Example: true.
IsTenseFlow bool Indicates if the order is tense flow (Tense Flow is strategy that synchronizes the arrival of goods at the warehouse with their departure for distribution, reducing storage needs and costs while improving operational efficiency). Example: true
LoadDockStageLocationCode string The actual dock stage location code for the outbound order. Example: "DOCK_03".
LoadDockStageLocationId Guid? The actual dock stage location identifier for the outbound order. Example: 09f828c3-g334-44fc-bd2d-fa3db667885g.
LoadDockStationCode string The actual dock station code for the outbound order. (A dock is an area in the warehouse where truck (or any other vehicle user to transport goods). Example: "DOCK_02".
LoadDockStationId Guid? The actual dock station identifier for the outbound order. (A dock is an area in the warehouse where truck (or any other vehicle user to transport goods). Example: 19f828c3-g334-44fc-bd2d-fa3db667896f.
ManualEquipmentCode string The code of the manual equipment assigned to the outbound order. (It is managed by an operator using a radio frequency terminal. Manual equipment includes pallet, trucks, forklifts etc.). Example: "EQST_PTL_ONLYSTOCK_01"
ManualEquipmentId Guid? The identifier of the manual equipment assigned to the outbound order. (It is managed by an operator using a radio frequency terminal. Manual equipment includes pallet, trucks, forklifts etc.). Example: 41f838c3-h354-442c-bd2d-fa32b667913y.
MinSupplyPercent long [NOT IMPLEMENTED] The minimum percentage of storaged stock necessary to supply stock to the order.
NumCancelledLines long The number of outbound lines from the order that are in cancelled status.
NumClientContainers long The number of client containers for the outbound order.
NumClosedLines long The number of outbound lines from the order that are in closed status.
NumCutInProcessTasks long The number of cut in process task for the outbound order.
NumCutPendingTasks long The number of cut pending task for the outbound order.
NumLoads long The number of loads for the outbound order. Example: 1
NumOutboundOrderChildren long The number of outbound order children for the group or merge.
NumOutboundOrderLineDetails long The number of outbound order line details for the outbound order. Example: 2
NumOutboundOrderLines long Obsolete("Use NumTotalOutboundOrderLines")
The number of outbound lines for the outbound order. Example: 2
NumPendingTasks long The number of pending tasks for the outbound order.
NumPreparedTasks long The number of prepared tasks for the outbound order.
NumReleasedLines long The number of outbound lines from the order that are in released status.
NumStockLines long The number of stock lines for the outbound order.
NumStoppedLines long The number of outbound lines from the order that are stopped when the whole order is being stopped.
NumTotalOutboundOrderLines long The total number of outbound order lines. Rule to calculate: Count of all outbound order lines with the identifier of the outbound order and outbound order status different of the ´Cancelled´. Example: 5
NumWavedLines long Obsolete("Waves are no longer supported. Use WorkWaves")
[OBSOLETE] The number of outbound lines from the outbound order included in a wave.
NumWaves long Obsolete("Waves are no longer supported. Use WorkWaves")
[OBSOLETE] The number of waves where the outbound order is included.
OrderWeight decimal Obsolete("This field is no longer maintained. Please perform the necessary query to obtain the value")
[OBSOLETE] The outbound order weight.
OutboundClassCode string Gets or sets the [OutboundClass] code. The outbound class code for the outbound order (The outbound class is a classification of the routes and shipping orders). Example: "SHIPPING_GROUP_01"
OutboundClassId Guid? Gets or sets the [OutboundClass] identifier. The outbound class identifier for the outbound order (The outbound class is a classification of the routes and shipping orders). Example: 08d877b3-t2e4-44fc-cd2d-ca3db667515t.
OutboundIssueCodes string Gets or sets the issues.
OutboundOrderGroupMasterCode string Gets or sets the [OutboundOrderGroup] code. The code of the master outbound order for the group the outbound order is part of. It is part of none, it is an empty string. Example: "GROUPING_01".
OutboundOrderGroupMasterId Guid? Gets or sets the [OutboundOrderGroup] identifier. The identifier of the master outbound order for the group the outbound order is part of. It is part of none, it is null. Example: 41f838c3-h354-442c-bd2d-fa32b667913y.
OutboundOrderSituation string [CANNOT BE USED] The outbound order situation.
OutboundOrderStatus string Required
The outbound order's status. The possible values are the ones in OutboundOrderStatus. Example: "Creating"
OutboundType string The outbound order's outbound type. The possible values are the ones in OutboundType. Example: "Customer"
OwnerCode string Gets or sets the [Owner] code. The owner code for the outbound order. Example: "VW_02".
OwnerId Guid? Gets or sets the [Owner] identifier. The owner identifier for the outbound order. Example: 65f828c3-t2f4-44fc-bd2d-ca3db667896g.
PackagingLocationCode string The packaging location code for the outbound order. Example: "UDISTRIBUTION_UAP_02".
PackagingLocationId Guid? The packaging location identifier for the outbound order. Example: 39f838c3-g354-442c-bd2d-fa32b667882g.
PaperPick bool Indicates whether the outbound order will be prepared using paper pick. (Paper picking is a process by which the operator performs the picking manually, without using the RF terminal or the work station.) Example: true.
PartialClosedSequence long? The last partial closed sequence. Example: 3
PendingReceipt bool Indicates whether the outbound order is waiting for receiving an ASN container. True if it is waiting for an ASN to be received or otherwise is false. Example: false.
Planning Planning Gets or sets the [Planning]. The outbound order planning information.
PrepackagingLogic string The pre-packaging logic for the outbound order. The possible values are the ones in PrepackagingLogic. Example: MinimumParcels
PrepackagingProcess string The pre-packaging type for the outbound order. The possible values are the ones in PrepackagingProcess. Example: Preparation
PrepackagingType string The pre-packaging type for the outbound order. The possible values are the ones in PrepackagingType. Example: ERPInformed
PrepackagingWorkingMode string The pre-packaging working mode for the outbound order. The possible values are the ones in PrepackagingWorkingMode. Example: Strict
Priority string The outbound order priority. The possible values are the ones in Priority. Example: "Urgent".
RealReleaseDate DateTime? Indicates the first release date for the outbound order. Example: 03/25/2025 0:00:00.
ReceivedFromERP bool Indicates whether the outbound order was received from the ERP. If received from the ERP (true). Otherwise (false). Example: true
ReleasedBy string The first user who released the outbound order. Example: "mecalux567"
RequiredClientContainerTypeCode string Gets or sets the [ContainerType] code. The required client container type code for picking. Example: "EuroPallet".
RequiredClientContainerTypeId Guid? Gets or sets the [ContainerType] identifier. The required client container type identifier for picking. Example: 85f828c3-t2f4-44fc-bd2d-ca3db667896t.
RouteCode string Gets or sets the [Route] code. The route code for the outbound order. Example: "NORTHERN_ROUTE".
RouteId Guid? Gets or sets the [Route] identifier. The route identifier for the outbound order. Example: 48d877b3-c2e4-44fc-bd2d-ca3db667515c.
ShipExpiredStock bool Indicates if the outbound order shipped products with expired dates.
ShipmentTemplateCode string Gets or sets the [ShipmentTemplate] code. The code of the shipment template used in the outbound order. Example: "ST_SINGLE_UNIT"
ShipmentTemplateId Guid? Gets or sets the [ShipmentTemplate] identifier. The identifier of the shipment template used in the outbound order. Example: 21f838c3-e354-442c-td2d-ha32b667915u.
ShippingDeadline DateTime? Gets the shipping deadline.
ShippingDeadlineManuallySet bool Indicates whether the shipping deadline was received from the assistant. If received from the assistant (true). Otherwise (false).
ShipReq ShippingRequirements Gets or sets the [ShippingRequirements]. The outbound order shipping requirements.
SkipTroubledTasks bool The flag to skip troubled tasks. When true, troubled tasks will be skipped. When false, they will block the execution of the following tasks. Example: true
Source string The outbound order source. Example: "L10".
SubwarehouseCode string Gets or sets the [Subwarehouse] code. The subwarehouse code for the outbound order (Subwarehouses is grouping locations to build rules that apply over a specific warehouse area or locations subset). Example: "ST_SINGLE_UNIT"
SubwarehouseId Guid? Gets or sets the [Subwarehouse] identifier. The subwarehouse identifier for the outbound order (Subwarehouses is grouping locations to build rules that apply over a specific warehouse area or locations subset). Example: 32f838c3-ef54-442c-td2d-ha32b6679r5g.
SupplierCode string Gets or sets the [Supplier] code. The supplier code for the outbound order (A supplier is a company or entity that supplies stock to the node). Example: "NIKE"
SupplierId Guid? Gets or sets the [Supplier] identifier. The supplier identifier for the outbound order (A supplier is a company or entity that supplies stock to the node). Example: 25f9e8c3-g2f4-45fc-bd2d-ca3db667718u.
TenseFlowStageCode string The tense flow stage code (Tense Flow is strategy that synchronizes the arrival of goods at the warehouse with their departure for distribution, reducing storage needs and costs while improving operational efficiency). Example: "STG_01"
TenseFlowStageId Guid? The tense flow stage identifier (Tense Flow is strategy that synchronizes the arrival of goods at the warehouse with their departure for distribution, reducing storage needs and costs while improving operational efficiency). Example: 35f838c3-fg54-542c-td2d-ha32b667190t.
Transport OutboundOrderTransport Gets or sets the [OutboundOrderTransport]. The outbound order transport information.
ValidDate DateTime? [NOT IMPLEMENTED] The outbound order valid date.
WarehouseCode string Required
Gets or sets the [Warehouse] code. The warehouse code for the outbound order. Example: "KITDEMO_4".
WarehouseId Guid Gets or sets the [Warehouse] identifier. The warehouse identifier for the outbound order. Example: 07d877b3-c2e4-44fc-bd2d-ca3db667514a.
WarehouseToCode string Gets or sets the [Warehouse] code. The destination warehouse code for the outbound order. Example: "WH_STORE_01".
WarehouseToId Guid? Gets or sets the [Warehouse] identifier. The destination warehouse identifier for the outbound order. Example: 18d877b3-c2e4-44fc-bd2d-ca3db667515b.
WorkOrderCode string Gets or sets the [WorkOrder] code. The work order code for the outbound order (assembly or disassembly of kit). Example: "WORK_ORDER_ASSEMBLY_01"
WorkOrderId Guid? Gets or sets the [WorkOrder] identifier. The work order identifier for the outbound order (assembly or disassembly of kit). Example: 78d877b3-f2e4-44fc-bd2d-ca3db667515g.
WorkWaveCode string Gets or sets the [WorkWave] code. The code of the wave to which the outbound order is associated. Example: "Wave_A"
WorkWaveId Guid? Gets or sets the [WorkWave] identifier. Identifier used to track and manage wave. Example: 12f838c3-ff54-542c-td2d-ha32b6679r5t.

If you have any suggestion or comment on this documentation, please submit it to documentation@mecalux.com