Mecalux/mcp-wms-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

version mise à jour par claude , à tester

Browse Source
This commit is contained in:
Arthur Ria
2026-05-20 09:38:07 +02:00
commit b59cbb3546
58 changed files with 24548 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+41
View File
@@ -0,0 +1,41 @@
# Documentation WMS
Bienvenue dans la documentation du WMS !
## Comment utiliser cette documentation
Cette documentation est automatiquement accessible via le serveur MCP. Claude peut lire tous les fichiers `.md` présents dans ce dossier et ses sous-dossiers.
## Organisation
Organisez vos fichiers de documentation comme vous le souhaitez :
```
docs/
├── README.md (ce fichier)
├── getting-started.md (guide de démarrage)
├── api/
│ ├── overview.md
│ └── endpoints.md
├── workflows/
│ ├── reception.md
│ └── expedition.md
└── troubleshooting/
└── common-errors.md
```
## Comment ajouter de la documentation
1. Créez vos fichiers `.md` dans ce dossier ou dans des sous-dossiers
2. Redémarrez Claude Desktop
3. Claude pourra automatiquement lire tous vos fichiers de documentation
## Accéder à la documentation depuis Claude
Dans Claude Desktop, vous pouvez demander :
- "Montre-moi le sommaire de la documentation"
- "Lis la documentation sur les workflows"
- "Affiche-moi la documentation de l'API"
Claude aura accès à tous les fichiers `.md` présents ici !
docs/api/Application Service API Reference.md
+669
View File
@@ -0,0 +1,669 @@
## Application
| API | Description |
| --- | --- |
| [GET api/application/apiversion](https://10.255.255.2/ApplicationService/Help/Api/GET-api-application-apiversion) |
No documentation available.
|
| [GET api/application/apichangelog](https://10.255.255.2/ApplicationService/Help/Api/GET-api-application-apichangelog) |
No documentation available.
|
| [POST api/application/GetResources](https://10.255.255.2/ApplicationService/Help/Api/POST-api-application-GetResources) |
No documentation available.
|
## CommandExecute
| API | Description |
| --- | --- |
| [POST api/CommandExecute](https://10.255.255.2/ApplicationService/Help/Api/POST-api-CommandExecute) |
No documentation available.
|
## CommandFiles
| API | Description |
| --- | --- |
| [POST api/CommandUploadFile](https://10.255.255.2/ApplicationService/Help/Api/POST-api-CommandUploadFile) |
No documentation available.
|
| [GET api/CommandDownloadFile?fileCode={fileCode}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-CommandDownloadFile_fileCode) |
No documentation available.
|
## Configuration
| API | Description |
| --- | --- |
| [GET api/configuration/apiversion](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-apiversion) |
No documentation available.
|
| [GET api/configuration/apichangelog](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-apichangelog) |
No documentation available.
|
| [POST api/configuration/updateorganization](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateorganization) |
No documentation available.
|
| [POST api/configuration/updateusergroups](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateusergroups) |
No documentation available.
|
| [POST api/configuration/updaterfmenuitems](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updaterfmenuitems) |
No documentation available.
|
| [POST api/configuration/updatejobs](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updatejobs) |
No documentation available.
|
| [POST api/configuration/stopjobs](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-stopjobs) |
No documentation available.
|
| [POST api/configuration/startjobs](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-startjobs) |
No documentation available.
|
| [POST api/configuration/executejob](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-executejob) |
No documentation available.
|
| [POST api/configuration/updatesubscriptions](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updatesubscriptions) |
No documentation available.
|
| [POST api/configuration/updatetimelinetemplates](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updatetimelinetemplates) |
No documentation available.
|
| [POST api/configuration/updatetypes](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updatetypes) |
No documentation available.
|
| [POST api/configuration/updateprocesses](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateprocesses) |
No documentation available.
|
| [POST api/configuration/updatequeries](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updatequeries) |
No documentation available.
|
| [POST api/configuration/updateDataWarehouseContext](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateDataWarehouseContext) |
No documentation available.
|
| [POST api/configuration/updateresources](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateresources) |
No documentation available.
|
| [POST api/configuration/updateapplication](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateapplication) |
No documentation available.
|
| [POST api/configuration/updateapplications](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateapplications) |
No documentation available.
|
| [POST api/configuration/updatelicense](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updatelicense) |
No documentation available.
|
| [POST api/configuration/updatehooks](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updatehooks) |
No documentation available.
|
| [POST api/configuration/updategenericsearch](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updategenericsearch) |
No documentation available.
|
| [POST api/configuration/undoLatestMigration?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-undoLatestMigration_applicationName) |
No documentation available.
|
| [POST api/configuration/enableapplication?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-enableapplication_applicationName) |
No documentation available.
|
| [POST api/configuration/disableapplication?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-disableapplication_applicationName) |
No documentation available.
|
| [POST api/configuration/enabletelemetry](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-enabletelemetry) |
No documentation available.
|
| [POST api/configuration/disabletelemetry](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-disabletelemetry) |
No documentation available.
|
| [GET api/configuration/tenant](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-tenant) |
No documentation available.
|
| [POST api/configuration/enablefeature](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-enablefeature) |
No documentation available.
|
| [POST api/configuration/disablefeature](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-disablefeature) |
No documentation available.
|
| [POST api/configuration/getfeature](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-getfeature) |
No documentation available.
|
| [GET api/configuration/applications](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-applications) |
No documentation available.
|
| [GET api/configuration/applicationFeatures?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-applicationFeatures_applicationName) |
No documentation available.
|
| [GET api/configuration/tenants](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-tenants) |
No documentation available.
|
| [GET api/configuration/tenantinfo?tenantCode={tenantCode}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-tenantinfo_tenantCode) |
No documentation available.
|
| [GET api/configuration/serviceinfo](https://10.255.255.2/ApplicationService/Help/Api/GET-api-configuration-serviceinfo) |
No documentation available.
|
| [POST api/configuration/updateservicemode](https://10.255.255.2/ApplicationService/Help/Api/POST-api-configuration-updateservicemode) |
No documentation available.
|
## Events
| API | Description |
| --- | --- |
| [POST api/PublishEvents](https://10.255.255.2/ApplicationService/Help/Api/POST-api-PublishEvents) |
No documentation available.
|
## GatewayCommit
| API | Description |
| --- | --- |
| [POST api/GatewayCommit](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GatewayCommit) |
No documentation available.
|
## GatewayExecuteCommand
| API | Description |
| --- | --- |
| [POST api/GatewayExecuteCommand](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GatewayExecuteCommand) |
No documentation available.
|
## GatewayExecuteCustomCommand
| API | Description |
| --- | --- |
| [POST api/GatewayExecuteCustomCommand](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GatewayExecuteCustomCommand) |
No documentation available.
|
## GatewayReject
| API | Description |
| --- | --- |
| [POST api/GatewayReject](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GatewayReject) |
No documentation available.
|
## GatewayRollback
| API | Description |
| --- | --- |
| [POST api/GatewayRollback](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GatewayRollback) |
No documentation available.
|
## GatewayUpdateRoutes
| API | Description |
| --- | --- |
| [POST api/GatewayUpdateRoutes](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GatewayUpdateRoutes) |
No documentation available.
|
## GatewayUpdateStations
| API | Description |
| --- | --- |
| [POST api/GatewayUpdateStations](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GatewayUpdateStations) |
No documentation available.
|
## GenericSearch
Generic Search Controller.
| API | Description |
| --- | --- |
| [POST api/GenericSearch/Search](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GenericSearch-Search) |
Searches the specified documents.
|
| [POST api/GenericSearch/Document](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GenericSearch-Document) |
Gets the specified category document.
|
| [GET api/GenericSearch/Categories?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-GenericSearch-Categories_applicationName) |
Gets the categories.
|
| [POST api/GenericSearch/Categories?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/POST-api-GenericSearch-Categories_applicationName) |
Gets the categories.
|
## Health
| API | Description |
| --- | --- |
| [GET api/healthcheck?tenantCode={tenantCode}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-healthcheck_tenantCode) |
No documentation available.
|
| [POST api/healthcheck?tenantCode={tenantCode}](https://10.255.255.2/ApplicationService/Help/Api/POST-api-healthcheck_tenantCode) |
No documentation available.
|
| [GET api/ready?tenantCode={tenantCode}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-ready_tenantCode) |
No documentation available.
|
## Metadata
| API | Description |
| --- | --- |
| [GET api/Metadata/Commands](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Commands) |
No documentation available.
|
| [GET api/Metadata/Commands?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Commands_applicationName) |
No documentation available.
|
| [GET api/Metadata/CommandProperties?assemblyFullName={assemblyFullName}&fullName={fullName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-CommandProperties_assemblyFullName_fullName) |
No documentation available.
|
| [GET api/Metadata/CommandsAll](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-CommandsAll) |
No documentation available.
|
| [GET api/Metadata/CommandsAll?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-CommandsAll_applicationName) |
No documentation available.
|
| [GET api/Metadata/Entities](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Entities) |
No documentation available.
|
| [GET api/Metadata/Entities?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Entities_applicationName) |
No documentation available.
|
| [GET api/Metadata/EntityProperties?assemblyFullName={assemblyFullName}&fullName={fullName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-EntityProperties_assemblyFullName_fullName) |
No documentation available.
|
| [GET api/Metadata/EntitiesAll](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-EntitiesAll) |
No documentation available.
|
| [GET api/Metadata/EntitiesAll?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-EntitiesAll_applicationName) |
No documentation available.
|
| [GET api/Metadata/Events](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Events) |
No documentation available.
|
| [GET api/Metadata/Events?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Events_applicationName) |
No documentation available.
|
| [GET api/Metadata/EventProperties?assemblyFullName={assemblyFullName}&fullName={fullName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-EventProperties_assemblyFullName_fullName) |
No documentation available.
|
| [GET api/Metadata/EventsAll](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-EventsAll) |
No documentation available.
|
| [GET api/Metadata/EventsAll?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-EventsAll_applicationName) |
No documentation available.
|
| [GET api/Metadata/Aggregates](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Aggregates) |
No documentation available.
|
| [GET api/Metadata/Aggregates?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-Aggregates_applicationName) |
No documentation available.
|
| [GET api/Metadata/AggregateProperties?assemblyFullName={assemblyFullName}&fullName={fullName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-AggregateProperties_assemblyFullName_fullName) |
No documentation available.
|
| [GET api/Metadata/AggregatesAll](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-AggregatesAll) |
No documentation available.
|
| [GET api/Metadata/AggregatesAll?applicationName={applicationName}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-Metadata-AggregatesAll_applicationName) |
No documentation available.
|
## QueryCommands
| API | Description |
| --- | --- |
| [POST api/QueryCommands](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryCommands) |
No documentation available.
|
## QueryEvents
| API | Description |
| --- | --- |
| [POST api/QueryEvents](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryEvents) |
No documentation available.
|
| [POST api/QueryCommandEvents](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryCommandEvents) |
No documentation available.
|
| [POST api/QueryCorrelationEvents](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryCorrelationEvents) |
No documentation available.
|
## QueryExecute
| API | Description |
| --- | --- |
| [GET api/QueryExecuteStream](https://10.255.255.2/ApplicationService/Help/Api/GET-api-QueryExecuteStream) |
No documentation available.
|
| [POST api/QueryExecuteStream](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryExecuteStream) |
No documentation available.
|
| [POST api/QueryCancel](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryCancel) |
No documentation available.
|
| [POST api/QueriesCancel](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueriesCancel) |
No documentation available.
|
| [POST api/QueryExecute](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryExecute) |
No documentation available.
|
## QueryScalarExecute
| API | Description |
| --- | --- |
| [POST api/QueryScalarExecuteAsync](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryScalarExecuteAsync) |
No documentation available.
|
| [POST api/QueryScalarExecute](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QueryScalarExecute) |
No documentation available.
|
## QuerySnapshots
| API | Description |
| --- | --- |
| [POST api/QuerySnapshots](https://10.255.255.2/ApplicationService/Help/Api/POST-api-QuerySnapshots) |
No documentation available.
|
## Workflow
| API | Description |
| --- | --- |
| [POST api/Workflow/Logon](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-Logon) |
No documentation available.
|
| [POST api/Workflow/GetUserScreen](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetUserScreen) |
No documentation available.
|
| [POST api/Workflow/GetUserScreenInfo](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetUserScreenInfo) |
No documentation available.
|
| [POST api/Workflow/GetUserScreenParameters](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetUserScreenParameters) |
No documentation available.
|
| [POST api/Workflow/GetUserProcessAttributes](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetUserProcessAttributes) |
No documentation available.
|
| [POST api/Workflow/ExecuteUserAction](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-ExecuteUserAction) |
No documentation available.
|
| [POST api/Workflow/ExecuteUserActionGetScreen](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-ExecuteUserActionGetScreen) |
No documentation available.
|
| [POST api/Workflow/TerminateUserSession](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-TerminateUserSession) |
No documentation available.
|
| [POST api/Workflow/Start](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-Start) |
No documentation available.
|
| [POST api/Workflow/GetScreen](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetScreen) |
No documentation available.
|
| [POST api/Workflow/GetScreenParameters](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetScreenParameters) |
No documentation available.
|
| [POST api/Workflow/GetProcessAttributes](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetProcessAttributes) |
No documentation available.
|
| [POST api/Workflow/ExecuteAction](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-ExecuteAction) |
No documentation available.
|
| [POST api/Workflow/ExecuteActionGetScreen](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-ExecuteActionGetScreen) |
No documentation available.
|
| [POST api/Workflow/Terminate](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-Terminate) |
No documentation available.
|
| [POST api/Workflow/GetSessions](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-GetSessions) |
No documentation available.
|
| [POST api/Workflow/ExecuteProcessAction](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-ExecuteProcessAction) |
No documentation available.
|
| [POST api/Workflow/Cancel](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-Cancel) |
No documentation available.
|
| [POST api/Workflow/ExecuteValidateDialogFormat](https://10.255.255.2/ApplicationService/Help/Api/POST-api-Workflow-ExecuteValidateDialogFormat) |
No documentation available.
|
## WorkflowLog
| API | Description |
| --- | --- |
| [GET api/WorkflowLog/GetInstances?processDefinitionId={processDefinitionId}&skip={skip}&take={take}&startDateFrom={startDateFrom}&startDateTo={startDateTo}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-GetInstances_processDefinitionId_skip_take_startDateFrom_startDateTo) |
No documentation available.
|
| [GET api/WorkflowLog/GetInstances?processDefinitionId={processDefinitionId}&skip={skip}&take={take}&startDateFrom={startDateFrom}&startDateTo={startDateTo}&filterAttributeName={filterAttributeName}&filterAttributeValue={filterAttributeValue}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-GetInstances_processDefinitionId_skip_take_startDateFrom_startDateTo_filterAttributeName_filterAttributeValue) |
No documentation available.
|
| [GET api/WorkflowLog/GetInstance?processId={processId}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-GetInstance_processId) |
No documentation available.
|
| [GET api/WorkflowLog/GetLogs?processId={processId}&skip={skip}&take={take}&logDateFrom={logDateFrom}&logDateTo={logDateTo}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-GetLogs_processId_skip_take_logDateFrom_logDateTo) |
No documentation available.
|
| [GET api/WorkflowLog/ValidateInstance?applicationName={applicationName}&processDefinitionId={processDefinitionId}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-ValidateInstance_applicationName_processDefinitionId) |
No documentation available.
|
| [GET api/WorkflowLog/Validate?applicationName={applicationName}&processDefinitionId={processDefinitionId}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-Validate_applicationName_processDefinitionId) |
No documentation available.
|
| [GET api/WorkflowLog/ValidateInstanceByVersionId?applicationName={applicationName}&processVersionId={processVersionId}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-ValidateInstanceByVersionId_applicationName_processVersionId) |
No documentation available.
|
| [GET api/WorkflowLog/ValidateByVersionId?applicationName={applicationName}&processVersionId={processVersionId}](https://10.255.255.2/ApplicationService/Help/Api/GET-api-WorkflowLog-ValidateByVersionId_applicationName_processVersionId) |
No documentation available.
|
docs/api/POST apiQueryExecute.md
+227
View File
@@ -0,0 +1,227 @@
## Request Information
### URI Parameters
None.
### Body Parameters
[QueryExecute](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryExecute)
| Name | Description | Type | Additional information |
| --- | --- | --- | --- |
| Application |
Application name.
| String |
None.
|
| ClientModule |
Client module that executes the query.
| String |
None.
|
| QueryType |
Type of the query.
| [QueryContextType](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryContextType) |
Default: Reading
|
| Expression |
Query expression.
| String |
None.
|
| OrderBy |
Order by to be applied to the expression.
| String |
None.
|
| Select |
Select to be applied to the expression.
| String |
None.
|
| Skip |
Skip to be applied to the expression.
| Int32 |
None.
|
| Take |
Take to be applied to the expression.
| Int32 |
None.
|
| Parameters |
Dictionary with the parameters and their values for the query.
| Dictionary of String \[key\] and [QueryParameterValue](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryParameterValue) \[value\] |
None.
|
| InlineCount |
Indicate if an inline count must be done to the query.
| Boolean |
None.
|
| CommandTimeout |
Gets or sets the command/query timeout.
| Int32? |
None.
|
| QueryId |
Gets or sets the query execution identifier.
| Guid? |
None.
|
### Request Formats
**Sample:**
```
{
"Application": "sample string 1",
"ClientModule": "sample string 2",
"QueryType": 0,
"Expression": "sample string 3",
"OrderBy": "sample string 4",
"Select": "sample string 5",
"Skip": 6,
"Take": 7,
"Parameters": {
"sample string 1": {
"TypeName": "sample string 1",
"Value": {}
},
"sample string 2": {
"TypeName": "sample string 1",
"Value": {}
}
},
"InlineCount": true,
"CommandTimeout": 1,
"QueryId": "e57b9e2d-1ba9-42c7-a035-fe964ce53fd6"
}
```
**Sample:**
Sample not available.
**Sample:**
```
Binary JSON content. See http://bsonspec.org for details.
```
## Response Information
### Resource Description
[QueryResultData](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryResultData)
| Name | Description | Type | Additional information |
| --- | --- | --- | --- |
| InLineCount |
Gets or sets the in line count.
| Int32 |
None.
|
| Table |
Gets or sets the table.
| [QueryTable](https://10.255.255.2/ApplicationService/Help/ResourceModel?modelName=QueryTable) |
None.
|
### Response Formats
**Sample:**
```
{
"InLineCount": 1,
"Table": {
"TableName": "sample string 1",
"Columns": [
{
"ColumnName": "sample string 1",
"TypeName": "sample string 2"
},
{
"ColumnName": "sample string 1",
"TypeName": "sample string 2"
}
],
"Rows": [
null,
{
"Values": {
"sample string 1": {},
"sample string 3": {}
}
}
]
}
}
```
**Sample:**
```
Binary JSON content. See http://bsonspec.org for details.
```
docs/docs_downloads/communications/EasyWMS_WebApi_en.html.md
+4128
View File
File diff suppressed because it is too large Load Diff
docs/docs_downloads/communications/index.md
+52
View File
@@ -0,0 +1,52 @@
## Communications Easy WMS & ERP's
The automation of communications between Easy WMS and the ERP of the customer, or between Easy WMS and the different ERPs in the case of Logistic operators are one of the most efficient ways to minimize unnecessary work.
Easy WMS incorporates a transport or connectivity tool called GNA and a powerful ETL (Extract Transform Load) system to establish communication between Easy WMS and the ERP.
![Diagram with the communications concepts](communications/graphics/gna.jpg)
The **standard modules** consist in closed sets of communications that work fully when you leave the box.
The **communication toolkits** include tools and libraries that help to map communications, but require a customized work for each client to work in production
Using some of this communication modules or toolkits you can integrate satisfactorily Easy WMS and the main ERP systems.
| ERP | Implementations |
| --- | --- |
| SAP | 85 |
| Microsoft Navision | 13 |
| JDEdwards | 8 |
| SAGE Murano | 6 |
| BaaN | 4 |
| SAP Business ONE | 3 |
| Microsoft Axapta | 3 |
| SAGE 100 | 3 |
| SAGE X3 | 3 |
| Oracle Business Suite | 2 |
### Standard communication modules
| Module | Description |
| --- | --- |
| [XML and data base](communications/xmlDB.md) | Easy WMS Communicaction via XML files or data base. |
| [Web-API](communications/web_api.md) | Easy WMS and Web-API communications. |
| [SAP](communications/sap.md) | Easy WMS and SAP communication. |
| [SAGE 200c](communications/sage200c.md) | Easy WMS and SAGE 200c communication. |
| [SAGE X3](communications/sagex3.md) | Easy WMS and SAGE X3 communication. |
| [SAGE 100c](communications/sage100c.md) | Easy WMS and SAGE 100c communication. |
| [Business Central](communications/business_central.md) | Easy WMS and Business Central communication. |
| [Import templates](communications/import_templates.md) | Import Excel templates from SmartUI |
### Communication toolkits
| Toolkit | Description |
| --- | --- |
| [SAP Bussiness ONE](communications/one.md) | SAP Bussines ONE communication toolkit. |
| [EDI](communications/edi.md) | EDI communication toolkit |
## Documentation
| Name | Description |
| --- | --- |
| [ERP\_MAP\_ETL\_Framework\_EN.pdf](docs/ERP_MAP_ETL_Framework_EN.pdf) | MAP communications architecture introduction and the basics of the ETL framework - English. |
docs/docs_downloads/communications/web_api.md
+57
View File
@@ -0,0 +1,57 @@
![easyWMS](https://msscc.mecalux.com/documentation/documentation/master/EN/graphics/mod_labels/easywms.png)
## Standard communications module for Web-API
This document describes the communication interface between EasyWMS and the ERP system.
Communication between these two systems is bidirectional, so two interfaces are defined, import: from the ERP to EasyWMS and export: from EasyWMS to the ERP.
The document [Easy WMS Web API Standard Message Types](communications/EasyWMS_WebApi_en.html.md) details the structure of each Easy WMS standard messages.
## Documentation
| Name | Description |
| --- | --- |
| [EasyWMS\_WebApi\_es\_Online](communications/EasyWMS_WebApi_es.html.md) | Easy WMS and Web-API communications interface - Online version - Spanish |
| [EasyWMS\_WebApi\_en\_Online](communications/EasyWMS_WebApi_en.html.md) | Easy WMS and Web-API communications interface - Online version - English |
| [EasyWMS\_WebApi\_es.pdf](communications/docs/EasyWMS_WebApi_es.pdf) | Easy WMS and Web-API communications interface - PDF - Spanish |
| [EasyWMS\_WebApi\_en.pdf](communications/docs/EasyWMS_WebApi_en.pdf) | Easy WMS and Web-API communications interface - PDF - English |
| [EasyWMS\_WebApi\_es.docx](communications/docs/EasyWMS_WebApi_es.docx) | Easy WMS and Web-API communications interface - DOCX - Spanish |
| [EasyWMS\_WebApi\_en.docs](communications/docs/EasyWMS_WebApi_en.docx) | Easy WMS and Web-API communications interface - DOCX - English |
| [ETL\_JSONGenerator\_manual\_en.pdf](communications/docs/ETL_JSONGenerator_manual_en.pdf) | JSON and schema sample generator User Manual - English - Pdf version |
| [StoreFulfillment\_WebApi\_es.pdf](communications/docs/StoreFulfillment_WebApi_es.pdf) | Store Fulfillment communications interface - Spanish |
| [StoreFulfillment\_WebApi\_en.pdf](communications/docs/StoreFulfillment_WebApi_en.pdf) | Store Fulfillment communications interface - English |
| [StoreFulfillment\_WebApi\_es.zip](communications/docs/StoreFulfillment_WebApi_es.zip) | Store Fulfillment communications interface - Spanish - Md version |
| [StoreFulfillment\_WebApi\_en.zip](communications/docs/StoreFulfillment_WebApi_en.zip) | Store Fulfillment communications interface - English - Md version |
| [MultiCarrierShipping\_WebApi\_es.pdf](communications/docs/MultiCarrierShipping_WebApi_es.pdf) | MultiCarrier Shipping communications interface - Spanish |
| [MultiCarrierShipping\_WebApi\_en.pdf](communications/docs/MultiCarrierShipping_WebApi_en.pdf) | MultiCarrier Shipping communications interface - English |
| [MultiCarrierShipping\_WebApi\_es.zip](communications/docs/MultiCarrierShipping_WebApi_es.zip) | MultiCarrier Shipping communications interface - Spanish - Md version |
| [MultiCarrierShipping\_WebApi\_en.zip](communications/docs/MultiCarrierShipping_WebApi_en.zip) | MultiCarrier Shipping communications interface - English - Md version |
| [Manufacturing\_WebApi\_es\_Online](communications/docs/Manufacturing_WebApi_es.html.md) | Manufacturing and Web-API communications interface - Online version - Spanish |
| [Manufacturing\_WebApi\_en\_Online](communications/docs/Manufacturing_WebApi_en.html.md) | Manufacturing and Web-API communications interface - Online version - English |
| [Manufacturing\_WebApi\_es.pdf](communications/docs/Manufacturing_WebApi_es.pdf) | Manufacturing and Web-API communications interface - PDF - Spanish |
| [Manufacturing\_WebApi\_en.pdf](communications/docs/Manufacturing_WebApi_en.pdf) | Manufacturing and Web-API communications interface - PDF - English |
| [Manufacturing\_WebApi\_es.docx](communications/docs/Manufacturing_WebApi_es.docx) | Manufacturing and Web-API communications interface - DOCX - Spanish |
| [Manufacturing\_WebApi\_en.docx](communications/docs/Manufacturing_WebApi_en.docx) | Manufacturing and Web-API communications interface - DOCX - English |
| [Billing\_WebApi\_es.pdf](communications/docs/Billing_WebApi_es.pdf) | Billing communications interface - Spanish - Pdf version |
| [Billing\_WebApi\_en.pdf](communications/docs/Billing_WebApi_en.pdf) | Billing communications interface - English - Pdf version |
| [Billing\_WebApi\_es.zip](communications/docs/Billing_WebApi_es.zip) | Billing communications interface - Spanish - Md version |
| [Billing\_WebApi\_en.zip](communications/docs/Billing_WebApi_en.zip) | Billing communications interface - English - Md version |
| [Owner Extensions\_WebApi\_es.pdf](communications/docs/OwnerExtensions_WebApi_es.pdf) | Owner Extensions communications interface - Spanish - Pdf version |
| [Owner Extensions\_WebApi\_en.pdf](communications/docs/OwnerExtensions_WebApi_en.pdf) | Owner Extensions communications interface - English - Pdf version |
| [Owner Extensions\_WebApi\_es.zip](communications/docs/OwnerExtensions_WebApi_es.zip) | Owner Extensions communications interface - Spanish - Md version |
| [Owner Extensions\_WebApi\_en.zip](communications/docs/OwnerExtensions_WebApi_en.zip) | Owner Extensions communications interface - English - Md version |
| [Value Added Service\_WebApi\_es.pdf](communications/docs/ValueAddedService_WebApi_es.pdf) | Value Added Service communications interface - Spanish - Pdf version |
| [Value Added Service\_WebApi\_en.pdf](communications/docs/ValueAddedService_WebApi_en.pdf) | Value Added Service communications interface - English - Pdf version |
| [Value Added Service\_WebApi\_es.docx](communications/docs/ValueAddedService_WebApi_es.docx) | Value Added Service communications interface - Spanish - Docx version |
| [Value Added Service\_WebApi\_en.docx](communications/docs/ValueAddedService_WebApi_en.docx) | Value Added Service communications interface - English - Docx version |
| [Value Added Service\_WebApi\_es.zip](communications/docs/ValueAddedService_WebApi_es.zip) | Value Added Service communications interface - Spanish - Md version |
| [Value Added Service\_WebApi\_en.zip](communications/docs/ValueAddedService_WebApi_en.zip) | Value Added Service communications interface - English - Md version |
## Downloads
| Name | Description | Version | Date |
| --- | --- | --- | --- |
| [ETL\_JSONGenerator.zip](communications/downloads/ETL_JSONGenerator.zip) | This package contains JSON and Schemes Examples Generator. | 11.10.25058.1 | 03/11/2025 |
If you have any suggestion or comment on this documentation, please submit it to [documentation@mecalux.com](mailto:documentation@mecalux.com)
docs/docs_downloads/index.md
+27
View File
@@ -0,0 +1,27 @@
## Documents and downloads
MAP (Mecalux Application Paltform) : /map
Communications externes and ERP : /communications
| Tools | Applications | Services |
| --- | --- | --- |
| [](tools/easyb.md "EasyBuilder")EasyBuilder | [](apps/easywms.md "Easy WMS")Easy WMS | [](services/gna.md "GNA")GNA |
| [](tools/easys.md "EasyS")EasyS | [](apps/scem.md "Supply Chain Event Management")Supply Chain Event Management | [](services/printer.md "Printer Service")Label printer |
| [](tools/assistant.md "Easy Assistant")Easy Assistant | [](apps/ecommerce.md "eCommerce")eCommerce | [](services/ptl.md "PTL")PTL |
| [](tools/easym.md "EasyM")EasyM | [](apps/mcs.md "Multi Carrier Shipping Software")Multi Carrier Shipping Software | [](services/voice.md "Voice picking")Voice picking |
| [](tools/ugna.md "uGNA")uGNA | [](apps/manufacturing.md "WMS for Manufacturing")WMS for Manufacturing | [](services/sync.md "Database Sync")Database Sync |
| | [](apps/ps.md "Pallet Shuttle")Pallet Shuttle | [](services/gateway.md "Easy WMS Gateway")Easy WMS Gateway |
| | [](apps/lms.md "Labor Management System")Labor Management System | |
| | [](apps/vas.md "Value Added Services (VAS)")Value Added Services (VAS) | |
| | [](apps/faults.md "Automation Dashboard")Automation Dashboard | |
| | [](apps/sf.md "Store Fulfillment")Store Fulfillment | |
| | [](apps/slotting.md "Slotting for WMS")Slotting for WMS | |
| | [](apps/ym.md "Yard Management")Yard Management | |
| | [](apps/billing.md "3PL Billing")3PL Billing | |
| | [](apps/tplportal.md "3PL Client Portal")3PL Client Portal | |
| | [](apps/directives.md "Directives")Client-Specific Rules | |
| | [](apps/movirack.md "Movirack")Movirack | |
| | [](apps/wwd.md "Web Configurator")Web Configurator | |
| | [](apps/agv.md "AGVs")AGVs | |
| | [](apps/eds.md "External devices")External devices | |
| | [](apps/cobot.md "Cobot")Cobot | |
docs/entities/easywms_reading_entites.md
+17
View File
File diff suppressed because one or more lines are too long
docs/entities/easywms_reading_entites_outboundorder.md
+137
View File
@@ -0,0 +1,137 @@
## 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/Address.md) | 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/OutboundOrderOperation.md). 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/GroupType.md) + 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/OutboundOrderStatus.md). Example: "Creating" |
| OutboundType | string | The outbound order's outbound type. The possible values are the ones in [OutboundType](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/OutboundType.md). 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/Planning.md) | 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/PrepackagingLogic.md). Example: MinimumParcels |
| PrepackagingProcess | string | The pre-packaging type for the outbound order. The possible values are the ones in [PrepackagingProcess](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/PrepackagingProcess.md). Example: Preparation |
| PrepackagingType | string | The pre-packaging type for the outbound order. The possible values are the ones in [PrepackagingType](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/PrepackagingType.md). Example: ERPInformed |
| PrepackagingWorkingMode | string | The pre-packaging working mode for the outbound order. The possible values are the ones in [PrepackagingWorkingMode](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/PrepackagingWorkingMode.md). Example: Strict |
| Priority | string | The outbound order priority. The possible values are the ones in [Priority](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/Priority.md). 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/ShippingRequirements.md) | 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](https://msscc.mecalux.com/documentation/Development/master/ES/apis/easywms/Domain/OutboundOrderTransport.md) | 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](mailto:documentation@mecalux.com)
docs/entities/easywms_reading_entites_outboundorder_OutboundOrderStatus.md
+32
View File
@@ -0,0 +1,32 @@
## OutboundOrderStatus
Full name: **Mecalux.ITSW.EasyWMS.Modules.Common.Domain.OutboundOrderStatus**
## Summary
Represents the status of outbound orders.
## Values
| Name | Value | Description |
| --- | --- | --- |
| Creating | 0 | The outbound order is being created. this will occur when they are created by the ERP or manually through the user interface. |
| Waiting | 1 | The outbound order is waiting to be released. this will occur when the order is correctly received from the ERP or when it's creation is finished manually through the user interface. |
| Release | 2 | The outbound order is release and it's tasks may be generated. An order is released when it is released through the user interface, when it's auto release date is reached, when it is associated with a route with an auto release date which has been reached or when all the lines from the outbound order has been manually released. |
| PartiallyRelease | 3 | The outbound order is partially release and it's tasks may be generated. An order is partially released when one or more lines from the order, always less than it's total lines, has been released. |
| Working | 4 | The outbound order is working. The order will be in this status from the beggining to the end of it's preparation process. To be in this status, one of it's generated tasks must be "In Process" status. |
| PartiallyWorking | 5 | The outbound order is partially working. The order will be in this status from the beggining to the end of it's preparation process. Only the orders with the status "PartiallyRelease" can change to this status. To be in this status, one of it's generated tasks must be "In Process" status. |
| Pausing | 6 | The outbound order is being paused. Not used. |
| Paused | 7 | The outbound order was paused. All it's work has been halted and it's tasks will be cancelled. This can occur when the order has been paused from the user interface. |
| Cancelling | 8 | The outbound order is being cancelled. Not used. |
| Cancelled | 9 | The outbound order was cancelled. All it's work will be halted, it's tasks will be cancelled and the assigned stock to the order will be unassigned |
| Closing | 10 | The outbound order is being closed. Not used. |
| Closed | 11 | The outbound order was closed. The preparation process of it's lines has been finished and the order is ready to ship or already shipped. This will occur when a user close the order through the user interface or when the system is configured to auto close al prepared orders. Also, the order will be archived if the system is configured as well to auto archive closed orders. |
| Expired | 12 | The outbound order is outdated. The outbound order was not released before the valid date. Not used. |
| StockFailure | 13 | The outbound order has all theirs lines on stock failure. An order will be in this status when it has been released and all of it's lines couldn't be assigned |
| Merged | 14 | The outbound order was merged. The orders in this status has been fused through the user interface. |
| Grouped | 15 | The outbound order was grouped. The orders in this status has been grouped through the user interface or automatically from a shipment template configured by the user. |
| Secured | 16 | The outbound order has its stock secured. The orders in this status has been secured through the user interface and has a secured quantity. |
| Assigned | 17 | The outbound order has its stock assigned. The orders in this status has been assigned through the user interface and has a assigned quantity. |
If you have any suggestion or comment on this documentation, please submit it to [documentation@mecalux.com](mailto:documentation@mecalux.com)
docs/getting_started.md
+108
View File
@@ -0,0 +1,108 @@
# MAP - Documentation Portal
## Table des matières
### Documents et téléchargements
- [Documents and downloads](docs_downloads/index.md)
- Accès aux documents et ressources téléchargeables
### Notes de version
- [Release notes](ReleaseNotes.md)
- Historique des versions et changements
### Tutoriels vidéo
- [Video tutorials](video_tutorials/index.md)
- Guides vidéo pour l'utilisation du système
### Newsletter
- [Newsletter](newsletter/index.md)
- Actualités et mises à jour
---
## Informations système
### Architecture
- [Architecture](arquitecture/index.md)
- [SaaS](arquitecture/saas.md)
- Vue d'ensemble de l'architecture système
### Sécurité
- [Security](security/index.md)
- Politiques et protocoles de sécurité
### Exigences matérielles
- [Hardware requirements](hardware_requirements/index.md)
- Configuration matérielle requise
### Mode de licence
- [License mode](license_mode/index.md)
- Informations sur les licences
---
## Fonctionnalités et processus d'entrepôt
### Services à valeur ajoutée
- [Value-Added Services (VAS)](areas/vas/index.md)
### Gestion de la chaîne logistique
- [Supply Chain Event Management](areas/supply_chain_event_management/index.md)
- [Multi Carrier Shipping Software](areas/multi_carrier_shipping/index.md)
### Commerce et fabrication
- [eCommerce](areas/ecommerce/index.md)
- [WMS for Manufacturing](areas/manufacturing/index.md)
- [Marketplaces Integration](areas/marketplaces/index.md)
### Systèmes de gestion
- [Labor Management System (LMS)](areas/labor_management/index.md)
- [Yard Management System (YMS)](areas/yard_management/index.md)
### Automatisation et robotique
- [Pallet Shuttle](areas/pallet_shuttle/index.md)
- [AGVs](areas/agvs/index.md)
- [Movirack](areas/movirack/index.md)
- [Cobot](areas/cobot/index.md)
- [Automation Dashboard](areas/faults_management/index.md)
### Solutions 3PL
- [Store fulfillment](areas/store_fulfillment/index.md)
- [3PL Client Portal](areas/tpl_portal/index.md)
- [3PL Billing](areas/billing/index.md)
- [Client-Specific Rules](areas/directives/index.md)
### Optimisation
- [Slotting for WMS](areas/slotting/index.md)
- [APS3d](areas/aps3d/index.md)
---
## Processus opérationnels
### Réception et stockage
- [Receipts](areas/receptions/index.md) - Processus de réception des marchandises
- [Putaway](areas/putaway/index.md) - Mise en stock des produits
### Préparation et expédition
- [Replenishment](areas/replenishments/index.md) - Réapprovisionnement
- [Picking, shipping](areas/shipping/index.md) - Préparation et expédition des commandes
### Gestion de l'inventaire
- [Layout](areas/layout/index.md) - Configuration de l'entrepôt
- [Inventory management](areas/inventory_management/index.md) - Gestion des stocks
- [Counts](areas/counts/index.md) - Inventaires
- [Kits](areas/kits/index.md) - Assemblage de kits
- [Defragmentation](areas/defragmentation/index.md) - Optimisation de l'espace
### Opérations spéciales
- [Consolidation](areas/consolidation/index.md) - Consolidation des commandes
- [Crossdocking](areas/crossdocking/index.md) - Transfert direct
- [Tense Flow](areas/tense_flow/index.md) - Flux tendu
### Gestion et analyse
- [Reports](areas/reports/index.md) - Rapports
- [Data analytics](areas/data_analytics/index.md) - Tableaux de bord et analyses
- [Tasks](areas/tasks/index.md) - Gestion des tâches