Mecalux/mcp-wms-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7b25e79e98aa645ddf5be9405773762af3ac2cec
mcp-wms-api/docs/docs_downloads/communications/EasyWMS_WebApi_en.html.md
T
Arthur Ria b59cbb3546 version mise à jour par claude , à tester
2026-05-20 09:38:07 +02:00

4128 lines
316 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
EasyWMS\_WebApi\_en
## Web API communications with ERP
- [Introduction](communications/EasyWMS_WebApi_en.html.md#introduction)
- [General considerations](communications/EasyWMS_WebApi_en.html.md#general-considerations)
- [Data format](communications/EasyWMS_WebApi_en.html.md#data-format)
- [Import of messages](communications/EasyWMS_WebApi_en.html.md#import-of-messages)
- [Request access token](communications/EasyWMS_WebApi_en.html.md#request-access-token)
- [Request token response](communications/EasyWMS_WebApi_en.html.md#request-token-response)
- [Refresh access token request](communications/EasyWMS_WebApi_en.html.md#refresh-access-token-request)
- [Request command execution](communications/EasyWMS_WebApi_en.html.md#request-command-execution)
- [Example in C# to export messages by the ERP](communications/EasyWMS_WebApi_en.html.md#example-in-c#-to-export-messages-by-the-erp)
- [Export of messages](communications/EasyWMS_WebApi_en.html.md#export-of-messages)
- [Structure of exported messages from our application](communications/EasyWMS_WebApi_en.html.md#structure-of-exported-messages-from-our-application)
- [Example in C# to import messages by the ERP](communications/EasyWMS_WebApi_en.html.md#example-in-c#-to-import-messages-by-the-erp)
- [Standard message types for Web API communications with ERP](communications/EasyWMS_WebApi_en.html.md#standard-message-types-for-web-api-communications-with-erp)
- [List of messages](communications/EasyWMS_WebApi_en.html.md#list-of-messages)
- [Masters](communications/EasyWMS_WebApi_en.html.md#masters)
- [Imported messages](communications/EasyWMS_WebApi_en.html.md#imported-messages)
- [Items - ITM](communications/EasyWMS_WebApi_en.html.md#items---itm)
- [Item classification - ITC](communications/EasyWMS_WebApi_en.html.md#item-classification---itc)
- [Owners - OWN](communications/EasyWMS_WebApi_en.html.md#owners---own)
- [Carriers - CAR](communications/EasyWMS_WebApi_en.html.md#carriers---car)
- [Accounts - ACC](communications/EasyWMS_WebApi_en.html.md#accounts---acc)
- [Suppliers - SUP](communications/EasyWMS_WebApi_en.html.md#suppliers---sup)
- [Kits - KIT](communications/EasyWMS_WebApi_en.html.md#kits---kit)
- [User statuses - LCK](communications/EasyWMS_WebApi_en.html.md#user-statuses---lck)
- [Receiving](communications/EasyWMS_WebApi_en.html.md#receiving)
- [Imported messages](communications/EasyWMS_WebApi_en.html.md#imported-messages)
- [Receipt orders - ROR](communications/EasyWMS_WebApi_en.html.md#receipt-orders---ror)
- [Advanced shipping notice - ASN](communications/EasyWMS_WebApi_en.html.md#advanced-shipping-notice---asn)
- [Registration of pre-notified stock for replenishment - SRN](communications/EasyWMS_WebApi_en.html.md#registration-of-pre-notified-stock-for-replenishment---srn)
- [Exported messages](communications/EasyWMS_WebApi_en.html.md#exported-messages)
- [Receipt order status change - ROC](communications/EasyWMS_WebApi_en.html.md#receipt-order-status-change---roc)
- [Receipt or receipt order finalization - ROF](communications/EasyWMS_WebApi_en.html.md#receipt-or-receipt-order-finalization---rof)
- [Receipt or receipt order finalization - ROF01](communications/EasyWMS_WebApi_en.html.md#receipt-or-receipt-order-finalization---rof01)
- [Receipt or receipt order finalization - ROF02](communications/EasyWMS_WebApi_en.html.md#receipt-or-receipt-order-finalization---rof02)
- [Receipt end - REF](communications/EasyWMS_WebApi_en.html.md#receipt-end---ref)
- [Advanced shipping notice OK - ASO](communications/EasyWMS_WebApi_en.html.md#advanced-shipping-notice-ok---aso)
- [Advanced shipping notice KO - ASK](communications/EasyWMS_WebApi_en.html.md#advanced-shipping-notice-ko---ask)
- [Replenishment of pre-notified loose stock – SRO](communications/EasyWMS_WebApi_en.html.md#replenishment-of-pre-notified-loose-stock-%E2%80%93-sro)
- [Cancellation of pre-notified loose stock for replenishment – SRK](communications/EasyWMS_WebApi_en.html.md#cancellation-of-pre-notified-loose-stock-for-replenishment-%E2%80%93-srk)
- [Shipping](communications/EasyWMS_WebApi_en.html.md#shipping)
- [Imported messages](communications/EasyWMS_WebApi_en.html.md#imported-messages)
- [Shipping orders - SOR](communications/EasyWMS_WebApi_en.html.md#shipping-orders---sor)
- [Routes - RUT](communications/EasyWMS_WebApi_en.html.md#routes---rut)
- [Work Orders - WOR](communications/EasyWMS_WebApi_en.html.md#work-orders---wor)
- [Exported messages](communications/EasyWMS_WebApi_en.html.md#exported-messages)
- [Shipping order status change - SOC](communications/EasyWMS_WebApi_en.html.md#shipping-order-status-change---soc)
- [Shipping order close or finalization - SOF](communications/EasyWMS_WebApi_en.html.md#shipping-order-close-or-finalization---sof)
- [Shipping order close or finalization - SOF01](communications/EasyWMS_WebApi_en.html.md#shipping-order-close-or-finalization---sof01)
- [Shipping order close or finalization - SOF02](communications/EasyWMS_WebApi_en.html.md#shipping-order-close-or-finalization---sof02)
- [Truck loads finalization - LOF](communications/EasyWMS_WebApi_en.html.md#truck-loads-finalization---lof)
- [Work Order Finalization - WOF](communications/EasyWMS_WebApi_en.html.md#work-order-finalization---wof)
- [Request and notifications](communications/EasyWMS_WebApi_en.html.md#request-and-notifications)
- [Imported messages](communications/EasyWMS_WebApi_en.html.md#imported-messages)
- [Stock status change request - STR](communications/EasyWMS_WebApi_en.html.md#stock-status-change-request---str)
- [Stock count request - SCR](communications/EasyWMS_WebApi_en.html.md#stock-count-request---scr)
- [Count order request - COR](communications/EasyWMS_WebApi_en.html.md#count-order-request---cor)
- [Container Move Confirmation - CMC](communications/EasyWMS_WebApi_en.html.md#container-move-confirmation---cmc)
- [Exported messages](communications/EasyWMS_WebApi_en.html.md#exported-messages)
- [Kitting - KST](communications/EasyWMS_WebApi_en.html.md#kitting---kst)
- [Dekitting – UNK](communications/EasyWMS_WebApi_en.html.md#dekitting-%E2%80%93-unk)
- [Stock variation - STV](communications/EasyWMS_WebApi_en.html.md#stock-variation---stv)
- [Stock status change- STC](communications/EasyWMS_WebApi_en.html.md#stock-status-change--stc)
- [Warehouse stock count - WSC](communications/EasyWMS_WebApi_en.html.md#warehouse-stock-count---wsc)
- [Count order finalization - COF](communications/EasyWMS_WebApi_en.html.md#count-order-finalization---cof)
- [Container output to PS - COS](communications/EasyWMS_WebApi_en.html.md#container-output-to-ps---cos)
- [Client container closed in MP - COC](communications/EasyWMS_WebApi_en.html.md#client-container-closed-in-mp---coc)
- [Suggested ABC Classification - SAC](communications/EasyWMS_WebApi_en.html.md#suggested-abc-classification---sac)
- [Errors](communications/EasyWMS_WebApi_en.html.md#errors)
- [Exported messages](communications/EasyWMS_WebApi_en.html.md#exported-messages)
- [Error message - ERR](communications/EasyWMS_WebApi_en.html.md#error-message---err)
## Introduction
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.
## General considerations
For the exchange of information, communication will be used through REST API services.
For import communications, EasyWMS exposes a REST API endppint that allows executing the different commands that define the communications interface.
Output communications are also defined by an interface that indicates the fields that are sent in each message.
To send the export messages, scripts are provided and can be modified to adapt the message information to your Web API services.
For import and export messages, EasyWMS has some C# classes (POCOs) created following the communications interface, so that they can be used by clients to serialize and deserialize message information.
### Data format
The format of the different fields of both import and export messages will be as follows:
- **bool**. It can take the values: `false` to represent _false_ and `true` to represent _true_.
- **string(N)**. Represents a text string with maximum length N.
- **Enumeration**. Numeric value restricted to certain values. These values will be defined in the field description.
- **DateTime**. Represents a date and time with format `yyyyy-MM-ddTHH:mm:ss.fffffffffK` compatible with ISO 8601. Being
- **yyyyy-MM-dd**. Date in year-month-day format
- **T**. Separator between date and time
- **HH:mm:ss.fffffffff**. Time in 24h format, where `fffffffff` is the ten-millionths of a second.
- **K**. Represents the offset from the UTC time zone (e.g., `+01:00`, `-07:00`). For UTC the value is `Z`.
- **long**. Integer numerical value between -9,223,372,036,854,775,808 and 9,223,372,036,854,775,807 by default.
- **decimal**. Numeric value with decimals between ±1.0 x 10<sup>-28</sup> and ±7.9228 x <sup>28</sup> by default, where the separator of the decimal part is `.`
- **Int32**. Integer numeric value between -2,147,483,648 and 2,147,483,647 by default.
- **Group**. Contains multiple fields.
- **List**. Set of repeating fields.
**Note:** Note that for fields that are non-mandatory, the field may not appear or have a `null` value.
## Import of messages
Our architecture has an identity and access management (IAM) used to control the access to our applications. The service responsible to manage the security is **EasySTS (Security Token Service)**. This service used the **OAuth 2.0** protocol, which forces any application to request an access token and include it in the communication.
On the other hand, to import messages we have an application service which exposes an endpoint called **Command Service** that is responsible for receiving and executing the commands with the information sent.
The steps to send a command to the **Command Service** endpoint are as follows: - Request access token to **EasySTS**. - Send the request by sending the command data to the **Command Service** endpoint.
### Request access token
In order to request the access token it is necessary to add a client in EasySTS. Information on how to do this can be found in the following [link](https://msscc.mecalux.com/documentation/Development/master/ES/map_development_concepts/webapi_services/index.md).
The token request is an **HTTP POST** request handled by the EasySTS:
- EasySTS URL: https://{your\_host}/EasySTS/OAuth/Token
- Request parameters using **application/x-www-form-urlencoded** format:
| Name | Description | Type | Mandatory |
| --- | --- | --- | --- |
| grant\_type | Grant type. Value must be set to **password**. | String | Yes |
| username | User name. | String | Yes |
| password | User password. | String | Yes |
| tenant\_code | Tenant code. | String | Yes |
| language | Language to use. Access token will include this value as a claim. Application Service will use this language to process request. | String | No |
| computer\_name | Client computer name. Used to identify from which computer user/client has been authorized. | String | No |
In addition, you must set the client’s id and password in the basic HTTP authorization header encoded as base64 with the format **user:password**.
For example, for the client **Mecalux** with password **q2w3e4r5t6** it would be:
```
Authorization: Basic Q3VzdG9tQ2xpZW50OnEydzNlNHI1dDY=
```
Request token example:
```
POST /EasySTS/OAuth/Token HTTP/1.1
Host: {your_host}
Content-Type: application/x-www-form-urlencoded
Authorization: Basic TWVjYWx1eDpxMnczZTRyNXQ2
```
### Request token response
The EasySTS returns the following responses to a token request:
- Request accepted (HTTP 200): Properties returned in the JSON response:
| Name | Description | Type |
| --- | --- | --- |
| access\_token | The access token generated by the EasySTS. | String |
| token\_type | Token type. Always the **bearer** type. | String |
| expires\_in | The duration of time the access token is granted for in seconds. | Integer |
| refresh\_token | Token that can be used to obtain another access token. | String |
| id\_token | JWT token that can be used to obtain user information. | String |
| Issuer | Identifier of the service that generates the token. | String |
| ClientId | Identifier of the client that made the token request. | String |
| UserName | Code of the user who made the token request. | String |
| TenantId | Tenant identifier. | String |
Accepted response JSON example:
```
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJ1bmlxd...",
"token_type": "bearer",
"expires_in": 1199,
"refresh_token": "d46Nqzn7PFiGPH6tGlbq8VEQiL7...",
"id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJub25lIn0.eyJ1bmlxd...",
"Issuer": "Mecalux.ITSW.SecurityTokenService",
"ClientId": "Mecalux",
"UserName": "mecalux",
"TenantId": "1fc492a2-316f-471e-bc3d-f9374fc4a301",
}
```
- Request denied (HTTP 400 or HTTP 401): Properties returned in the JSON response:
| Name | Description | Type |
| --- | --- | --- |
| error | Error code. | String |
| error\_description | Error description. | String |
The error code can be one of these values: - invalid\_request: A request parameter is not informed and the service cannot execute the request. - invalid\_client: The authentication of the client informed in the request is not valid because the client does not exist. In this case, an HTTP 401 response is returned. - unauthorized\_client: The authentication of the client informed in the request is not valid because the password is incorrect. - invalid\_grant: The user is locked or has an expired password. - unsupportedgranttype: The type of access specified in the request is not valid.
Denied response JSON example:
```
/invalid license (expired
or missing web service
module)
{
"error": "invalid_grant",
"error_description": "InvalidLicense"
}
/invalid tenant
{
"error": "invalid_request",
"error_description": "Tenant not
found"
}
/invalid client secret
{
"error": "unauthorized_client",
"error_description": "Client secret is
invalid."
}
/invalid user password
{
"error": "invalid_grant",
"error_description": "InvalidUserPassword"
}
```
### Refresh access token request
Access tokens have limited lifetimes. If your application needs access beyond the lifetime of a single access token, you can use the refresh token. Refresh token allows your application to obtain new access token without having to specify username/password again.
Refresh access token request is a **HTTP POST** request to the EasySTS, using OAuth 2.0 refresh token grant, and may include some optional parameter.
- EasySTS token URL (https required): ‘https://{your\_host}/EasySTS/OAuth/Token’
- Parameters sent using the **application/x-www-form-urlencoded** format:
| Name | Description | Type | Mandatory |
| --- | --- | --- | --- |
| grant\_type | Access type. It should always be set to **password**. | String | Yes |
| refresh\_token | Refresh token valid and not expired. | String | Yes |
| forcerevoke | Indicates whether the refresh token should be revoked. It is revoked if is not informed. | String | Not |
Request example:
```
POST /EasySTS/OAuth/Token HTTP/1.1
Host: localhost
Content-Type: application/x-www-form-urlencoded
Authorization: Basic TWVjYWx1eDpxMnczZTRyNXQ2
```
### Request command execution
The application service defines a Web API endpoint that receive requests for executing commands. This Web API endpoint is called **CommandExecute** and receives the following parameters:
- Command Service URL: https://{your\_host}/ApplicationService/api/CommandExecute
- Request parameters using the **application/json** format:
| Name | Description | Type |
| --- | --- | --- |
| Id | Command identificator | Guid |
| Name | Command internal name | String |
| Properties | Command properties and their values | Dictionary of String \[key\] and Object \[value\] |
Example of a request to send the **OWN01** message:
```
POST /ApplicationService/api/CommandExecute HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1Qi...
```
The response returned by the endpoint can be one of the following:
- **Successful response** when return code is HTTP 200, is an object with commands warning messages if any:
```
[
{
"CommandId": "c9e21124-70e8-4075-8209-ef06aee51ebf",
"WarningMessages": []
}
]
```
- **Unsuccessful response** when return code is HTTP 401, when no token or invalid token is sent.
- **Unsuccessful response** when return code is HTTP 500, is an ‘Exception’ object. C# clients can hanlde it as a ‘System.Exception’. In other cases message can be checked using ‘Message’ property.
```
{
"Message": "Report does not
exist"
}
```
**Note**: Error messages language will be the token language. Token language can be specified using ‘language’ parameter in token request.
### Example in C# to export messages by the ERP
We currently have available to our clients some classes generated in C# that can be used to do message requests to the **CommandExecute** service.
Each of the import messages defined in the communications interface has its own class that defines the properties necessary to do the request.
These classes have the same name as the communication interface message which they are related.
The structure of these classes can be seen in the following example:
```
public class
OWN01
{
public Guid Id { get; set; }
public string Name = "Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.OwnerErpCommand,
Mecalux.ITSW.EasyWMS.Modules.Contracts";
[JsonIgnore]
public OWN01Data
Data { get; set; }
public
Dictionary<string, object> Properties
{
get { return Data.ToDictionary(); }
}
}
```
The previous example is related with the class of the owner message (OWN01). Its properties are the following:
| Name | Description |
| --- | --- |
| Id | Command identificator. Used to identify the command in the warnings of the response |
| Name | Internal name of the command to execute |
| Data | Class that contains the properties of the command defined in the **Name** property. Property marked to be not serialized on request |
| Properties | Dictionary created from **Data** property |
Following is detailed the use of this class to send the OWN01 message to the **CommandExecute** defined in the application service.
The first step to send a message is create an instance of the OWN01 class and fill it with its data:
```
public OWN01 CreateOWN01Data()
{
return new OWN01()
{
Id =
Guid.NewGuid(),
Data = new OWN01Data()
{
Code =
"Owner1",
Operation = ErpOperation.Create,
IgnoreNulls = true,
Data =
new OwnerErpData()
{
Address = new ErpAddress()
{
AddressLine = "AddressLine",
State = "State"
},
Description = "Description",
Contact = new ErpContact()
{
Comment = "Comment"
},
CustomAttribute = new ErpCustomAttribute()
{
Attribute1 = "Attribute1"
}
}
}
};
}
```
Next the code to request and parse the token to send the message to Application Service:
```
public async Task<HttpResponseMessage> GetToken()
{
Dictionary<string, string> dictionary = new Dictionary<string, string>();
dictionary.Add("grant_type",
"password");
dictionary.Add("username",
userName);
dictionary.Add("password",
pass);
dictionary.Add("tenant_code",
tenant);
try
{
HttpClient client = new HttpClient();
var
byteArray = Encoding.UTF8.GetBytes($"{clientId}:{clientPass}");
client.DefaultRequestHeaders
.Accept
.Add(new MediaTypeWithQualityHeaderValue("application/x-www-form-urlencoded"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(byteArray));
var
response = await client.PostAsync(new Uri("https://applicationHost/EasySTS/OAuth/Token"), new FormUrlEncodedContent(dictionary));
return
response;
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
throw
ex;
}
}
public string GetTokenFromResponse(Task<HttpResponseMessage> tokenResponse)
{
string token
= string.Empty;
using (Stream receiveStream = tokenResponse.Result.Content.ReadAsStreamAsync().Result)
{
StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
string
response = readStream.ReadToEnd();
JObject joResponse = JObject.Parse(response);
JToken ojObject = joResponse["access_token"];
token =
ojObject.Value<string>();
}
return
token;
}
```
Finally, we can do the request to the **CommandExecute** service:
```
public static HttpClient GetClient(string accessToken)
{
HttpClient client = new HttpClient();
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Add("Authorization", "Bearer " + accessToken);
return
client;
}
public async
Task<IEnumerable<string>> ExecuteCommandAsync()
{
/Request a token and
parse it
Task<HttpResponseMessage> tokenResponse = GetToken();
string token
= GetTokenFromResponse(tokenResponse);
/Preparing the client
to send the message
using (HttpClient client = GetClient(token))
{
try
{
/Fill the
OWN01 message and enqueue it
OWN01 ownCommand = CreateOWN01Data();
Queue<OWN01> cmd = new
Queue<OWN01>();
cmd.Enqueue(ownCommand);
/Send the
message
using
(var response = await client.PostAsJsonAsync("https://applicationHost/applicationservice/api/CommandExecute",
cmd))
{
if
(response.StatusCode == System.Net.HttpStatusCode.InternalServerError)
{
AggregateException
exception = response.Content.ReadAsStringAsync().Exception;
throw exception;
}
response.EnsureSuccessStatusCode();
return null;
}
}catch(Exception ex)
{
throw
ex;
}
}
}
```
## Export of messages
The system is prepared to communicate messages to the ERP.
There is no endpoint for exporting messages. This is done by the **GNA** application that is responsible for processing the transactions generated by EasyWMS and communicating them to the ERP. The ERP must expose and endpoint to which **GNA** will send the exported messages.
In [Imple mentation documentation](https://msscc.mecalux.com/documentation/Implementation/master/ES/deployment/Gna/gna_config/webapi/index.md) you can get information on how to **deploy GNA** for **Web API**.
The tasks performed by the GNA are the following: - Search the transactions to process. - Transform the transaction information to comply with the defined interface. - Send the message to the ERP endpoint.
The GNA performs these actions by executing some scripts where the communications are implemented.
The structure of the classes that the ERP must use to deserialize the received messages is detailed below.
### Structure of exported messages from our application
All messages exported by EasyWMS have the same structure:
| Name | Description |
| --- | --- |
| MessageType | Message type sent (for example, SOC01) |
| Messages | List of messages sent |
Below we can see the JSON schema for the message **SOC01**:
```
{
"$schema": "http:/json-schema.org/draft-04/schema#",
"title": "SOC01",
"type": "object",
"additionalProperties": false,
"properties": {
"MessageType": {
"type": [
"null",
"string"
]
},
"Messages": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/ShippingOrderStatusChange"
}
}
},
"definitions": {
"ShippingOrderStatusChange": {
"type": "object",
"additionalProperties": false,
"required": [
"Site",
"SorCode",
"Status",
"UpdateDate"
],
"properties": {
"Site": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"SorCode": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"Status": {
"type": "string",
"minLength": 1
},
"UpdateDate": {
"type": "string",
"format": "date-time",
"minLength": 1
}
}
}
}
}
```
An example of JSON for the **SOC01** message:
```
{
"MessageType": "SOC01",
"Messages": [
{
"SorCode": "SORDER01",
"Site": "KITDEMO",
"UpdateDateString": "2021-04-07T09:51:15Z",
"Status": "Waiting",
"UpdateDate": "2021-04-07T09:51:15Z"
},
{
"SorCode": "SORDER02",
"Site": "KITDEMO",
"UpdateDateString": "2021-04-07T09:51:16Z",
"Status": "Waiting",
"UpdateDate": "2021-04-07T09:51:16Z"
}
]
}
```
### Example in C# to import messages by the ERP
The ERP client can use the provided classes in the implementation of its Web API services to deserialize the requests from the communications scripts.
These classes, like input messages, are named as the export message which they are related.
Next, we can see an example of the class to serialize the `SOC01` message:
```
public class SOC01
{
public string MessageType { get;
set; }
public
IList<ShippingOrderStatusChange> Messages { get; set; }
}
public partial class ShippingOrderStatusChange
{
// <summary xml:lang="en">
// Warehouse code
of the shipping order
// </summary>
// <summary xml:lang="es">
// Código del
almacén desde el que se envió la orden de salida
// </summary>
[Required]
[MaxLength(50)]
public
string Site { get;
set; }
// <summary xml:lang="en">
// Shipping order
code
// </summary>
// <summary xml:lang="es">
// Código de la
orden de salida
// </summary>
[Required]
[MaxLength(50)]
public
string SorCode { get;
set; }
// <summary xml:lang="en">
// Current status
of the shipping order. Possible values: Secured, Waiting, Assigned, Release, Working, Paused, StockFailure, Merged,
Grouped
// </summary>
// <summary xml:lang="es">
// Estado en el
que se encuentra actualmente la orden. Posibles valores: Secured, Waiting, Assigned, Release, Working, Paused,
StockFailure, Merged, Grouped
// </summary>
[Required]
public
string Status { get;
set; }
// <summary xml:lang="en">
// UTC date and
time of the status change of the shipping order
// </summary>
// <summary xml:lang="es">
// Fecha y hora
en horario UTC en la que se produjo el cambio de estado de la orden de salida
// </summary>
public
DateTime UpdateDate { get; set; }
}
```
Next, we can see an example of a service implemented in .Net Core to receive requests with the `SOC01` message:
```
[Route("api/[controller]")]
[ApiController]
public class TestController : ControllerBase
{
private readonly ILogger<TestController> _logger;
public TestController(ILogger<TestController> logger)
{
_logger =
logger;
}
[HttpGet]
public bool IsAvailable()
{
return
true;
}
[HttpPost]
public async
Task<ActionResult<SOC01>> SendSOC01(SOC01 soc01)
{
await Task.Run(() => _logger.LogInformation(soc01.ToString()));
return
AcceptedAtAction(nameof(SendSOC01));
}
}
```
## Standard message types for Web API communications with ERP
### List of messages
Below is a list of the different types of messages in the communications interface, highlighting whether they will be received in the import (from ERP to our applications), or sent in the export (from our applications to ERP).
| MASTERS | IMPORT / EXPORT |
| --- | --- |
| [ITM](communications/EasyWMS_WebApi_en.html.md#items---itm) - Items | Import |
| [ITC](communications/EasyWMS_WebApi_en.html.md#item-classification---itc) - Item classifications | Import |
| [OWN](communications/EasyWMS_WebApi_en.html.md#owners---own) - Owners | Import |
| [CAR](communications/EasyWMS_WebApi_en.html.md#carriers---car) - Carriers | Import |
| [ACC](communications/EasyWMS_WebApi_en.html.md#accounts---acc) - Accounts | Import |
| [SUP](communications/EasyWMS_WebApi_en.html.md#suppliers---sup) - Suppliers | Import |
| [KIT](communications/EasyWMS_WebApi_en.html.md#kits---kit) - Kits | Import |
| [LCK](communications/EasyWMS_WebApi_en.html.md#user_status---lck) - User status | Import |
| RECEIVING | IMPORT / EXPORT |
| --- | --- |
| [ROR](communications/EasyWMS_WebApi_en.html.md#receipt-orders---ror) - Receipt orders | Import |
| [ASN](communications/EasyWMS_WebApi_en.html.md#advanced-shipping-notice---asn) - Advanced shipping notice | Import |
| [SRN](communications/EasyWMS_WebApi_en.html.md#registration-of-pre-notified-stock-for-replenishment---srn) - Advanced stock notice for replenishment | Import |
| [ROC](communications/EasyWMS_WebApi_en.html.md#receipt-order-status-change---roc) - Receipt order status change | Export |
| [ROF](communications/EasyWMS_WebApi_en.html.md#receipt-or-receipt-order-finalization---rof) - Receipt or receipt order finalization | Export |
| [REF](communications/EasyWMS_WebApi_en.html.md#receipt-end---ref) - Receipt End | Export |
| [ASO](communications/EasyWMS_WebApi_en.html.md#advanced-shipping-notice-ok---aso) - Advanced shipping notice OK | Export |
| [ASK](communications/EasyWMS_WebApi_en.html.md#advanced-shipping-notice-ko---ask) - Advanced shipping notice KO | Export |
| [SRO](communications/EasyWMS_WebApi_en.html.md#replenishment-of-pre-notified-loose-stock-%E2%80%93-sro) - Replenishment of pre-notified loose stock | Export |
| [SRK](communications/EasyWMS_WebApi_en.html.md#cancellation-of-pre-notified-loose-stock-for-replenishment-%E2%80%93-srk) - Cancellation of pre-notified loose stock for replenishment | Export |
| SHIPPING | IMPORT / EXPORT |
| --- | --- |
| [SOR](communications/EasyWMS_WebApi_en.html.md#shipping-orders---sor) - Shipping orders | Import |
| [RUT](communications/EasyWMS_WebApi_en.html.md#routes---rut) - Routes | Import |
| [WOR](communications/EasyWMS_WebApi_en.html.md#work-orders---wor) - Work orders | Import |
| [SOC](communications/EasyWMS_WebApi_en.html.md#shipping-order-status-change---soc) - Shipping order status change | Export |
| [SOF](communications/EasyWMS_WebApi_en.html.md#shipping-order-close-or-finalization---sof) - Shipping order close or finalization | Export |
| [LOF](communications/EasyWMS_WebApi_en.html.md#truck-loads-finalization---lof) - Truck load finalization | Export |
| [WOF](communications/EasyWMS_WebApi_en.html.md#work-order-finalization---wof) - Work Order finalization | Export |
| REQUESTS AND NOTIFICATIONS | IMPORT / EXPORT |
| --- | --- |
| [STR](communications/EasyWMS_WebApi_en.html.md#stock-status-change-request---str) - Stock status change request | Import |
| [SCR](communications/EasyWMS_WebApi_en.html.md#stock-count-request---scr) - Stock count request | Import |
| [COR](communications/EasyWMS_WebApi_en.html.md#count-order-request---cor) - Request for counting order | Import |
| [CMC](communications/EasyWMS_WebApi_en.html.md#container-move-confirmation---cmc) - Container Move Confirmation | Import |
| [KST](communications/EasyWMS_WebApi_en.html.md#kitting---kst) - Kit stock assembled | Export |
| [UNK](communications/EasyWMS_WebApi_en.html.md#dekitting-%E2%80%93-unk) - Kit stock disassembled | Export |
| [STV](communications/EasyWMS_WebApi_en.html.md#stock-variation---stv) - Stock variation | Export |
| [STC](communications/EasyWMS_WebApi_en.html.md#stock-status-change--stc) - Stock status change | Export |
| [WSC](communications/EasyWMS_WebApi_en.html.md#warehouse-stock-count---wsc) - Warehouse inventory | Export |
| [COF](communications/EasyWMS_WebApi_en.html.md#count-order-finalization---cof) - Warehouse stock count | Export |
| [COS](communications/EasyWMS_WebApi_en.html.md#container-output-to-ps---cos) - Container output to PS | Export |
| [COC](communications/EasyWMS_WebApi_en.html.md#client-container-closed-in-mp---coc) - Client container closed in MP | Export |
| [SAC](communications/EasyWMS_WebApi_en.html.md#suggested-abc-classification---sac) - Suggested ABC classification | Export |
| ERRORS | IMPORT / EXPORT |
| --- | --- |
| [ERR](communications/EasyWMS_WebApi_en.html.md#error-message---err) - Error message | Export |
### Masters
#### Imported messages
Messages that will be received in Import direction (from the ERP to MAP).
##### Items - ITM
**Message type**: ITM (Item)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.ProductErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows to create, modify, delete and upsert the items that can be stored in the warehouse.
- An item deletion can only be done if there is no data in the current warehouse data related to that item:
- No stock of that item in the warehouse (including ASN, buffers, etc…)
- The item is not a component of any kit
- There are no inbound or Shipping order delivery notes for that item
- There are no pending counts for that item
- When deleting, not all data is necessary, but only primary key data (marked in red).
- The 0..1 and 1 groups indicated in the structure that refers to other entities of Easy WMS will only allow a creation (no modifications or deletions) or changing the field value to refer to another entity already existing in Easy WMS. For example:
- A new item is received with a new unit of measurement as base unit. Both the item and the unit of measurement are created.
- A modification of the item is received. This modification has the base unit set to null, but the attribute ignoreNull is set to true. The base unit of the item will not be changed, only the other changes in the modification will be applied.
- A modification of the item is received. This modification has the base unit set to another new unit of measurement. The new unit of measurement will be created, and set as the base unit of the item. Then, in Easy WMS there will be two units of measurement, as the first one created is not deleted, the item does just not reference it.
To delete or modify entities of these 0..1 and 1 groups the Easy WMS PC application must be used.
- The 0..n groups(AlternativeItems,AliasesandConversions) has a complete attribute, which indicates whether all the existing elements are included into the group (when true), or only the modified ones (when false):
- When the complete attribute has a false (0) value: Only the specific elements of the group will be modified, other possible existing elements maintains its previous value.
- When the complete has true(1) value: The message has to include all group elements, because operations set in the groups elements will be performed and after that any other element will be deleted of Easy WMS. E.g.:
- A new item is sent with one alias on it ->item and alias objects are created into the Easy WMS system
- A modification of the Description data field is sent, and the Aliases group has true ignoreNull attribute -> item description is updated, and alias kept its previous values
- A new ITM message is sent, creating a new Alias with the complete attribute set to true ->the new alias will be created but the old one deleted, so the item will have only one alias in the Easy WMS system.
- An entity can only be deleted when is not referenced by any other entity in Easy WMS, even when it is inside a group like AlternativeItem or Conversions. For example, if a unit of measurement of a Conversion is used in an AlternativeItem, that AlternativeItem must be deleted prior to deleting the Conversion. If an Item message is received without that Conversion, and the AlternativeItem still exist, an error will be thrown.
- Creating an element and using it below in the same message is supported. E.g.:
- Inside an ITM message a new UoM is created, and then used forward to define a new Conversion into the item.
- An Alias can only be assigned to one Item or Conversion. If Easy WMS receives an ITM message where an existing Aliasis assigned to another Item or Conversion, an error will be thrown.
- Every single item has a base Alias that is named the same. It is not allowed to delete this base Alias, it will be automatically deleted when the item is deleted
**Structure**:
**ITM**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | |
| **Operation** | **Yes** | Enumeration | Operation to be executed. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| **Code** | **Yes** | string(50) | Item Code |
| NewCode | No | string(50) | New item Code (only in case of modification) |
| OwnerCode | No | string(50) | Code of the item stock owner (required only if need to create or if there are more than one owners and none of them are default owner) |
| Data | No | Group | Data about the product. Contains all necessary data to define a product from the ERP |
| | NewOwnerCode | No | string(50) | New item stock owner code in a modification |
| | OwnerDescription | No | string(65) | Owner description |
| | Description | No | string(1000) | Item description |
| | AlternativeDescription | No | string(1000) | Alternative item extra description |
| | ShortDescription | No | string(65) | Item short description |
| | HandlingDescription | No | string(1000) | Item handling description |
| | PickingMessage | No | string(65) | Picking warning message for this item |
| | ImageName | No | string(50) | Item image file name (extension included) |
| | StockLabeled | No | bool | When true, a barcode is included in the stock label. |
| | **UoMBaseCode** | **Yes** | string(50) | Item base UoM (unit of measure). (If a non-existing value is included, it will be added to the system). |
| | UoMBaseDescription | No | string(65) | Description of the UoM. (Only one new unit of measure will be taken into account when registering a new unit of measure. If the unit of measurement already exists, it is ignored). |
| | UoMCustomAttribute | No | Group | Custom attributes for the product’s base unit of measure. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | MaterialABCCode | No | string(50) | Code of ABC classification |
| | MaterialABCDescription | No | string(65) | Description of the new ABC classification |
| | ProductTypeCode | No | string(50) | Item type |
| | IsPacking | No | bool | Boolean value to indicate that the product is a packaging (true 1) or not (false 0) |
| | IsBulky | No | bool | Boolean value to indicate that this is a bulky item (true 1) or not (false) |
| | Stack | No | long | Maximum level for the item to be placed in a client container; the lower the number, the lower may be the placement of the item inside the container |
| | ProductTypeDescription | No | string(65) | Item type description |
| | ProductFamilyCode | No | string(50) | Code of the Logistic Profile of the Item |
| | ProductFamilyDescription | No | string(65) | Item Family description |
| | Profiles | No | Group | Item profiles |
| | | LogisticProfileCode | No | string | Code for the product’s logistic profile. If its value does not exist in the system the new logistic profile must be created. |
| | | LogisticProfileDescription | No | string | Description for the product’s logistic profile. It will only be taken into account when creating a new logistic profile. |
| | | ReceptionProfileCode | No | string | Code for the product’s reception profile. If not indicated and there is not a default reception profile an error will be generated. |
| | | ReceptionProfileDescription | No | string | Description for the product’s reception profile. It will only be taken into account when creating a new logistic profile. |
| | | PutAwayProfileCode | No | string | Code for the product’s putaway profile. If its value does not exist in the system the new logistic profile must be created. |
| | | PutAwayProfileDescription | No | string | Description for the product’s putaway profile. It will only be taken into account when creating a new putaway profile. |
| | | ShippingProfileCode | No | string | Code for the product’s shipping profile. If not indicated and there is not a default shipping profile an error will be generated. |
| | | ShippingProfileDescription | No | string | Description for the product’s shipping profile. It will only be taken into account when creating a new shipping profile. |
| | | CuttingProfileCode | No | string | Description for the product’s cutting profile. It will only be taken into account when creating a new cutting profile. |
| | | CuttingProfileDescription | No | string | Description for the product’s cutting profile. It will only be taken into account when creating a new cutting profile. |
| | | CountProfileCode | No | string | Description for the product’s count profile. It will only be taken into account when creating a new count profile. |
| | | CountProfileDescription | No | string | Description for the product’s count profile. It will only be taken into account when creating a new count profile. |
| | HazardCode | No | string(50) | Item Hazard code |
| | HazardDescription | No | string(65) | Hazard description |
| | StockClassificationByZoneCode | No | string(50) | Code of the classification per subwarhouse that will apply to the item |
| | StockClassificationByZoneDescription | No | string(65) | Description of the new subwarhouse classification that has been created |
| | MinCuttingQuantity | No | decimal | Gets or sets the min cutting quantity for products with cuttingProfile. |
| | MaxShippingQuantityPerLine | No | decimal | Gets or sets the max shipping quantity per line for products with cuttingProfile. |
| | MaxPartitionsAllowed | No | long | Gets or sets the max partitions allowed for products. |
| | MinTemperature | No | decimal | Item minimum recommended temperature |
| | MaxTemperature | No | decimal | Item maximum recommended temperature |
| | MinWarningQuantity | No | decimal | Item minimum stock quantity (in base UoM) below which will be notified |
| | MaxWarningQuantity | No | decimal | Item maximum stock quantity (in base UoM) above which will be notified |
| | AllowCrossdocking | No | bool | Boolean value allowing crossdocking (true 1) or not (false 0) |
| | AllowCommingle | No | bool | Boolean value allowing store mixing (true 1) or not (false 0) |
| | AliasList | No | List | List of alias for this product |
| | | Operation | No | Enumeration | Operation to perform with Alias data.
When modifying or deleting(1: Update, 3: UPSERT, 2: Delete) AliCode has to be an existing code in Easy WMS related to the item code. When creating(0: Create, 3: UPSERT) AliCode has to be a new code in Easy WMS.
Any other case notifies an error. |
| | | Code | No | string(50) | Alias code of actual item. For this alias owner will be set equal than item’s, and UoM will be set as null. |
| | | NewCode | No | string(50) | New alias code. Base alias code(equals to item code) is not allowed to be modified. |
| | | CustomAttribute | No | Group | Custom attributes for the alias |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | TransactionalAliasList | No | bool | Mandatory boolean group attribute. When true, a single error rolls back every element process: when false, element errors are handled separately. |
| | CompleteAliasList | No | bool | Mandatory boolean group attribute. When true, list group contains every single element, and not listed elements will be deleted. When false only modified elements are included into the list group. |
| | ConversionList | No | List | List of conversions corresponding to this product |
| | | Operation | No | Enumeration | Operation to perform with Product Packs data.
Only not referenced productpacks in Easy WMS can be deleted.
Otherwise, an error will be notified. |
| | | UoMCode | No | string(50) | Unit of Measure conversion Code. (If a non-existing value is included, the new UoM will be registered in Easy WMS). |
| | | UoMDesc | No | string(1000) | Unit of Measure conversion description. (It will only be taken into account when a new unit of measure is added. If the unit of measurement already exists, it is ignored). |
| | | CustomAttribute | No | Group | Custom attributes for the product conversion. |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | | Quantity | No | decimal | Item quantity (in base UoM) corresponding to the new UoM. The quantity must be greater than or equal to 1. It would be 1 when it is similar to the base UoM. |
| | | Stack | No | long | Maximun level to put the pack in a container. |
| | | AliasCode | No | string(50) | Product pack alias code. Owner and UoM are set as in Item. Only one Product pack by alias and UoM is permitted. |
| | | Weight | No | decimal | Expected exact weight for the Product pack. Value must be greather than zero. |
| | | MaxWeight | No | decimal | Maximum weight for the Product pack. Value must be greather than zero. |
| | | MinWeight | No | decimal | Minimum weight for the Product pack. Value must be greather than zero. |
| | | ImageName | No | string(50) | Image file name (extension included) |
| | | PreparationTime | No | long | Expected preparation time |
| | | IsVirtual | No | bool | When true, the Product pack is only permitted to transform quantities in order lines.
When false, the stock can be stored and handled in this product pack.
Default value is false. |
| | | AvoidConsolidation | No | bool | It indicates if the item, in the indicated version, avoid consolidation |
| | | SingleParcel | No | bool | It indicates if the item, in the indicated version, must be only pre-packed |
| | | Dimensions | No | Group | Dimensions information about the product conversion (Height, Width, Length and Volume) |
| | | | Height | No | decimal | Height |
| | | | Length | No | decimal | Length |
| | | | Width | No | decimal | Width |
| | | | Volume | No | decimal | Volume |
| | | ContainerList | No | List | List of container types corresponding to this conversio |
| | | | Operation | No | Enumeration | Operation to perform with product pack containers |
| | | | Type | No | string(50) | Container type used to store the Product packs stock |
| | | | CompleteQuantity | No | decimal | Complete quantity for the container and this Product pack |
| | | | MinCompletePercent | No | long | Complete quantity percent excess for negative picking. Default value: 55. |
| | | | PickingPercent | No | long | Complete quantity stock picking percent excess for negative picking. Default value: 50. |
| | | | CompleteContainerHeight | No | decimal | Height that the complete container reaches. The value must be greater than 0. |
| | | | MinCompletePercentForShipping | No | long | Percentage over the complete container quantity for a container to be shipped instead of picked. Default value: 100. |
| | | | AllowExceedCompleteQuantity | No | bool | If 1(true) indicates that the user is allowed to enter more than the amount that goes in the full container. The default value is 0 (false). |
| | | TransactionalContainerList | No | bool | Mandatory boolean group attribute. When true, a single error rolls back every element process: when false, element errors are handled separately. |
| | | CompleteContainerList | No | bool | Mandatory boolean group attribute. When true, list group contains every single element, and not listed elements will be deleted. When false only modified elements are included into the list group. |
| | | IsPresentation | No | bool | When true, the Product pack is also a Product presentation |
| | | ConversionPresentation | No | Group | Presentation of the conversion, in case IsPresentation is true |
| | | | ExpeditionMinimumQuantity | No | decimal | Minimum quantity for an expedition. It must be greater than 0 |
| | | | SaleMinimumQuantity | No | decimal | Minimum quantity for a sale. It must be greater than 0 |
| | | | Cost | No | decimal | Cost of the presentation. It must be greater than 0 |
| | | | Currency | No | string | Cost currency |
| | | | StartingLockDate | No | DateTime | Start lock date |
| | | | EndingLockDate | No | DateTime | End lock date |
| | | | MinWarningQuantity | No | decimal | Conversion’s minimum quantity to issue a warning message. It must be greater than 0 |
| | | | MaxWarningQuantity | No | decimal | Conversion’s maximun quantity to issue a warning message. It must be greater than 0 |
| | | AllowSplitPresentation | No | bool | When true, Product presentation can be split in smaller ones. |
| | | SplitPack | No | string(50) | Product pack in which can be split the presentation |
| | | Customs | No | Group | Customs related codes |
| | | | HSCode | No | string | |
| | TransactionalConversionList | No | bool | Mandatory boolean group attribute. When true, a single error rolls back every element process: when false, element errors are handled separately. |
| | CompleteConversionList | No | bool | Mandatory boolean group attribute. When true, list group contains every single element, and not listed elements will be deleted. When false only modified elements are included into the list group. |
| | AlternativeProductList | No | List | List of alternative products |
| | | Operation | No | Enumeration | Operation to perform with the specific |
| | | Code | No | string(50) | Substitutive item code |
| | | Sequence | No | long | Priority order to replace main item |
| | | QuantityFrom | No | decimal | Item quantity allowed to be replaced by an substitutive item |
| | | UoMCodeFrom | No | string(50) | Item quantity allowed to be replaced by an substitutive item |
| | | QuantityTo | No | decimal | Substitutive item quantity that is replacing the original |
| | | UoMCodeTo | No | string(50) | AltItemQuantityTo used UoM |
| | | StartDate | No | DateTime | Substitutive items allowed start date |
| | | EndDate | No | DateTime | Substitutive items allowed end date |
| | TransactionalAlternativeProductList | No | bool | Mandatory boolean group attribute. When true, a single error rolls back every element process: when false, element errors are handled separately. |
| | CompleteAlternativeProductList | No | bool | Mandatory boolean group attribute. When true, list group contains every single element, and not listed elements will be deleted. When false only modified elements are included into the list group. |
| | CustomAttribute | No | Group | Custom attributes for the product. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | UomPickCode | No | string | Code for the unit of measure to use in the picking process |
| | DefaultReplenishCapacity | No | decimal | Gets the default replenish capacity for this product in uom base. |
| | DefaultReplenishLevel | No | decimal | Gets the default replenish level for this product in uom base. |
| | ProductTypeDefaultReplenishCapacity | No | decimal | Gets the default replenish capacity for this product type in uom base. |
| | ProductTypeDefaultReplenishLevel | No | decimal | Gets the default replenish level for this product type in uom base. |
##### Item classification - ITC
**Message type**: ITC (Item classification)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.StockClassificationByZone.StockClassificationERPCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows creating, modifying, deleting and upserting the possible classifications of the stock stored in each subwarehouses or stores.
- When deleting, not all data is necessary, but only primary key data (marked in red).
- Operations 2 (_Delete_) and 3 (_Upsert_) are the only ones allowed to perform with the Subwarehouses group.
**Structure**:
**ITC**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **ClassificationCode** | **Yes** | string(50) | Code of the classification. |
| NewClassificationCode | No | string(50) | New code of the classification in a modification. |
| Description | No | string(1000) | Description of the classification. |
| **Operation** | **Yes** | Enumeration | The operation flag that indicates the process that the ERP is going to make. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| IgnoreNulls | No | bool | Flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| Data | No | Group | Data about the stock classification. It contains all necessary data to define an stock classification from the ERP. |
| | LineList | No | List | Collection of subwarehouse lines belonging to the classification |
| | | Operation | No | Enumeration | Operation to perform with this group
Possible values: Create, Update, Delete. Create when not included |
| | | **WarehouseCode** | **Yes** | string(50) | The classification warehouse code |
| | | **SubwarehouseCode** | **Yes** | string(50) | Subwarehouse or inner store code
The subwarehouse or inner store code has to be in the selected warehouse, or an error will be notified |
| | | MinQuantity | No | Int32 | Minimum classification quantity
Entire number greater than or equal to 0 |
| | | MaxQuantity | No | Int32 | Maximum classification quantity
Entire number greater than 0. When MinQuantity has a value set, this has to be greater |
| | | Sequence | No | Int32 | Classification sequence order
Entire number greater than 0 |
| | CompleteLineList | No | bool | Indicator of completeness for the line list. In case it is true, the whole list must be treated as the only lines allowed for the stock classification.
If it is false, more lines appart from those in the list can exist for this stock classification. |
| | TransactionalLineList | No | bool | Indicator of transactionality for the line list. If 1 (true), the whole list must be treated as an atomic transaction. If 0 (false), each element must be individually transactioned. |
##### Owners - OWN
**Message type**: OWN (Owners)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.OwnerErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows creating, modifying, deleting and upserting the possible owners of the stock stored in the warehouse.
- An owner deletion can only be done if there is no other data related to that owner currently in Easy WMS:
- No item associated to that owner
- No receipt associated with that owner
- When deleting, not all data is necessary, but only primary key data (marked in red).
- In this case the groups included in the owners message may be registered, updated or deleted together with the owner, since they will have a univocal relationship
**Structure**:
**OWN**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Code** | **Yes** | string(50) | Owner code. When this is a non existing owner, and operation is a creation(0: Create, 3: UPSERT), the owner is created. When operation is a modification(1: Update, 2: Delete) the owner has to exist in the system or an error will be notified. |
| NewCode | No | string(50) | New owner code. Only used when modifying data (1: Update, 3: UPSERT operations). |
| **Operation** | **Yes** | Enumeration | Operation to do. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| IgnoreNulls | No | bool | Flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| Data | No | Group | Data about the owner. It contains all necessary data to define an owner from the ERP. |
| | Description | No | string(1000) | Owner’s description. |
| | Address | No | Group | Data about the owner’s address. |
| | | ZipCode | No | string(65) | Address ZIP Code. |
| | | AddressLine | No | string(65) | First address line. |
| | | AddressLine2 | No | string(65) | Extra address line. |
| | | City | No | string(65) | Address city. |
| | | State | No | string(65) | Address state. |
| | | Country | No | string(65) | Address country. (Two-letter ISO country code). |
| | | Comment | No | string(1000) | Address comment. |
| | Contact | No | Group | Data about the owner’s contact. |
| | | Comment | No | string(1000) | Contact comment. |
| | | Extension | No | string(65) | Contact phone extension. |
| | | Fax | No | string(65) | Contact fax. |
| | | Name | No | string(65) | Contact name. |
| | | Phone | No | string(65) | Contact phone number. |
| | | CellPhone | No | string(65) | Contact cell phone number. |
| | | Email | No | string(65) | Contact email. |
| | CustomAttribute | No | Group | Data about the custom attributes. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | IsMixingAllowed | No | bool | Data about the owner’s allow mixing. |
| | TaxIdNumber | No | string | Owner’s taxIdNumber. |
##### Carriers - CAR
**Message type**: CAR (Carriers)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.AgencyErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows creating, modifying, deleting and upserting the carriers that can be used as an attribute of a receipt or Shipping order delivery note.
A carrier deletion can only be done if there is no other data related to that carrier currently in Easy WMS: - No route associated to that carrier. - No truck load associated to that carrier. - No Shipping order delivery note associated to that carrier. - No reception or receipt order related to that carrier.
In a carrier deletion not all the fields are required: only the ones that make the primary key (marked in red in the structure).
The carrier name field does not belong to the primary key, but it must be unique within Easy WMS.
**Structure**:
**CAR**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Code** | **Yes** | string(50) | Agency code, which has to be a unique value into the system. When a non-existing value is included and a creation operation (0: Create, 3: UPSERT) is performed, this will be created. When a non-existing value is included in a modification operation (1: Update, 2: Delete) is performed, an error will be notified. |
| NewCode | No | string(50) | New code of the transport agency. Only use in case of modification(1: Update, 3: UPSERT operations) |
| **Operation** | **Yes** | Enumeration | Operation to perform. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| IgnoreNulls | No | bool | |
| Data | No | Group | Contains all the necessary data involved in the process of creating an agency froim an ERP |
| | **Name** | **Yes** | string(50) | Carrier name |
| | Description | No | string(1000) | Carrier description |
| | CustomAttribute | No | Group | Custom attribute for the Agency |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | Address | No | Group | Address |
| | | ZipCode | No | string(65) | Address ZIP Code. |
| | | AddressLine | No | string(65) | First address line. |
| | | AddressLine2 | No | string(65) | Extra address line. |
| | | City | No | string(65) | Address city. |
| | | State | No | string(65) | Address state. |
| | | Country | No | string(65) | Address country. (Two-letter ISO country code). |
| | | Comment | No | string(1000) | Address comment. |
| | Contact | No | Group | Contact |
| | | Comment | No | string(1000) | Contact comment. |
| | | Extension | No | string(65) | Contact phone extension. |
| | | Fax | No | string(65) | Contact fax. |
| | | Name | No | string(65) | Contact name. |
| | | Phone | No | string(65) | Contact phone number. |
| | | CellPhone | No | string(65) | Contact cell phone number. |
| | | Email | No | string(65) | Contact email. |
##### Accounts - ACC
**Message type**: ACC (Accounts)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.AccountErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows creating, modifying, deleting and upserting the customer accounts that can be used as addressees of the shipping orders.
- A customer account deletion can only be done if there is no other data related to that customer account currently in Easy WMS:
- No shipping orders for that customer accounts.
- No stock reserved for that customer accounts
- When deleting, not all data is necessary, but only primary key data (marked in red).
- The AccountType, Company and PreferredCarrier groups are referenced groups, so only a new group or reference to an existing one will be allowed (no deletion, modification or upsert of its data). For example:
- A message is sent with a new customer account that has a Company -> the customer account and the company to which it belongs are registered.
- Another message is sent for the same customer account but with a different value in the Company group -> the new company is registered and referred to from the customer account, but in the system the existence of the company registered in the first message is maintained.
- The rest of the groups included in the message can be added, updated or deleted together with the customer account.
**Structure**:
**ACC**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Code** | **Yes** | string(50) | Account code, which has to be a unique value into the system. When a non-existing value is included and a creation operation (0: Create, 3: UPSERT) is performed, this will be created. When a non-existing value is included in a modification operation (1: Update, 2: Delete) is performed, an error will be notified. |
| NewCode | No | string(50) | New account code. Has to be a unique value into the system. Only used when modifying data (1: Update, 3: UPSERT operations). |
| OwnerCode | No | string(50) | Owner code. When this is a non existing owner, and operation is a creation(0: Create, 3: UPSERT), the owner is created. When operation is a modification(1: Update, 2: Delete) the owner has to exist in the system or an error will be notified. |
| NewOwnerCode | No | string(50) | New owner code. Only used when modifying data (1: Update, 3: UPSERT operations). |
| **Operation** | **Yes** | Enumeration | Operation to perform. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| IgnoreNulls | No | bool | ACC mandatory boolean attribute. When true (1) null or not existing data fields keep its original value; when false (0) data fields are set to void. |
| Data | No | Group | Data about the account. It contains the necessary data to define the account from the ERP. |
| | **Name** | **Yes** | string(50) | Account name. |
| | Description | No | string(1000) | Account description. |
| | Terms | No | string(1000) | Free text to include a description of the terms negotiated with the client. |
| | AutoMerge | No | bool | True (1) indicates that orders merger will be automatically made when possible. False (0) indicates that no merge will be done automatically. Not implemented. When not introduced, default value is false (0). |
| | AccountTypeCode | No | string(50) | Account type code. When not existing, it will be created into the system. |
| | AccountTypeDescription | No | string(65) | Account type description. Only used when a new type is created. |
| | CompanyData | No | Group | Data about the company. It contains the necessary data to define the company from the ERP. |
| | | **Name** | **Yes** | string(50) | Company name. When not existing, it will be created into the system. |
| | | Description | No | string(65) | Company description. Only used when a new company is created. |
| | | **Code** | **Yes** | string(50) | Company code. When not existing, it will be created into the system. |
| | PreferredCarrierCode | No | string(65) | Preferred carrier code for the account orders transportation. When a non-existing value is used, an error is notified. |
| | Address | No | Group | Data about the account address. It contains the necessary data to define the account address from the ERP. |
| | | ZipCode | No | string(65) | Address ZIP Code. |
| | | AddressLine | No | string(65) | First address line. |
| | | AddressLine2 | No | string(65) | Extra address line. |
| | | City | No | string(65) | Address city. |
| | | State | No | string(65) | Address state. |
| | | Country | No | string(65) | Address country. (Two-letter ISO country code). |
| | | Comment | No | string(1000) | Address comment. |
| | Contact | No | Group | Data about the account contact. It contains the necessary data to define the account contact from the ERP. |
| | | Comment | No | string(1000) | Contact comment. |
| | | Extension | No | string(65) | Contact phone extension. |
| | | Fax | No | string(65) | Contact fax. |
| | | Name | No | string(65) | Contact name. |
| | | Phone | No | string(65) | Contact phone number. |
| | | CellPhone | No | string(65) | Contact cell phone number. |
| | | Email | No | string(65) | Contact email. |
| | CustomAttribute | No | Group | Data about the custom attributes. It contains the necessary data to define the custom attributes of the account from the ERP. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | IsStrictFEFO | No | bool | Indicates if the account demands strict expiration date control at shipping (Strict FEFO). |
##### Suppliers - SUP
**Message type**: SUP (Suppliers)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.SupplierErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows to create, modify, delete and upsert the suppliers data.
- A supplier deletion can only be done if there is no other data related to that supplier currently in Easy WMS:
- No receipt orders from that supplier
- No return orders for that supplier
- When deleting, not all data is necessary, but only primary key data (marked in red).
- The groups _PreferredCarrier_ and _SupplierType_ refers to other entities of the system, and only creation (no modifications or deletions) or changing (to refer other supplier) are allowed. E.g.:
- A SUP creation message is sent including a new supplier and its preferred carrier ->the new supplier and the new carrier are created into the system.
- A different SUP message is sent, modifying the preferred carrier of the supplier previously created ->the new carrier is created into the system, and its noted as preferred carrier to the supplier.
- The rest of the groups included in the message can be added, updated or deleted together with the supplier.
**Structure**:
**SUP**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Code** | **Yes** | string(50) | Supplier code.
When a non-existing value is included and a creation operation (0: Create, 1: Update) is performed, this will be created. |
| NewCode | No | string(50) | |
| OwnerCode | No | string(50) | The owner code. If a non existent value with a 0: Create operation is introduced in the system, 3: UPSERT will be registered, however if it is a 1: Update operation, 2: Delete will notify an error. |
| NewOwnerCode | No | string(50) | The new owner code.
It will only be used in case the user wants to make an update (1: Update, 3: UPSERT operations). |
| **Operation** | **Yes** | Enumeration | Operation to perform.
Possible values: 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| IgnoreNulls | No | bool | SUP mandatory boolean attribute.
When true (1) null or not existing data fields keep its original value; when false (0) data fields are set to void. |
| Data | No | Group | The data about the container. Contains all necessary data to define a container from the ERP. |
| | **Name** | **Yes** | string(50) | Supplier name. |
| | Description | No | string(1000) | Supplier description. |
| | **SupplierTypeCode** | **Yes** | string(50) | Supplier type code.
When a new type is included, it will be created into the system. |
| | SupplierTypeDescription | No | string(65) | Supplier type description.
Only used when a new supplier type is created. |
| | **PreferredCarrierCode** | **Yes** | string(50) | Preferred carrier code for this supplier.
This has to be an existing value or an error will be notified. |
| | DeliveryConditions | No | string(1000) | Delivery conditions free text description. |
| | ShippingAddress | No | Group | Shipping address. |
| | | ZipCode | No | string(65) | Address ZIP Code. |
| | | AddressLine | No | string(65) | First address line. |
| | | AddressLine2 | No | string(65) | Extra address line. |
| | | City | No | string(65) | Address city. |
| | | State | No | string(65) | Address state. |
| | | Country | No | string(65) | Address country. (Two-letter ISO country code). |
| | | Comment | No | string(1000) | Address comment. |
| | ShippingContact | No | Group | |
| | | Comment | No | string(1000) | Contact comment. |
| | | Extension | No | string(65) | Contact phone extension. |
| | | Fax | No | string(65) | Contact fax. |
| | | Name | No | string(65) | Contact name. |
| | | Phone | No | string(65) | Contact phone number. |
| | | CellPhone | No | string(65) | Contact cell phone number. |
| | | Email | No | string(65) | Contact email. |
| | ReturnContact | No | Group | |
| | | Comment | No | string(1000) | Contact comment. |
| | | Extension | No | string(65) | Contact phone extension. |
| | | Fax | No | string(65) | Contact fax. |
| | | Name | No | string(65) | Contact name. |
| | | Phone | No | string(65) | Contact phone number. |
| | | CellPhone | No | string(65) | Contact cell phone number. |
| | | Email | No | string(65) | Contact email. |
| | ReturnAddress | No | Group | |
| | | ZipCode | No | string(65) | Address ZIP Code. |
| | | AddressLine | No | string(65) | First address line. |
| | | AddressLine2 | No | string(65) | Extra address line. |
| | | City | No | string(65) | Address city. |
| | | State | No | string(65) | Address state. |
| | | Country | No | string(65) | Address country. (Two-letter ISO country code). |
| | | Comment | No | string(1000) | Address comment. |
| | CustomAttribute | No | Group | |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | VerifyItems | No | bool | |
##### Kits - KIT
**Message type**: KIT (Kits)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.KitErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows creating, modifying, deleting and upserting the kit items data.
- A kit deletion can only be done if there is no other data related to that kit currently in Easy WMS, i.e.:
- Kit stock stored.
- Kit stock in assembly locations.
- Receipts, receipts orders, shipping orders or work orders for the kit.
- Kit is also another kits part.
- When deleting, not all data is necessary but only primary key data (marked in red)
- When a new kit is created in Easy WMS, it is also enabled.
- The 0..n group _Components_ has a _complete_ attribute, which indicates whether all the existing components are included into the group (when true), or only the modified ones (when false):
- When the _complete_ attribute has a false (0) value: Only the specific components of the group will be modified, other possible existing components maintains its previous value.
- When the complete has true (1) value: The message has to include all kit components, because operations set in the kit components will be performed and after that any other component will be deleted of the system. E.g.:
- A new kit item is sent with two components on it -> kit and components are created into the Easy WMS system.
- A modification of the kit is sent with a new _component_ and the complete attribute set to true ->the component will be created but the old one removed from the kits components list, so the kitwill have only one component in the Easy WMS system.
- Default operation in the _Components_ group is SUPSERT
- If after the creation or modification of a kit, it runs out of components, the kit is set to disabled.
- _OnDemand_ field indicates if on demand assemble is requiere for that kit (kit must requiere being assembled). This means that, when a shiping order asking for a kit is received, it will be cheked if there are enough kits on the warehouse to supply the order, in other case, shipping orders to supply the order will be created. This testing is made in this situations: enable replenishment, reserve, assign and release.
**Structure**:
**KIT**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **ItemCode** | **Yes** | string(50) | Existing item that is a kit
It has to be an existing item code; otherwise, an error will be notified. |
| **OwnerCode** | **Yes** | string(50) | Existing kit item owner.
When not sent, default owner is taken if exists.
When not sent, if there is only one owner into the system this is taken by default
When not sent and no default owner exists, an error is notified.
It has to be the existing items owner, otherwise an error will be notified |
| **KitVersion** | **Yes** | string(50) | Kit version. Notallowed to be modified
When creating a new kit (0: Create, 3: UPSERT) a new version is required.
When modifying(1: Update, 2: Delete) an existing version reference is required
Error in other cases |
| **Operation** | **Yes** | Enumeration | The operation flag that indicates the process that the ERP is going to make. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| IgnoreNulls | No | bool | Flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| Data | No | Group | Data about the kit. It contains all necessary data to define an kit from the ERP. |
| | **UomBaseCode** | **Yes** | string(50) | Base kit UoM (Unit of Measure)
Has to reference an existing UoM |
| | IsAssembled | No | bool | Indicates that the kit is assembled in the warehouse and therefore if necessary to have stock of it in order to shipping for a OutboundOrder.If the kis is not assembled, its component will be shipped
Default value is true |
| | OnDemand | No | bool | Indicates that, is a SO is received asking for an assemble kit and there isn’t enough stock assembled for it in the warehouse, a work order will be created in order to assemble it
IsAssembled must be true. By default is false |
| | Components | No | List | List of components for this kit |
| | | Operation | No | Enumeration | Operation for the kit component 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| | | **CmpItemCode** | **Yes** | string(50) | Item kit-component code. Creation of a new item is not allowed.
Existing item required. It has to match to the kit owner or an error will be notified. |
| | | CmpVersion | No | string(50) | Kit component version. Only used when the component is also a kit.Not allowed to be modified
When creating, a new version is required.
When modifying, an existing version is required
Otherwise, an error is notified |
| | | **CmpUoMCode** | **Yes** | string(50) | Component UoM (Unit of Measure)
Existing UoM |
| | | **CmpQuantity** | **Yes** | decimal | Quantity specified in the required UoM
Number greater than 0 |
| | | CmpIsMaster | No | bool | When true, this is the master component of the kit. When false, this component is not the master. Only one master by kit is allowed. When many components are marked as master, the last one will be the master set.
Default value is false |
| | | CmpCustomAttribute | No | Group | Custom attributes |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | CustomAttribute | No | Group | Data about the custom attributes. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | TransactionalComponentList | No | bool | Indicator of transactionality for the component list.
If it is true, the whole list must be treated as an atomic transaction.
If it is false, each element must be individually transactioned. |
| | CompleteComponentList | No | bool | The 0..n group Components has a complete attribute, which indicates whether all the existing components are included into the group (when true), or only the modified ones(when false):
When the complete attribute has a false value: Only the specific components of the group will be modified, other possible existing components maintains its previous value.
When the complete has true value: The message has to include all kit components, because operations set in the kit components will be performed and after that any other component will be deleted of the system. |
| **KitId** | **Yes** | Guid | The kit identifier |
##### User statuses - LCK
**Message type**: LCK (User status)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.MasterData.Contracts.Commands.StockStatusErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message is used to register, modify or delete the different stock user statuses that exist in the organization. The user statuses allow to apply a status to the stock after the detection of a problem that affects its quality. User statuses can also be assigned when the stock is received.
The deletion (2(Delete)) can only be carried out if there is no data in the system related to the user status, e.g. if there is any stock line with this stock status. - In the case of deletion, not all fields are required, but only those that make up the primary key (marked in red). - The _CaptureProcesses_ group only supports options 0 (_Create_) and 2 (_Delete_). - If the _CaptureProcesses_ group does not appear, and an operation 0 (_Create_) is being performed, all possible processes will be assigned. - The _complete_ attribute in the group 0..n included in the process capture data, i.e. _CaptureProcesses_, will indicate whether the list of elements is exhaustive or only contains the elements to be modified: - If the _complete_ attribute is false: The system will only perform the specified operation on each element of that group. - If the _complete_ attribute is true: the message must include all the references of elements of the group, so that the operations at group level will also imply the deletion of the possible existing references previously not transmitted in the message.
- If a modification 1(Update) or 3(Upsert) is sent:
- With _ignoreNull_ true: only the fields that appear in the message for which there are changes are modified.
- With _ignoreNull_ false: a failure occurs if a mandatory field does not appear in the message. Changes are made with the values indicated in the message, and the default value is given to those that do not appear in the message.
**Estructura**:
**LCK**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| CaptureProcesses | No | List | |
| | Operation | No | Enumeration | Operation to perform with this group
Possible values: Create, Delete. Create when not included |
| | **ProcessTypeCode** | **Yes** | Enumeration | Represents the process type. The type can be 1(Packaging), 2(Remainder). |
| Data | No | Group | Data about the stock status. It contains the necessary data to define the stock status from the ERP. |
| | Code | No | string | Data about the stock status data. It contains the necessary data to define the stock status from the ERP. |
| | Description | No | string | Data about the stock status data. Gets or sets the lock description from the ERP. |
| | CustomAttribute | No | Group | Data about the stock status data. Custom attributes of the lock. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | AllowCount | No | bool | Data about the stock status data. Indicates whether the blocking allows counting tasks to be performed on the blocked stock or not. Default, false. |
| | AllowMove | No | bool | Data about the stock status data. Indicates whether the blocking allows movement tasks (in automatic warehouses) to be performed on the blocked stock or not. Default, false. |
| | AllowPick | No | bool | Data about the stock status data. Indicates whether the blocking allows picking tasks to be performed on the blocked stock or not. Default, false. |
| | AllowPutaway | No | bool | Data about the stock status data. Indicates whether the blocking allows putaway tasks to be performed on the blocked stock or not. Default, false. |
| | AllowReceive | No | bool | Data about the stock status data. Indicates whether the blocking allows receiving tasks to be performed on the blocked stock or not. Default, false. |
| | AllowReplenish | No | bool | Data about the stock status data. Indicates whether the lock allows its use to replenish dedicated picking locations or not. Default, false. |
| | AllowShip | No | bool | Data about the stock status data. Indicates whether or not the blocking allows the blocked stock to be shipped. Default, false. |
| | AllowSecure | No | bool | Data about the stock status data. Indicates whether or not the blocking allows stock reservations to be made from the blocked stock. Default, false. |
| | AllowInternalConsumption | No | bool | Data about the stock status data. Indicates whether the blocking allows internal consumption of the blocked stock in production processes or not. Default, false. |
| | CommentRequired | No | bool | Data about the stock status data. Indicates whether it is mandatory to add a comment when adding a user lock of this type. Default, false. |
| | CompleteCaptureProcess | No | bool | Indicator of completeness for the capture process list. If 1 (true), the whole list must be treated as the only lines allowed for the stock status. If 0 (false), more capture processes appart from those in the list can exist for this lock stock. |
| | TransactionalCaptureProcess | No | bool | Indicator of transactionality for the capture process list. If 1 (true), the whole list must be treated as an atomic transaction. If 0 (false), each element must be individually transactioned. |
| IgnoreNulls | No | bool | LCK mandatory boolean attribute. When true (1) null or not existing data fields keep its original value; when false (0) data fields are set to void. |
| NewCode | No | string(50) | New stock status code. Has to be a unique value into the system. Only used when modifying data (1: Update, 3: UPSERT operations). |
| **Operation** | **Yes** | Enumeration | Operation to perform. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
### Receiving
#### Imported messages
Messages that will be received in Import direction (from the ERP to MAP).
##### Receipt orders - ROR
**Message type**: ROR (Receipt orders)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Receptions.Contracts.Commands.InboundOrderErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**:This message allows creating, modifying, deleting and upserting the receipt orders data managed in Easy WMS. - When deleting (2 (Delete)), not all data is necessary but only primary key data (marked in red). - When operatin with lines, the line number is its primary key data. - It is not allowed to change the _Site_ in existing receipt orders. - Delete, update and upsert operations (1 (Update), 2 (Delete), 3 (Upsert)) depend on the current order status and its lines status, both for header and lines. Some modifications can be done: - Line can be edited when: - Line status is not _Cancelled_, _Closed_, _Closing_, _Expired_ or _Completed_. - Line has not any reception line asociated with _Receiving_ or _Closing_ status.
```
- The conversion (and item) can be modified as long as nothing has been received on the line (the quantity
received from the line is 0).
- The quantity can be changed as long as the new quantity is greater than or equal to the quantity already received
(never less). Placing a quantity equal to the quantity received will result in the order line being
completed.
```
- An incoming order may be cancelled with operation 2 (Delete) as long as no stock has been received for any of its lines and its status is not _Cancelled_, _Closing_, _Closed_, _Receiving_, _Partially received_ or _Completed_. The _CloseReceiptOrderfield_ shall be set to _false_.
- A receipt order may be closed with operation 2 (Delete), provided that its status is not _Waiting, Cancelled, Closing, Closed, Closed or Receiving_. The _CloseReceiptOrder_ field shall have the value _true_.
- The operation of creating a new line in an existing order (1 (Create) or 3 (Upsert) for line, 1 (Update) or 3 (Upsert) for order) shall be allowed as long as the order has not been closed, completed, cancelled or expired.
- The group 0..1 included in the ROR message, i.e. _ReceiptData_, may be added, modified or deleted because of its unique relationship to the incoming order.
- The _complete_ attribute in the group 0..n _Lines_ included in the ROR message, shall indicate whether the list of lines is exhaustive or only contains the elements to be modified:
- If the _complete_ attribute is _false_: The system shall only perform the specified operation on each line of that group.
- If the _complete_ attribute is _true_: the message must include all the lines, so that the operations at line level will also imply the deletion of the possible existing lines previously not transmitted in the message. For example:
- A new receipt order with one line is sent -> will be added.
- A modification in the order data is sent, without sending any group _Lines_, and indicating _ignoreNull_ true -> the corresponding data of the order header will be modified and its lines will not be modified, i.e. it will continue to have the line with which it was created.
- A modification in the order data is sent with a Lines group containing two lines -> if necessary, the order header data will be modified, and in addition the two new lines will be created with their data and the one previously existing in the system will be deleted, so that the order will only have the two lines indicated in the last message.
- When the insertion of the order lines is _transactional true_ and an error occurs, none of the lines shall be created, nor shall the empty order be created.
- A system parameter shall determine whether a ROR message shall also create a receipt associated with the incoming order. With the system parameter true and the _SingleReceipt_ field set to _true_, a single receipt shall be created automatically for the incoming order, the rest of the receipts (if needed) shall be created manually. With the value of the parameter set to _true_ and _SingleReceipt_ set to _false_, receipts will be created automatically whenever any auto-created receipt is closed for the order and not all the quantity indicated in the order lines has been received.
- Regardless of the value of this parameter, the values of the associated receipts (if any) shall always be maintained in case of deletions and modifications in the order lines as well as in the order header.
- In the case of not automatically creating the receptions associated to the receipt orders (system parameter _false_), an error could be notified when trying to change data in the order header if the order shares receipt with another one.
- When a Receipt associated to the order is automatically created, its code shall contain the code of the receipt order.
- The receipt/s associated to the receipt order will inherit the value of the field that allows to auto create lines and the one that allows to print GS1-128 labels during the receipt, not being able to be edited at receipt level in the case of the auto create lines field and only from ROR message updates.
- Inbounds reservations are made for each line. An inbound reservation can be made for an existing or non-existing shipping order or for an account, but not both at the same time.
- Exclusive reservations are made for each line. An exclusive reservation can be made for an existing or non-existing departure order or for an existing or non-existing route/stop, but not both at the same time.
- For a line, each exclusively reserved quantity will be reflected in the system as a separate stock line once the stock has been received, which will not be merged with the rest of the stock lines with the same characteristics even if it is in the same _holder_ (location, container, or division).
- The same ROR message can request inbound reservations (group _LneStockReserves_) or exclusive reservations (group _LneStockExclusiveReserves_) for the same line, but not both types of reservations at the same time.
**Structure**:
**ROR**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | Flag to ignore null values. When true null or not existing data fields keep its original value; when false data fields are set to void. |
| **Operation** | **Yes** | Enumeration | The operation flag that indicates the process that the ERP is going to make. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| **Code** | **Yes** | string(50) | Receipt order code.
When a non-existing value is included and a creation operation (Create, Upsert) is performed, this will be created. |
| NewCode | No | string(50) | New receipt order code. Only used when a modification is performed (Update, Upsert) |
| **Site** | **Yes** | string(50) | Code of the warehouse site. Has to be an existing site, and It is not allowed to modify it |
| Data | No | Group | Contains all necessary data to define an inbound order from the ERP |
| | **InboundType** | **Yes** | Enumeration | Specific receipt type of this order. Possible values: 1(Return), 0(Supplier), 3(Transfer). |
| | SupplierCode | No | string(50) | Supplier code for the receipt order. It has to reference an existing supplier in the system, or an error will be notified. |
| | AccountCode | No | string(50) | Account code for the return. It has to reference an existing account in the system, or an error will be notified. Only Return value is taken into account. |
| | SaleOrderCode | No | string(50) | Optional shipping order code for the return. Only used when RorType is Return. It has to reference an existing shipping order. |
| | AllowAutoCreateLines | No | bool | Allow to auto create lines to receive non expected stock. This value is inherited by the related reception. false not allow, true allow. |
| | HasContainerLabelPrinting | No | bool | Allow to enable GS1-128 container label printing during receiving process on each reception created from this receipt order. false not allow, true allow. |
| | HasItemLabelPrinting | No | bool | Allow to enable GS1-128 item label printing during receiving process on each reception created from this receipt order. false not allow, true allow. |
| | InboundClassCode | No | string(50) | Receiving class code. Has to be an existing receiving class code and available for ERP receiving, or an error will be notified. |
| | CarrierCode | No | string(50) | Receipt order carrier code. Has to be an existing carrier code, or an error will be notified. |
| | TransportType | No | string(1000) | Open text to describe the type of transportation used. |
| | Document | No | string(65) | Name of the delivery note file for the receipt order. |
| | Source | No | string(65) | Open text to describe the order origin. |
| | Description | No | string(1000) | Receiving order description. |
| | ExpectedNumContainers | No | long | Number of estimated containers. Positive number greater than 0. |
| | ExpectedDate | No | DateTime | Estimated arrival date and time. UTC date-time format. |
| | DockStationCode | No | string(50) | Expected arrival dock. Has to be an existing dock, or an error will be notified. |
| | ValidityDays | No | long | Number of days of the period of validity for the reception. Positive number greater than 0. |
| | IsSingleReceipt | No | bool | Indicates whether, when the system parameter AutoCreateReceptionFromRecOrder, a single receipt shall be created for the order or allows more than one to be created as needed. If not filled in, the default value will be 0 (false). |
| | TransactionalLineList | No | bool | When the insertion of the order lines is transactional (transactional true) and an error occurs, none of the lines will be created, nor will the empty order. |
| | CompleteLineList | No | bool | The complete attribute included in the ROR message will indicate whether the list of lines is exhaustive or only contains the elements to be modified:
If the complete attribute is false: The system will only perform the specified operation on each line of said group.
If the complete attribute is true: the message must include all the lines, so that line-level operations will also imply the deletion of the possible existing
lines previously not transmitted in the message. |
| | LineList | No | List | List of lines for this receipt order. |
| | | Operation | No | Enumeration | Operation for the inbound order lines. Possible values: 0: Create, 1: Update, 2: Delete, 3: UPSERT Default value when not included is 3: UPSERT |
| | | **LineNumber** | **Yes** | long | Line number.
Unique line number into the order. Line number modification is not allowed. LneNumber is the key to perform 1: Update, 2: Delete, 3: UPSERT operations |
| | | **ProductCode** | **Yes** | string(50) | Code for the product to be received in this line. Along with the owner code it univocally identifies a product.
It must match an existing product. |
| | | OwnerCode | No | string(50) | Item owner code.
When not set:
\- If only one owner exists into the system, this value will be set
\- If there is a default owner, this value will be set
\- In any other way, an error is notified |
| | | ContainerCode | No | string(50) | LPN (License Plate Number) that contains the stock.The LPN could be notified in advance or not. |
| | | StockStatusCode | No | string(50) | Status of the stock to be received
Has to be an existing stock status, or an error will be notified |
| | | Package | No | string(65) | Open text to inform the ERP package number |
| | | PurchasePrice | No | Group | Price data |
| | | | **Quantity** | **Yes** | decimal | Informative field with the line total price. Positive number greater than 0. |
| | | | **Currency** | **Yes** | string(65) | Currency related to LneCstPurchase. Only when Quantity is set. |
| | | **UnitOfMeasureCode** | **Yes** | string(50) | UoM (Unit of Measure) of the line quantity.
Has to be an existing UoM into Easy WMS, or an error will be notified. |
| | | **Quantity** | **Yes** | decimal | Expected quantity (in the specified UoM).
Positive number greater than 0 |
| | | FreeQuantity | No | decimal | Free of charge quantity expected (in to the specified UoM)
Positive number |
| | | Terms | No | Group | Defines the terms of the line. |
| | | | ExceedPercentageAllowed | No | decimal | Value 0 resembles that not any upper percentage is accepted
Values greater than 0 resembles the allowed exceed percentage accepted
When this attribute does not exist in the ROR, the item reception profile will set the upper percentage accepted
Integer greater than 0 |
| | | | ReceiveLessAllowed | No | bool | Less quantity is / is not allowed to be received
When false less quantity is not permitted
When true less quantity is permitted |
| | | | HandlingRequired | No | bool | Handling is required or not
true means handling is mandatory. false means handling is not mandatory. |
| | | | HandlingDescription | No | string(65) | Handling required specific description
Only used when LneTrmReqHandling is true |
| | | | DaysOfLife | No | long | Shelf life required in order to allow stock reception
Positive number greater than 0
When set, the best before date or the expiration date of the logistic attributes of the inbound order line must also be set. |
| | | LogisticAttributes | No | Group | Defines the logistic attributes of the stock of the line |
| | | | LotCode | No | string(65) | Mandatory LOT to be shipped. |
| | | | SerialNumber | No | string(65) | Mandatory serial number to be shipped. |
| | | | ProductionDate | No | DateTime | Earlier production date to be shipped. UTC date-time format |
| | | | ExpirationDate | No | DateTime | Earlier expiration date to be shipped. UTC date-time format. |
| | | | BestBeforeDate | No | DateTime | Earlier best before date to be shipped. UTC date-time format. |
| | | | DaysOfLife | No | long | Lower shelf life to be shipped. Positive number greater than 0. |
| | | | Quality | No | string(65) | Mandatory quality to be shipped. |
| | | | Color | No | string(65) | Mandatory color to be shipped. |
| | | | Source | No | string(65) | Mandatory origin to be shipped. |
| | | | Version | No | string(65) | Mandatory version to be shipped. It is mandatory in case of requesting a non assembled kit item, and must correspond with an enabled version of the kit. |
| | | | ProductionMethod | No | string(65) | Mandatory production method to be shipped. |
| | | | PostProductionTreatment | No | string(65) | Mandatory post-production treatment to be shipped. |
| | | | Size | No | string(65) | Mandatory size to be shipped. |
| | | | Weight | No | decimal | Mandatory weight to be shipped. Decimal number greater than 0. |
| | | CustomAttribute | No | Group | Custom attributes |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | | StockReserveList | No | List | List of stock reserves for this inbound order line. |
| | | | OutboundOrderCode | No | string(50) | Outbound order related to this reserve of an inbound order line.
It may not exist yet when the reserve is created. If empty, account code must be given. |
| | | | AccountCode | No | string(50) | Account order related to this reserve of an inbound order line.
It must exists in the system on the reserve creation. If empty, outbound order code must be given. |
| | | | QuantityToReserve | No | decimal | Quantity to reserve in the Udm indicated.
It must be greater than 0 and less than or equal to the inbound order line total quantity. |
| | | | ReserveValidDate | No | DateTime | Date and time of reserve expiration on UTC time format.
If empty, reserve does not expire. |
| | | StockExclusiveReserveList | No | List | List of stock reserves for this inbound order line. |
| | | | ExpectedOutboundOrderCode | No | string(50) | Outbound order related to this reserve of an inbound order line.
It may not exist yet when the reserve is created. If empty, route code must be given. |
| | | | ExpectedRouteCode | No | string(50) | Route order related to this reserve of an inbound order line.
It may not exist yet when the reserve is created. If empty, outbound order code must be given.
If it is given, expected route stop number is required. |
| | | | ExpectedRouteStopNumber | No | long | Stop number of the route associated to this inbound order line.
It must be greater than 0 and less than or equal to the total number of the stops of the route. |
| | | | ReserveValidDate | No | DateTime | Date and time of reserve expiration on UTC time format.
If empty, reserve does not expire. |
| | | | QuantityToReserve | No | decimal | Quantity to reserve in the Udm indicated.
It must be greater than 0 and less than or equal to the inbound order line total quantity. |
| | CustomAttribute | No | Group | Custom attributes for this receipt order. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | OwnerCode | No | string(50) | Order owner code. |
| CloseReceiptOrder | No | bool | Together with the operation Delete, it indicates whether the order must be cancelled (false value) or closed (true value). |
##### Advanced shipping notice - ASN
**Message type**: Advanced shipping notice
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.ContainerForASNErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows to create, modify, delete or upsert the advanced shipping notice of LPNs (license plate numbers) containing stock to be received.When deleting, not all data is necessary but only primary key data (marked in red). - It is not allowed to change the Site in previously notified LPNs. - Advanced LPNs will be created with the status _Reception pending_ and placed in the ASN location. - Deletion and modification (1 (Update), 2 (Delete), 3 (Upsert)) are only permitted when the LPN status is _Reception pending_. - When the LPN and its stock is receipt into the warehouse, the corresponding stock status change will be notified (STC message). - The 1..n group _Lines_ has a _complete_ attribute, which indicates whether all the existing components are included into the group (when true), or only the modified ones (when false): - When the _complete_ attribute has a _false_ (0) value: Only the specific components of the group will be modified, other possible existing components maintains its previous value. - When the _complete_ has _true_ (1) value: The message has to include all order lines, because operations set in the lines will be performed and after that any other order line will be deleted of the system. E.g.: - A new advanced notification is receipt with two stock _lines_ on it -> the LPN and its lines are created into the Easy WMS system - A modification of the advanced notification is sent with a new line and the complete attribute set to true -> the LPN line will be created but the old two existing _lines_ will be removed from the order list, so the LPN will have only one line to receive in the Easy WMS system.
- Operations available in the Lines group are only create or delete (0 (Create), 2 (Delete)), and this is a mandatory field.
- When the Lines _transactional_ attribute is set true and an error happens, not only the lines are not created, but also the empty LPN is not created in Easy WMS.
- Creating or modifying any Line, corresponding to an item, without all logistic attributes required by this item reception profile, will be responded with an error notifying the lack of data in the ASN message.
- Stacked containers:
- Containers group is used to stacked containers. A stacked container can also have as many Containers groups as nested containers as needed to establish the hierarchy.
- To modify the data of a container belonging to a hierarchy of stacked containers (stock included), it’s necessary to send all hierarchy indicating an update operation (1 (Update), 3 (Upsert)) to all containers in the hierarchy.
- Deleting the parent container implies the deleton of all his childs.
- To add a container to a hierarchy of stacked containers, it’s necessary to indicate an update operation (U, S) for the rest of the hierarchy.
- To delete a stacked container, it’s necessary to indicate an update operation (1 (Update), 3 (Upsert)) for the rest of the hierarchy and a delete (2 (Delete)) operation for the container.
- Number of expected containers (NumExpectedContainers):
- In the case that the number of containers to be received is known in advance but the container codes are not known, such as in the case of containers that come from a production line, a number of expected containers can be indicated, so that as many “equivalent” containers as indicated in this field will be created with the stock lines indicated. The containers will be created with a autogenerate code that will be updated later when identified in the PIE station+. In this case the container code should not be informed.
- Likewise, if the container code or the number of containers to be produced is not informed and it is not the case of an unidentified slave container, the number of containers will be calculated taking into account the quantity of stock indicated in the lines and the complete container quantity configured for the container type. This case will only be taken into account in the case of mono-reference containers.
- In deletion and modification operations (D, U, S) only the equivalent containers that are in ASN at the time of receiving the message will be taken into account and the necessary containers will be created or deleted to reach the indicated number of containers.
- Expedition information (ExpectedOutboundOrderCode y ExpectedRouteCode):
- In case the expected shipping order or the route of the containr is known, it can be informed in the ASN message. They do not need to exist in Easy WMS when message is received.
- The expected shipping order or the route can be informed. In case the route is informed, it is mandatory to inform the stop number of the route for the container.
- Exclusive reservation:
- The exclusive reservation of a container reserves its stock for a single shipping order, so that its stock cannot be allocated for the preparation of any other shipping order from the warehouse.
- The container advance notice message allows you to request the exclusive reservation of the container’s stock for a specific shipping order or for any compatible order of a route and stop, which will be searched in the system at the moment when the receipt of the container in the warehouse is validated.
- The exclusive reservation request for a container does not require the completion of data relating to stock lines.
- To request the exclusive reservation of the container it is mandatory to fill in the ContainerCode and NumExpectedContainers fields, in addition:
- To request the reservation for a specific shipping order the ExpectedOutboundOrderCode field must be filled in with the code of an shipping order that may or may not exist, prior to the receipt of the advanced notification.
- To request a reservation for a route, the ExpectedRouteCode and ExpectedRouteStopNumber fields must be filled in.
- To limit the validity of the reservation request in the event that it could not be formalized because there are no shipping orders compatible with the container, a validity date must be indicated in the ExpectedReserveValidDate field.
- In sequenced or density warehouses, the completion of the stock reservation and equivalent container data implies that the channel reservation is made for all identical containers with exclusive reservation for the same shipping order or route and stop.
**Structure**:
**ASN**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | The flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| **Operation** | **Yes** | Enumeration | Operation to perform
Possible values: 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| **Site** | **Yes** | string(50) | Warehouse site code
It should be included in an existing site in the system, and it does not allow being modified. |
| ContainerCode | No | string(50) | Container code. If it includes a non existing value in the system with an operation 0: Create, 3: UPSERT will register it, meanwhile, if the operation is 1: Update, 2: Delete will produce an error. It is not mandatory when it represents an slave container without identification. |
| NumExpectedContainers | No | long | Number of expected containers. |
| ExpectedOutboundOrderCode | No | string | Code of the expected outbound order. |
| ExpectedRouteCode | No | string | Code of the expected outbound route. |
| ExpectedRouteStopNumber | No | long | Number of the route stops expected. |
| NewContainerCode | No | string(50) | New container code. Only used when a modification is performed (1: Update, 3: UPSERT) |
| Data | No | Group | The data about the container. Contains all necessary data to define an container from the ERP. |
| | ContainerTypeCode | No | string(50) | Container type. When unknown container type or not sent, the default container type will be set |
| | Height | No | decimal | Maximum container height in meters
Positive number greater than 0
If not specified, the height of the container type used will be taken by default. |
| | Weight | No | decimal | Container real weight in kilograms
Positive number greater than 0 |
| | Volume | No | decimal | Container volume in cubic meters
Positive number greater than 0 |
| | DivisionTypeCode | No | string(50) | Division type of the receiving container
Has to be an existing division type, or an error will be notified |
| | TransactionalLineList | No | bool | Indicator of transactionality for the line list. If 1 (true), the whole list must be treated as an atomic transaction. If 0 (false), each element must be individually transactioned. |
| | CompleteLineList | No | bool | The 1..n group Lines has a complete attribute, which indicates whether all the existing components are included into the group(when true), or only the modified ones(when false):
When the complete attribute has a false value: Only the specific components of the group will be modified, other possible existing components maintains its previous value
When the complete has true value: The message has to include all order lines, because operations set in the lines will be performed and after that any other order line will be deleted of the system |
| | LineList | No | List | Container stock list |
| | | **Operation** | **Yes** | Enumeration | Operation to perform with the line stock
Possible values: 0: Create, 2: Delete |
| | | **ProductCode** | **Yes** | string(50) | Stock code to be received
Has to be an existing item code, or an error will be notified |
| | | OwnerCode | No | string(50) | Owner stock code
When no owner is set:
When only one owner exists into the system, this will be set
When some owner is default, this will be set
In other cases, an error will be notified
Has to be the existing stock owner code, or an error will be notified |
| | | DivisionCode | No | string(65) | Field to notify the division for the receiving container.
Has to be and exisiting división code for the division type included, or an error will be notified.
If DivisionType is not included an error will be notified. |
| | | **Quantity** | **Yes** | decimal | Stock quantity in the specified UoM (Unit of Measure)
Positive number greater than 0 |
| | | **UnitOfMeasureCode** | **Yes** | string(50) | Stock UoM used to set the quantity
Existing UoM in EasyWMS, or an error will be notified |
| | | SupplierCode | No | string(50) | Stock supplier code
Existing supplier code in EasyWMS, or an error will be notified |
| | | Weight | No | decimal | Stock weight in kilograms
Positive number greater than 0 |
| | | Package | No | string(65) | Open text to inform the ERP package number |
| | | Status | No | Group | Defines the stock user status. |
| | | | **StockStatus** | **Yes** | string(50) | Stock status that will be set when received
Existing stock status code, or an error will be notified |
| | | | StatusEnd | No | DateTime | End stock status date time
UTC date-time forma |
| | | | Comment | No | string(65) | Stock status comment |
| | | LogisticAttributes | No | Group | Defines the logistic attributes of the stock of the line. |
| | | | LotCode | No | string(65) | Mandatory LOT to be shipped. |
| | | | SerialNumber | No | string(65) | Mandatory serial number to be shipped. |
| | | | ProductionDate | No | DateTime | Earlier production date to be shipped. UTC date-time format |
| | | | ExpirationDate | No | DateTime | Earlier expiration date to be shipped. UTC date-time format. |
| | | | BestBeforeDate | No | DateTime | Earlier best before date to be shipped. UTC date-time format. |
| | | | DaysOfLife | No | long | Lower shelf life to be shipped. Positive number greater than 0. |
| | | | Quality | No | string(65) | Mandatory quality to be shipped. |
| | | | Color | No | string(65) | Mandatory color to be shipped. |
| | | | Source | No | string(65) | Mandatory origin to be shipped. |
| | | | Version | No | string(65) | Mandatory version to be shipped. It is mandatory in case of requesting a non assembled kit item, and must correspond with an enabled version of the kit. |
| | | | ProductionMethod | No | string(65) | Mandatory production method to be shipped. |
| | | | PostProductionTreatment | No | string(65) | Mandatory post-production treatment to be shipped. |
| | | | Size | No | string(65) | Mandatory size to be shipped. |
| | | | Weight | No | decimal | Mandatory weight to be shipped. Decimal number greater than 0. |
| | | CustomAttribute | No | Group | Custom attributes for the product |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | CustomAttribute | No | Group | Custom attributes for the container |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| IsSlave | No | bool | The value indicating whether container is slave. |
| Containers | No | List | The list of child containers. |
| | **Site** | **Yes** | string(50) | Warehouse site code
It should be included in an existing site in the system, and it does not allow being modified. |
| | **Operation** | **Yes** | Enumeration | Operation to perform
Possible values: 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| | ContainerCode | No | string(50) | Container code. If it includes a non existing value in the system with an operation 0: Create, 3: UPSERT will register it, meanwhile, if the operation is 1: Update, 2: Delete will produce an error. It is not mandatory when it represents an slave container without identification. |
| | NewContainerCode | No | string(50) | New container code. Only used when a modification is performed (1: Update, 3: UPSERT) |
| | IsSlave | No | bool | The value indicating whether container is slave. |
| | IgnoreNulls | No | bool | The flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| | Data | No | Group | The data about the container. Contains all necessary data to define an container from the ERP. |
| | | ContainerTypeCode | No | string(50) | Container type. When unknown container type or not sent, the default container type will be set |
| | | Height | No | decimal | Maximum container height in meters
Positive number greater than 0
If not specified, the height of the container type used will be taken by default. |
| | | Weight | No | decimal | Container real weight in kilograms
Positive number greater than 0 |
| | | Volume | No | decimal | Container volume in cubic meters
Positive number greater than 0 |
| | | DivisionTypeCode | No | string(50) | Division type of the receiving container
Has to be an existing division type, or an error will be notified |
| | | TransactionalLineList | No | bool | Indicator of transactionality for the line list. If 1 (true), the whole list must be treated as an atomic transaction. If 0 (false), each element must be individually transactioned. |
| | | CompleteLineList | No | bool | The 1..n group Lines has a complete attribute, which indicates whether all the existing components are included into the group(when true), or only the modified ones(when false):
When the complete attribute has a false value: Only the specific components of the group will be modified, other possible existing components maintains its previous value
When the complete has true value: The message has to include all order lines, because operations set in the lines will be performed and after that any other order line will be deleted of the system |
| | | LineList | No | List | Container stock list |
| | | | **Operation** | **Yes** | Enumeration | Operation to perform with the line stock
Possible values: 0: Create, 2: Delete |
| | | | **ProductCode** | **Yes** | string(50) | Stock code to be received
Has to be an existing item code, or an error will be notified |
| | | | OwnerCode | No | string(50) | Owner stock code
When no owner is set:
When only one owner exists into the system, this will be set
When some owner is default, this will be set
In other cases, an error will be notified
Has to be the existing stock owner code, or an error will be notified |
| | | | DivisionCode | No | string(65) | Field to notify the division for the receiving container.
Has to be and exisiting división code for the division type included, or an error will be notified.
If DivisionType is not included an error will be notified. |
| | | | **Quantity** | **Yes** | decimal | Stock quantity in the specified UoM (Unit of Measure)
Positive number greater than 0 |
| | | | **UnitOfMeasureCode** | **Yes** | string(50) | Stock UoM used to set the quantity
Existing UoM in EasyWMS, or an error will be notified |
| | | | SupplierCode | No | string(50) | Stock supplier code
Existing supplier code in EasyWMS, or an error will be notified |
| | | | Weight | No | decimal | Stock weight in kilograms
Positive number greater than 0 |
| | | | Package | No | string(65) | Open text to inform the ERP package number |
| | | | Status | No | Group | Defines the stock user status. |
| | | | | **StockStatus** | **Yes** | string(50) | Stock status that will be set when received
Existing stock status code, or an error will be notified |
| | | | | StatusEnd | No | DateTime | End stock status date time
UTC date-time forma |
| | | | | Comment | No | string(65) | Stock status comment |
| | | | LogisticAttributes | No | Group | Defines the logistic attributes of the stock of the line. |
| | | | | LotCode | No | string(65) | Mandatory LOT to be shipped. |
| | | | | SerialNumber | No | string(65) | Mandatory serial number to be shipped. |
| | | | | ProductionDate | No | DateTime | Earlier production date to be shipped. UTC date-time format |
| | | | | ExpirationDate | No | DateTime | Earlier expiration date to be shipped. UTC date-time format. |
| | | | | BestBeforeDate | No | DateTime | Earlier best before date to be shipped. UTC date-time format. |
| | | | | DaysOfLife | No | long | Lower shelf life to be shipped. Positive number greater than 0. |
| | | | | Quality | No | string(65) | Mandatory quality to be shipped. |
| | | | | Color | No | string(65) | Mandatory color to be shipped. |
| | | | | Source | No | string(65) | Mandatory origin to be shipped. |
| | | | | Version | No | string(65) | Mandatory version to be shipped. It is mandatory in case of requesting a non assembled kit item, and must correspond with an enabled version of the kit. |
| | | | | ProductionMethod | No | string(65) | Mandatory production method to be shipped. |
| | | | | PostProductionTreatment | No | string(65) | Mandatory post-production treatment to be shipped. |
| | | | | Size | No | string(65) | Mandatory size to be shipped. |
| | | | | Weight | No | decimal | Mandatory weight to be shipped. Decimal number greater than 0. |
| | | | CustomAttribute | No | Group | Custom attributes for the product |
| | | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | | CustomAttribute | No | Group | Custom attributes for the container |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | InboundOrderCode | No | string(50) | Receipt order
Receipt order code. It can be modified with Update operation |
| | NumExpectedContainers | No | long | Number of expected containers |
| | ExpectedOutboundOrderCode | No | string | Code of the expected outbound order. |
| | ExpectedRouteCode | No | string | Code of the expected outbound route. |
| | ExpectedRouteStopNumber | No | long | Number of the route stops expected. |
| | ExpectedReserveValidDate | No | DateTime | Max valid date for the reserve |
| InboundOrderCode | No | string(50) | Receipt order
Receipt order code. It can be modified with Update operation |
| ExpectedReserveValidDate | No | DateTime | Max valid date for the reserve |
##### Registration of pre-notified stock for replenishment - SRN
**Message type**: SRN (Stock Replenish Notice)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.StockForASNErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message is used for the creation and deletion of loose stock for automatic warehouse replenishment. - In the case of cancellation (2 (Delete)), not all fields are necessary, but only those that make up the primary key (marked in red). If the stock is created with the non mandatory groups (except the group ReplenishQueue), it will be necessary to indicate the same values that were filled for the creation of the stock. - The modification of the _site_ for the pre-advised stock will not be allowed - Pre-notified loose stock will always be created in _Pending Receipt_ status and at the ASN location. - If the ReplenishQueue group is not filled it is understood that you do not want to generate the replenishment order automatically. - The cancellation operation (2 (Delete)) can only be carried out while the loose stock is in the _Pending state_ - If you delete stock for which a replenishment order exists, the replenishment order must be cancelled automatically. - If loose stock is created for an item that does not contain sufficient logistical attributes to cover the reception profile of that item, the SRN message will be responded to with an error notifying the lack of pre-notification data.
**Structure**:
**SRN**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | The flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| **Operation** | **Yes** | Enumeration | The operation. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| **WarehouseCode** | **Yes** | string(50) | Warehouse site code. Both the Site and the Code univocally identify the stock.
An existing site must be included in the system and is not allowed to be modified |
| ReplenishQueueData | No | Group | The data about the replenishment. Contains all of the data needed for replenishment from ERP. |
| | **PickingStationCode** | **Yes** | string(50) | Picking conveyor of the replenishment |
| | **Priority** | **Yes** | Enumeration | Priority of the replenihsment order
Possible values: Urgent, High, Normal, Low, VeryLow |
| | **ReplenishmentMode** | **Yes** | Enumeration | Replenihsment mode
Possible values: Automatic, SameProduct, EmptyDivisions, EmptyContainers |
| | **ReplenishmentEfficiencyMode** | **Yes** | Enumeration | Efficiency mode
Possible values: None, Efficiency, Complete |
| ERPPack | No | string(50) | The ERP pack. |
| **Quantity** | **Yes** | decimal | Stock quantity in the UoM
Positive number higher than 0 |
| StockReceptionDate | No | DateTime | |
| UserDefinedStatusComment | No | string(65) | Comment of the stock status for that line |
| UserDefinedStatusEnd | No | DateTime | |
| UserDefinedStatusCode | No | string(50) | Status of the stock once received
Must reference an existing stock user status code in the system, otherwise an error will be reported |
| DivisionCode | No | string(50) | The division code |
| **ProductCode** | **Yes** | string(50) | Item code
YES a value that does not exist in the system is included with a Create operation will be registered, while YES the operation is Delete there will be an error |
| **OwnerCode** | **Yes** | string(50) | Item owner code
YES a value that does not exist in the system is included with a Create operation will be registered, while YES the operation is Delete there will be an error |
| **UnitOfMeasureCode** | **Yes** | string(50) | UoM of the quantity
Must be an existing UoM code in the system, otherwise an error will be notified |
| LogisticAttributes | No | Group | The logistic attributes. |
| | BestBeforeDate | No | DateTime | |
| | Colour | No | string | |
| | DaysOfLife | No | DateTime | |
| | ExpirationDate | No | DateTime | |
| | ProductionMethod | No | string | |
| | ProductionDate | No | DateTime | |
| | PostProductionTreatment | No | string | |
| | Quality | No | string | |
| | SerialNumber | No | string | |
| | Size | No | string | |
| | Source | No | string | |
| | Version | No | string | |
| | LotCode | No | string | |
| CustomAttribute | No | Group | The custom attributes |
| | Attribute1 | No | string | |
| | Attribute2 | No | string | |
| | Attribute3 | No | string | |
| | Attribute4 | No | string | |
| | Attribute5 | No | string | |
| | Attribute6 | No | string | |
| | Attribute7 | No | string | |
| | Attribute8 | No | string | |
| | Attribute9 | No | string | |
| | Attribute10 | No | string | |
| | Attribute11 | No | string | |
| | Attribute12 | No | string | |
| | Attribute13 | No | string | |
| | Attribute14 | No | string | |
| | Attribute15 | No | string | |
| | Attribute16 | No | string | |
| | Attribute17 | No | string | |
| | Attribute18 | No | string | |
| | Attribute19 | No | string | |
| | Attribute20 | No | string | |
| SupplierCode | No | string(50) | Supplier code
Must be an existing supplier code code in the system, otherwise an error will be notified |
| Weight | No | decimal | Stock weight
Positive number higher than 0 |
| SkipMixedValidations | No | bool | The skip mixed validations flag.
If the flag value is true, all mixed validations are skipped. |
| HasTrace | No | bool | The HasTrace flag.
Indicates if the Stock has trace (is Manufactured or Mounted). |
#### Exported messages
Messages that will be sent in Export direction (from MAP to the ERP).
##### Receipt order status change - ROC
**Message type**: ROC (Receipt orders status change)
**Import / Export**: Export
**Version**: 01
**Description**: With this message, Easy WMS notifies any status change of an existing receipt order in the system.
**Structure**:
**ROC01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site |
| **RorCode** | **Yes** | string(50) | Code of the receipt order |
| **Status** | **Yes** | string | Current receipt order status. Possible values: Waiting ReceptionPending Receiving PartiallyReceived Complete Expired Cancelled |
| **UpdateDate** | **Yes** | DateTime | Date and time at which the status change was performed. UTC date time format |
##### Receipt or receipt order finalization - ROF
For the receipt or receipt order finalization two version exist: [ROF01](communications/EasyWMS_WebApi_en.html.md#receipt-or-receipt-order-finalization---rof01) y [ROF02](communications/EasyWMS_WebApi_en.html.md#receipt-or-receipt-order-finalization---rof02)
###### Receipt or receipt order finalization - ROF01
**Message type**: ROF (Receipt or receipt order finalization)
**Import / Export**: Export
**Version**: 01
**Description**: With this message, Easy WMS notifies stock reception or the finalization of an existing receipt order in the system. This message is sent when a stock receipt is finished (closed) or a receipt order is finished (closed, cancelled or expired).
- When a stock receipt is related to more than one receipt orders, multiple ROF messages are sent, one for each related receipt order. In each message _RecCode_ contains the receipt code, _RorCode_ the receipt order code, and the receipt order lines the received data details including the total received quantity in the order until this moment.
- When a stock receipt is not related to any receipt order, only one ROF message is sent, containing all the receipt data including its line details.
- When a receipt order is finished, the message contains the code of the order in \*\*RorCode\* –while RecCode is empty– and its line data details including the order line number _inLneNumber_.
- The version of the message to be used must be specified in the _EasyWMS.config_ file.
```
<add key="INO.CNL.001" value="ROF01"/>
<add key="INO.CLS.001" value="ROF01"/>
<add key="REC.CLS.001" value="REF01"/>
```
**Structure**:
**ROF01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site where the reception is done |
| **RecCode** | **Yes** | string(50) | Receipt code. Mandatory when a receipt is finished |
| **RorCode** | **Yes** | string(50) | Receipt order code. Mandatory when a receipt order is finished |
| **Status** | **Yes** | string | Receipt or receipt order finish status. Values: Partially received Completed Expired Cancelled |
| Document | No | string(65) | Name of the delivery note file for the receipt or receipt order |
| Source | No | string(65) | Open text to describe the receipt origin |
| CarrierCode | No | string(50) | Receipt or receipt order carrier code |
| TransportType | No | string(1000) | Open text to describe the type of transportation |
| **ReceiptData** | **Yes** | Group | Data about the receipt. It contains the necessary data to define the receipt from the ERP |
| | RecDatContainers | No | long | Number of receibed containers for receipt (not send in receipt order). Positive number equal or greater than 0 |
| | RecDatDate | No | DateTime | Reception or expiration/cancellation date and time. UTC date-time format |
| | RecDatDock | No | string(50) | Receipt or receipt order entry dock |
| | RecDatTemperature | No | decimal | Stock temperature when received |
| **Lines** | **Yes** | Group | Data about the lines. It contains the necessary data to define the lines from the ERP |
| | **Line** | **Yes** | List | Data about the line. It contains the necessary data to define the line from the ERP |
| | | **LneNumber** | **Yes** | long | Receipt order stock line number. Receipt stock line number when the receipt has no order related |
| | | **LneItemCode** | **Yes** | string(50) | Received stock item code for this line |
| | | **LneOwnerCode** | **Yes** | string(50) | Received stock owner for this line |
| | | LneContCode | No | string(50) | Stock LPN for this line |
| | | LneStockStatus | No | string(50) | Received stock status for this line |
| | | LnePackage | No | string(65) | Open text to inform the ERP package number |
| | | LnePrice | No | Group | Data about the line price. It contains the necessary data to define the line price from the ERP |
| | | | **LnePriPurchase** | **Yes** | decimal | Informative field with the line total price. Positive number greater than 0 |
| | | | **LnePriCurrency** | **Yes** | string(65) | Currency in which the informaive price is set. Only used when LnePriPurchase has a value |
| | | **LneQuantity** | **Yes** | Group | Data about the line quantity. It contains the necessary data to define the line quantity from the ERP |
| | | | **LneQtyExpected** | **Yes** | decimal | Expected quantity (in the specified UoM). Positive number greater than 0 |
| | | | **LneQtyReceived** | **Yes** | decimal | Total received quantity (in the specified UoM) until this moment. Positive number |
| | | | LneQtyFree | No | decimal | Free of charge quantity expected (in to the specified UoM). Positive number |
| | | | **LneQtyUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the line quantity. Has to be an existing UoM into Easy WMS, or an error will be notified |
| | | LneAttributes | No | LneAttributesOut | Data about the line attributes. It contains the necessary data to define the line attributes from the ERP |
| | | LneCustomAttributes | No | LneCustomAttributes | Data about the line custom attributes. It contains the necessary data to define the line custom attributes from the ERP |
| CustomAttributes | No | CustomAttributes | Data about the custom attributes. It contains the necessary data to define the custom attributes from the ERP |
###### Receipt or receipt order finalization - ROF02
**Message type**: ROF (Receipt or receipt order finalization)
**Import / Export**: Export
**Version**: 02
**Description**: This message is used to notify the ERP of the closing of the receipt order and to inform of the quantities received. All the information of the received stock is also sent. - The version of the message to be used must be specified in the _EasyWMS.config_ file: `<add key="INO.CNL.001" value="ROF02"/> <add key="INO.CLS.001" value="ROF02"/> <add key="REC.CLS.001" value="REF01" />`
- This message is sent when a receipt order is finished (closed, cancelled or expired).
- Areceipt order can only be closed if it is in a partially received or completed state.
- When requesting the closing of a receipt order that has some receipts shared with other entry orders, the received stock will be marked with the label _LneStockIsShared_. This is due to the impossibility of determining for which receipt order a specific stock has been received when dealing with receipts from several orders.Las cantidades recibidas serán especificadas en _LneQtyReceived_. El stock recibido se informará en _StockReceivedLines_.
**Structure**:
**ROF02**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site where the reception is done |
| **RorCode** | **Yes** | string(50) | Receipt order code |
| **Status** | **Yes** | string | Receipt or receipt order finish status. Values: Closed, Cancelled |
| Document | No | string(65) | Name of the delivery note file for the receipt or receipt order |
| Source | No | string(65) | Open text to describe the receipt origin |
| CarrierCode | No | string(50) | Receipt or receipt order carrier code |
| TransportType | No | string(1000) | Open text to describe the type of transportation |
| **Lines** | **Yes** | Group | Lines data |
| | **Line** | **Yes** | List | Line data |
| | | **LneNumber** | **Yes** | long | Receipt order stock line number. Receipt stock line number when the receipt has no order related |
| | | **LneItemCode** | **Yes** | string(50) | Received stock item code for this line |
| | | **LneOwnerCode** | **Yes** | string(50) | Received stock owner for this line |
| | | LneContCode | No | string(50) | Stock LPN for this line |
| | | LneStockStatus | No | string(50) | Received stock status for this line |
| | | LnePackage | No | string(65) | Open text to inform the ERP package number |
| | | LnePrice | No | Group | Line price data |
| | | | **LnePriPurchase** | **Yes** | decimal | Informative field with the line total price |
| | | | **LnePriCurrency** | **Yes** | string(65) | Currency in which the informative price is set |
| | | **LneQuantity** | **Yes** | Group | Line quantity data |
| | | | **LneQtyExpected** | **Yes** | decimal | Expected quantity (in the specified UoM) |
| | | | **LneQtyReceived** | **Yes** | decimal | Total received quantity (in the specified UoM) until this moment |
| | | | LneQtyFree | No | decimal | Free of chargequantity expected (in to the specified UoM) |
| | | | **LneQtyUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the line quantity |
| | | LneAttributes | No | LneAttributesOut | Line attributes data |
| | | LneCustomAttributes | No | LneCustomAttributes | Line custom attributes |
| StockReceivedLines | No | Group | Stock received lines data |
| | **LneStockReceived** | **Yes** | List | Line stock received data |
| | | LneStockContainerCode | No | string(50) | Container code where the stock has been received |
| | | LneStockItemCode | No | string(50) | Item code |
| | | LneStockLineNumbers | No | Group | Receipt order line numbers. |
| | | | **LneStockLineNumber** | **Yes** | List | Number of the line the received stock belongs to |
| | | | | **LneStockNumber** | **Yes** | long | Value of the line number the received stock belongs to |
| | | LneStockQty | No | decimal | Quantity received |
| | | **LneStockUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the stock received |
| | | LneStockOwnerCode | No | string(50) | Stock received owner |
| | | LneStockStockStatus | No | string(50) | Stock status |
| | | LneStockStockStatusComment | No | string(1000) | Comment |
| | | LneStockStockStatusEndDate | No | DateTime | Stock status end date. UTC date-time format |
| | | LneStockStockStatusRec | No | string(50) | User status |
| | | LneStockStockStatusRecEndDate | No | DateTime | User stock status end date. UTC date-time format |
| | | LneStockRecDate | No | DateTime | Receipt date. UTC date-time format |
| | | LneStockWeight | No | decimal | Line stock weight |
| | | LneStockIsShared | No | bool | By allowing you to merge multiple orders into a single receipt, we can not relate the received stock to an order line with accuracy.So all the stock received from several entry orders in the same receipt, will be marked with true value |
| | | LneStockAttributes | No | LneStockAttributes | Line stock attributes |
| | | LneStockCustomAttributes | No | LneStockCustomAttributes | Line stock custom attributes |
| CustomAttributes | No | CustomAttributes | Custom attributes data |
##### Receipt end - REF
**Message type**: REF (Receipt finalization)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used to notify the ERP of the receipt of stock. - This message will be sent after the close of a reception. - When we close a receipt that is associated to several receipt orders simultaneously, the received stock will be informed, and the potential receipt orders and potential lines for which the stock could have been received will be notified. - When there is an end of a reception that is not associated with any receipt order, a single REF message will be sent with all the reception data (including its code in _RecCode_) and its lines (with its numbering in _LneNumber_). - The stock received will be informed with the tag _StockReceivedLines_. - It will not be possible to close a reception if nothing has been received. In that case it can only be canceled. Canceling a reception does not generate REF.
**Structure**:
**REF01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site where the reception is done. Mandatory when a receipt is finished |
| **ReceiptCode** | **Yes** | string(50) | Receipt order code. Mandatory when a receipt order is finished |
| **Status** | **Yes** | string | Receipt or receipt order finish status. Values: Partially received Completed Expired Cancelled |
| Document | No | string(65) | Name of the delivery note file for the receipt or receipt order |
| Source | No | string(65) | Open text to describe the receipt origin |
| CarrierCode | No | string(50) | Receipt or receipt order carrier code |
| TransportType | No | string(1000) | Open text to describe the type of transportation |
| **ReceiptData** | **Yes** | Group | Data about the receipt. It contains the necessary data to define the receipt from the ERP |
| | **RecDatContainers** | **Yes** | long | Number of received containers for receipt (not send in receipt order). Positive number equal or greater than 0 |
| | RecDatDate | No | DateTime | Reception or expiration/cancelation date and time. UTC date-time format |
| | RecDatDock | No | string(50) | Receipt or receipt order entry dock |
| | RecDatTemperature | No | decimal | Stock temperature when received |
| **Lines** | **Yes** | Group | Data about the lines. It contains the necessary data to define the lines from the ERP |
| | **Line** | **Yes** | List | Data about the line. It contains the necessary data to define the line from the ERP |
| | | **LneNumber** | **Yes** | long | Receipt line number |
| | | **LneRecOrdersPotential** | **Yes** | Group | Data about the line reception orders potential. It contains the necessary data to define the line reception orders potential from the ERP |
| | | | **LneRecOrderPotential** | **Yes** | List | Data about the line reception orders potential. It contains the necessary data to define the line reception orders potential from the ERP |
| | | | | LneRecOrderCode | No | string(50) | Receipt order that can be candidate to receive the stock |
| | | | | LneRecOrderNumber | No | long | Receipt order line that can be candidate to receive the stock |
| | | | | LneRecOrderQttyReceived | No | decimal | Received quantity for the input order line from the receiving line |
| | | **LneItemCode** | **Yes** | string(50) | Line item code |
| | | **LneOwnerCode** | **Yes** | string(50) | Line owner code |
| | | LneContCode | No | string(50) | Line container code |
| | | LneStockStatus | No | string(50) | Line stock status |
| | | LnePackage | No | string(65) | Line package |
| | | LnePrice | No | Group | Data about the line price. It contains the necessary data to define the line price from the ERP |
| | | | **LnePriPurchase** | **Yes** | decimal | Informative field with the line total price. Positive number greater than 0 |
| | | | **LnePriCurrency** | **Yes** | string(65) | Currency in which the informative price is set. Only used when LnePriPurchase has a value |
| | | **LneQuantity** | **Yes** | Group | Data about the line quantity. It contains the necessary data to define the line quantity from the ERP |
| | | | **LneQtyExpected** | **Yes** | decimal | Expected quantity (in the specified UoM). Positive number greater than 0 |
| | | | **LneQtyReceived** | **Yes** | decimal | Total received quantity (in the specified UoM) until this moment. Positive number |
| | | | LneQtyFree | No | decimal | Free of chargequantity expected (in to the specified UoM). Positive number |
| | | | **LneQtyUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the line quantity.Has to be an existing UoM into Easy WMS, or an error will be notified |
| | | LneAttributes | No | LneAttributesOut | Data about the line attributes. It contains the necessary data to define the line attributes from the ERP |
| | | LneCustomAttributes | No | LneCustomAttributes | Data about the line custom attributes. It contains the necessary data to define the line custom attributes from the ERP |
| | | StockReceivedLines | No | Group | Data about the stock received lines. It contains the necessary data to define the stock received lines from the ERP |
| | | | **LneStockReceived** | **Yes** | List | Data about the line stock received. It contains the necessary data to define the line stock received from the ERP |
| | | | | LneStockContainerCode | No | string(50) | Container code where the stock has been received |
| | | | | LneStockItemCode | No | string(50) | Item code |
| | | | | LneStockQty | No | decimal | Quantity received |
| | | | | LneStockUoMCode | No | string(50) | UoM (Units of Measure) of the stock received |
| | | | | LneStockOwnerCode | No | string(50) | Stock received owner |
| | | | | LneStockStockStatus | No | string(50) | Stock status |
| | | | | LneStockStockStatusComment | No | string(1000) | Comment |
| | | | | LneStockStockStatusEndDate | No | DateTime | Stock status en date. UTC date-time format |
| | | | | LneStockStockStatusRec | No | string(50) | User stock status |
| | | | | LneStockStockStatusRecEndDate | No | DateTime | User stock status end date. UTC date-time format |
| | | | | LneStockRecDate | No | DateTime | Receipt date. UTC date-time format |
| | | | | LneStockWeight | No | decimal | Line stock weight |
| | | | | LneStockAttributes | No | LneStockAttributes | Data about the line stock attributes. It contains the necessary data to define the line stock attributes from the ERP |
| | | | | LneStockCustomAttributes | No | LneStockCustomAttributes | Data about the line stock custom attributes. It contains the necessary data to define the line stock custom attributes from the ERP |
| | | | | LneStockDivisionCode | No | string(50) | Division code |
| RecCustomAttributes | No | CustomAttributes | Data about the reception custom attributes. It contains the necessary data to define the reception custom attributes from the ERP |
##### Advanced shipping notice OK - ASO
**Message type**: ASO (Advanced shipping notice OK)
**Import / Export**: Export
**Version**: 01
**Description**: This message confirms to the ERP the inbound of an advanced shipping LPN (ASN) into the warehouse site. - All received stock _lines_ has to be included in the ASO message. - When no Lines group included, empty LPN container is confirmed. - Stacked containers: - Containers group is used to notified the received stacked containers. A stacked container can also have as many Containers groups as nested containers as needed to establish the hierarchy.
**Structure**:
**ASO01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site |
| ContainerCode | No | string(50) | Receipt LPN (License plate number) |
| **ContainerType** | **Yes** | string(50) | Receipt container type |
| **ReceptionDate** | **Yes** | DateTime | Date and time of the reception. UTC date-time format |
| Height | No | decimal | Maximum height, in meters. Positive number greater than 0 |
| Weight | No | decimal | Total weight received in this LPN, in kilos (including containers). Positive number greater than 0 |
| Volume | No | decimal | Volumecubic metersreceipt. Positive number greater than 0 |
| IsSlave | No | bool | If true (value 1) the container is a slave container: It has not stock but fisically exists |
| ReceiptOrderCode | No | string(50) | Receipt order code |
| DivisionType | No | string(50) | Division type of the receiving container |
| Lines | No | Group | Lines data |
| | **Line** | **Yes** | List | Line type |
| | | **LneItemCode** | **Yes** | string(50) | Stock item code |
| | | **LneOwnerCode** | **Yes** | string(50) | Stock owner code |
| | | LneDivision | No | string(50) | Line division code |
| | | **LneQuantity** | **Yes** | decimal | Received quantity (into the specified UoM) |
| | | **LneUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the LneQuantity |
| | | LneSupplierCode | No | string(50) | Item supplier code |
| | | LneWeight | No | decimal | Received stock weight in kilos. Positive number greater than 0 |
| | | LnePackage | No | string(65) | Open text to inform the ERP package number |
| | | LneStatus | No | Group | Line status data |
| | | | **LneStaStatus** | **Yes** | string(50) | Status of the stock to be received |
| | | | LneStaEnd | No | DateTime | Stock status end date and time |
| | | | LneStaComment | No | string(1000) | Stock status comment |
| | | LneAttributes | No | StockAttributes | Line attributes data |
| | | LneCustomAttributes | No | LneCustomAttributes | Line custom attributes data |
| CustomAttributes | No | CustomAttributes | Custom attributes |
| Containers | No | Group | Containers data |
| | Container | No | List | Container data |
##### Advanced shipping notice KO - ASK
**Message type**: ASK (Advanced shipping notice KO)
**Import / Export**: Export
**Version**: 01
**Description**: This message cancels to the ERP the inbound of an advanced shipping LPN (ASN) into the warehouse site (the LPN has not been received). - When the LPN is cancelled, all its lines notified in advanced are cancelled too. - When only some stock lines are receipt into a LPN, no cancellation message is sent but a confirmation message (ASO) instead.
**Structure**:
**ASK01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site where the LPN was expected |
| **ContainerCode** | **Yes** | string(50) | Advanced receipt LPN (License plate number) |
| **CancelDate** | **Yes** | DateTime | Cancellation date and time. UTC date-time format |
| ReceiptOrderCode | No | string(50) | Receipt order code |
##### Replenishment of pre-notified loose stock – SRO
**Message type**: SRO (Stock replenish notice OK)
**Import / Export**: Export
**Version**: 01
**Nombre del fichero XML**: SRO01yyyyMMddHHmmssxxx.xml
**Description**: This message is used to confirm that the stock created for the replenishment of the automatic warehouse has been used for replenishment and has been registered as available stock.
**Structure**:
**SRO01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Site code where the stock is |
| **ItemCode** | **Yes** | string(50) | Item code |
| **OwnerCode** | **Yes** | string(50) | Owner code |
| **Quantity** | **Yes** | decimal | Stock quantity. Positive number higher or equal to zero |
| **UoMCode** | **Yes** | string(50) | UoM of the quantity |
| **ContainerCode** | **Yes** | string(50) | Destination code container. Code of the container destination of the replenishment |
| DivisionCode | No | string(50) | Destination division of the container. Code of the division destination of the replenishment |
| **LocationCode** | **Yes** | string(50) | Location where the stock has been processed |
| **ReceptionDate** | **Yes** | DateTime | Date and hour of the replenishment. UTC date-time format |
| Status | No | Group | Data about the status. It contains the necessary data to define the status from the ERP |
| | **StaUsrCode** | **Yes** | string(50) | Current user status of the stock |
| | StaUsrEnd | No | DateTime | End date of current user status of the stock. Date and hour in UTC format |
| | StaUsrComment | No | string(1000) | Comment on current user status of the stock |
| Attributes | No | StockAttributes | Data about the stock attributes. It contains the necessary data to define the stock attributes from the ERP |
| CustomAttributes | No | CustomAttributes | Data about the custom attributes. It contains the necessary data to define the custom attributes from the ERP |
##### Cancellation of pre-notified loose stock for replenishment – SRK
**Message type**: SRK (Stock Replenish notice KO)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used to indicate the cancellation of loose stock created for the replenishment of an automatic warehouse and which has not been used.
**Structure**:
**SRK01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the site where the stock is located |
| **CancelDate** | **Yes** | DateTime | Date and time the stock was removed. Date and hour in UTC format |
| **ItemCode** | **Yes** | string(50) | Item code |
| **OwnerCode** | **Yes** | string(50) | Owner code |
| **Quantity** | **Yes** | decimal | Stock quantity. Positive number higher or equal to zero |
| **UoMCode** | **Yes** | string(50) | UoM of the quantity. You must reference an existing conversion in the system. Otherwise the error will be notified |
| Status | No | Group | Data about the status. It contains the necessary data to define the status from the ERP |
| | **StaUsrCode** | **Yes** | string(50) | Current user status of the stock |
| | StaUsrEnd | No | DateTime | End date of current user status of the stock. Date and hour in UTC format |
| | StaUsrComment | No | string(1000) | Comment on current user status of the stock |
| Attributes | No | StockAttributes | Data about the stock attributes. It contains the necessary data to define the stock attributes from the ERP |
| CustomAttributes | No | CustomAttributes | Data about the custom attributes. It contains the necessary data to define the custom attributes from the ERP |
### Shipping
#### Imported messages
Messages that will be received in Import direction (from the ERP to MAP).
##### Shipping orders - SOR
**Message type**: SOR (Shipping orders)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Expeditions.Contracts.Commands.OutboundOrderErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows creating, modifying, deleting and upserting the shipping orders data managed in Easy WMS.
- Shipping orders processed will be created and set to the _Waiting_ status.
- When deleting, not all data is necessary but only primary key data (marked in red).
- Line number is the primary key data when operating with order lines. Must be greather than 0.
- It is not allowed to change the _Site_ in existing shipping orders.
- It is not allowed to change the header data in merged orders.
- _Update_, _Delete_ and _Upsert_ operations (1, 2, 3) depends on the current order status and its lines status, i.e.: Delete (2) could imply order cancelation -not deletion- when the status is different of _Creating_ and do not allow deleting the order or its lines.
- Shipping orders and lines will be created with the data _AutoCreated_ false y _ReceivedFromERP_ true.
- Only shipping orders created by SOR message could be deleted or modified using SOR messages with operations Update (1), Delete (2) or Upsert (3).
- When not any dock is set in the message, the default shipping dock for the site is used (when existing).
- Shipping order lines could always be created (when not _Cancelled_ or _Closed_).
- All shipping order lines attributes can be modified if no quantity has been prepared or shipped. Shipping order lines quantities (Quantity data group but not UnitOfMeasureCode) can always be modified, being the minimum limit the already shipped quantity.
- Shipping order lines that are not merged could be deleted when notCancelled or Closed.
- The 1..n group Lines has a complete attribute, which indicates whether all the existing components are included into the group (when true), or only the modified ones (when false):
- When the complete attribute has a false (0) value: Only the specific components of the group will be modified, other possible existing components maintains its previous value.
- When the complete has true (1) value: The message has to include all order lines, because operations set in the lines will be performed and after that any other order line will be deleted of the system. E.g.:
- A new shipping order is sent with two order lines on it -> the order and its lines are created into the Easy WMS system
- A modification of the order is sent with a new line and the complete attribute set to true -> the order line will be created but the old two existing lines will be removed from the order list, so the order will have only one line to ship in the Easy WMS system.
- Default operation in the Lines group is 3 (Upsert).
- Lines could specify requested item, container, or both, in which case it refers to the specific stock from this item stored in the specified container.
- If lines transactional attribute is set to true (transactional true)and an error happens, the order will not be created. Otherwise (transactional false), the order is created without the lines that fails.
- For update any attribute on a line, the rest of attributes must be set with the right values. There is not supported to communicate attributes to null to respect the old values (note that _ignoreNull_ attribute on the lines group is not available)
- _AllowDynamicReplenishment_ field enables automatic replenishment, so, when a shipping order is received with this field active, the automatic job that enables dynamic picking will be active too, creating the requiered tasks to do it. If the field is empty or false automatic replenishment will not be active.
**Structure**:
**SOR**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | Flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| Operation | No | Enumeration | Operation to do with the shipping order. An error may be reported if the operation is not allowed for the shipping order status. Operation 2 (Delete) will involve a deletion when the order is in creation or a cancellation when it is released. Possibles values: 0 (Create), 1 (Update), 2 (Delete), 3 (Upsert). |
| **Code** | **Yes** | string(50) | Code of the shipping order. If a non-existent value is included in the system with an operation 0 (Create) or 3 (Upsert) will be registered, while if the operation is 1 (Update) or 2 (Delete) an error will occur. |
| NewCode | No | string(50) | New shipping order code. It will only be used in case you want to modify: operations 1 (Update), 3 (Upsert). |
| **Site** | **Yes** | string(50) | System site code. An existing site must be included in the system and its modification is not allowed. |
| Data | No | Group | Data about the shipping order. It contains the necessary data to define a shipping order from the ERP. |
| | Priority | No | Enumeration | Priority of the shipping order. It is ignored when has route. Possible values: 0 (Urgent), 1 (High), 2 (Normal), 3 (Low) and 4 (VeryLow). |
| | OutboundType | No | Enumeration | Priority of the shipping order. Possible values: 0 (Customer), 1 (Return), 2 (Transfer), 3 (Manual), 4 (DirectTransfer), 5 (KitAssembly), 6 (Manufacturing), 7 (KitDisassembly), 8 (Replenishment) y 9 (Desk). |
| | AccountCode | No | string(50) | Account in case the type is Customer. You must reference an existing customer account code in the system, otherwise error will be reported. The value will only be taken into account if the type is Customer. |
| | OutboundClassCode | No | string(50) | The shipping class code. It will only be used for the case that the type is Customer. It must refer to an existing shipping class code that can also be received from ERP or else the error will be notified. |
| | SupplierCode | No | string(50) | Supplier for the case that the type is Return. You must reference an existing supplier code in the system, otherwise error will be reported. The value will only be taken into account if the type is Return. |
| | WarehouseToCode | No | string(50) | Code of the site to which the transfer is made in case the type is Transfer or DirectTransfer. You must reference an existing site in the system, otherwise error will be reported. The value will only be taken into account in case the type is Transfer or DirectTransfer and in this case it will be mandatory. |
| | Document | No | string(65) | Delivery note for the shipping order. |
| | Source | No | string(65) | Free text to describe the shipping order’s origin. |
| | Description | No | string(1000) | Shipping order’s description. |
| | DeliveryInstructions | No | string(1000) | Shipping order’s delivery instructions. |
| | DeskLocationCode | No | string(50) | Code of the location of the counter to which the order is addressed in case of being of type Desk. Code of the location of the counter to which the order is directed. The value will only be taken into account in case the type is Desk and in this case it will be mandatory. |
| | ValidDate | No | DateTime | The date after which the shipping order is not valid. |
| | FollowSequence | No | bool | If it is 1 (true) the sequence indicated by the lines of the shipping order must be followed, 0 (False) otherwise. If it is not filled, the default value 0 (false) will be taken. |
| | Transport | No | Group | Data about the transport of the shipping order. It contains the necessary data to define the transport of shipping order from the ERP. |
| | | AgencyCode | No | string(50) | Transport agency code. There must be the transport agency code in the system, otherwise error will be reported. |
| | | TransportType | No | string(65) | Free text to indicate the type of transport. |
| | | RouteCode | No | string(50) | Code of the route on which the shipping order will be transported. The route code must exist in the system, otherwise error will be reported. |
| | | StopNumber | No | long | Stop number of the route on which the shipping order will be downloaded. Positive integer greater than 0. It will only be taken into account when the RouteCode field is filled, and in that case it will also be mandatory. |
| | Planning | No | Group | Data about the planning of the shipping order. It contains the necessary data to define the planing of shipping order from the ERP. |
| | | AutoReleaseDate | No | DateTime | Date and time of self-release. If it is not refilled it will not self-release. In UTC time. In case of having value, AutoRelease true will be taken in the shipping order. It will not be taken into account if the RouteCode field is filled. |
| | | EstimatedNumCont | No | long | Estimated number of containers that will be part of the shipping order. Positive integer greater than 0. |
| | | ExpectedDockStationCode | No | string(50) | Dock where the loading is expected to be done. Information field. There must be the dock in the system, otherwise error will be reported. It will not be taken into account if the RouteCode field is filled. |
| | | AssignedDockStationCode | No | string(50) | Assigned load dock. There must be the dock in the system, otherwise error will be reported. It will not be taken into account if the RouteCode field is filled. |
| | | PlannedLoadDate | No | DateTime | Estimated load date. In UTC time. |
| | | PlannedShippingDate | No | DateTime | Estimated shipping date. In UTC time. |
| | Preparation | No | Group | Data about the preparation of the shipping order. It contains the necessary data to define the preparation of shipping order from the ERP. |
| | | PackingLocationCode | No | string(50) | Packaging location. It must correspond to an existing packaging location on the system, otherwise error will be reported. |
| | | RequiredClientContainerTypeCode | No | string(50) | Type of client containers expected. It must correspond to an existing container type in the system, otherwise error will be reported. |
| | | ClientContainerTypeCode | No | string(50) | Type of client containers favourite. It must correspond to an existing container type in the system, otherwise error will be reported. |
| | | ClientContainerNumLabels | No | long | Number of labels required for client containers. Positive integer greater than 0. |
| | | ShipReportNumCopies | No | long | Number of copies of the shipping order report. Positive integer greater than 0. |
| | | PackingListNumCopies | No | long | The number of copies of the packaging list. Positive integer greater than 0. |
| | | RequiresPackaging | No | bool | Indicates whether the shipping order should be packaged when it is removed. By default the value 0 (false) will be taken. |
| | TransactionalLineList | No | bool | Indicator of transactionality for the line list. If 1 (true), the whole list must be treated as an atomic transaction. If 0 (false), each element must be individually transactioned. |
| | CompleteLineList | No | bool | Indicator of completeness for the line list. If 1 (true), the whole list must be treated as the only lines allowed for the shipping order. If 0 (false), more lines appart from those in the list can exist for this shipping order. |
| | AllowDynamicReplenishment | No | bool | Indicator to enable automatic replenishment. If it is 1 (true) enable automatic replenishment for items that need it. If it is not filled, the default value 0 (false) will be taken. |
| | LineList | No | List | List of lines for this shipping order. |
| | | Operation | No | Enumeration | Operation to be performed with the data of each line. An error may be reported if the operation is not allowed for the shipping order status. Operation 2 (Delete) will involve a deletion when the shipping order is in creation or a cancellation of the line when the shipping order is released. Possible values: 0 (Create), 1 (Update), 2 (Delete), 3 (Upsert). |
| | | **LineNumber** | **Yes** | long | Line number. It must be unique in shipping order and greater than 0. Otherwise, an error will be reported. It is the line’s unique key identifier for operations 1 (Update), 2 (Delete) and 3 (Upsert). |
| | | MaxLots | No | long | Maximum number of lots that can be shipped if the product has a lot in its logistics profile. Positive number greater than 0. |
| | | ProductCode | No | string(50) | Code of the ordered item. If a container is also indicated, it indicates where the item is wanted. You must reference an existing item code in the system. Otherwise, an error will be reported. It is mandatory if ContainerCode does not exist. |
| | | OwnerCode | No | string(50) | Owner of the ordered item. It is not necessary when what is being ordered is a container. In case of not indicating owner when an item is being ordered, it is considered: a) If there is only one owner for the indicated item, it will be this.b) If there are several owners for the indicated item and one is marked as default, it will be this.c) Otherwise an error will occur. You must reference an existing owner code in the system, otherwise an error will be reported. Owner of the ordered item. This is required only when a value is entered in ProductCode. |
| | | ContainerCode | No | string(50) | Free text that references the code of the ordered container if a specific one is required. If an item is also requested, indicate which container you want that item from. It is mandatory if there is no ProductCode. |
| | | Comment | No | string(1000) | Comment for the shipping order line. |
| | | Quantity | No | Group | Data about the quantity of the line of the shipping order. It contains the data needed to define the quantity of a line of the shipping order from the ERP. |
| | | | QuantityOrdered | No | decimal | Quantity to ship, in the specified UoM. Positive number greater than 0 |
| | | | UnitOfMeasureCode | No | string(50) | Unit of Measure of the line quantity. Has to be an existing UoM into Easy WMS, or an error will be notified. |
| | | | RequiredUnitOfMeasure | No | bool | When 1 (true), the stock has to be shipped in the specified UoM When 0 (false), the stock quantity could be shipped in a different UoM Default value is 0 (false) |
| | | | QuantityToReserve | No | decimal | Quantity to be reserved before shipping in the specified UoM. Positive number greater than 0. |
| | | | QuantityRejected | No | decimal | ejected to be shipped quantity in the specified UoM. Positive number greater than 0. |
| | | | AllowAssignStockExcess | No | bool | When 1 (true) it is allowed to ship over quantity, when 0 (false) it is not.Default value is 0 (false). |
| | | Terms | No | Group | Data about the terms of the shipping order line. It contains the data necessary to define the terms of a line of the shipping order from the ERP. |
| | | | FavouriteContainerTypeCode | No | string(50) | Preferred container type when shipping containers.Only used when no value set in ContainerCode. Has to be an existing container type into EasyWMS, or an error will be notified. |
| | | | FavouriteUnitOfMeasureCode | No | string(50) | Preferred UoM (Unit of Measure) to ship the stock.It must be equal to that specified in UnitOfMeasureCode or to break it. Has to be an existing UoM into Easy WMS, or an error will be notified. |
| | | | CatchWeight | No | bool | Indicates that the weight of the stock must be recorded in shipment 1 (true), 0 (false) otherwise. |
| | | | RequiredToShip | No | bool | When 1 (true), this line is mandatory to ship the whole order. When not introduced, default value is 0 (false). |
| | | | IsCritical | No | bool | When 1 (true), the line must be served complete. If it cannot be served complete, none of the line is served. When not introduced, default value is 0 (false). |
| | | | UseAlternativeProducts | No | bool | |
| | | | Status | No | Group | Data about the stock status required by the line of the shipping order. It contains the necessary data to define the required stock status of a line of the output order from the ERP. |
| | | | | FavouriteStockStatusCode | No | string(50) | Preferred stock status for this line. Has to be an existing status code into EasyWMS, or an error will be notified. Only used when LneTrmStaReq is not set. |
| | | | | RequireStockStatusCode | No | string(50) | Mandatory stock status for this line. Has to be an existing status code into EasyWMS, or an error will be notified. |
| | | | | RejectStockStatusCode | No | string(50) | Not allowed stock status for this line. Has to be an existing status code into EasyWMS, or an error will be notified. |
| | | | ContainerTypeCode | No | string | Type of container required to ship. It must reference an existing container type on the system, otherwise the error will be reported. |
| | | Customer | No | Group | Data about the line of the shipping order of the customer ERP. It contains the necessary data to indicate the customer ERP information of the shipping order line. |
| | | | ProductCode | No | string(65) | Open text to specify the stock customer code. |
| | | | LineNo | No | long | Open text to specify the customer stock line number. |
| | | AltProduct | No | Group | Data about the alternative product the line of the shipping order. It contains the necessary data to define the alternative product of a line of the shipping order from the ERP. |
| | | | ProductCode | No | string(50) | Alternative item code. Has to be an existing item code, owned by the same owner into Easy WMS, or an error will be notified. |
| | | | FromFactor | No | decimal | Units of the original item that are replaced with the quantity specified in ToFactor specified in the item base UoM. Positive number greater than 0. |
| | | | ToFactor | No | decimal | Units of the substitutive item that replace the quantity specified in FromFactor. Positive number greater than 0. |
| | | | UnitOfMeasureCodeTo | No | string(50) | UoM used to describe the quantity specified in ToFactor. Has to be an existing UoM into Easy WMS, or an error will be notified. |
| | | PurchasePrice | No | Group | Data about the price of the product line of the shipping order. It contains the necessary data to define the price of the product of a line of the shipping order from the ERP. |
| | | | **Quantity** | **Yes** | decimal | Informative field with the line total price. Positive number greater than 0. |
| | | | **Currency** | **Yes** | string(65) | Currency related to LneCstPurchase. Only when Quantity is set. |
| | | LogisticAttributes | No | Group | Data about the line logistic attributes of the shipping order. It contains the necessary data to define the logistic attributes of a line of the shipping order from the ERP. |
| | | | LotCode | No | string(65) | Mandatory LOT to be shipped. |
| | | | SerialNumber | No | string(65) | Mandatory serial number to be shipped. |
| | | | ProductionDate | No | DateTime | Earlier production date to be shipped. UTC date-time format |
| | | | ExpirationDate | No | DateTime | Earlier expiration date to be shipped. UTC date-time format. |
| | | | BestBeforeDate | No | DateTime | Earlier best before date to be shipped. UTC date-time format. |
| | | | DaysOfLife | No | long | Lower shelf life to be shipped. Positive number greater than 0. |
| | | | Quality | No | string(65) | Mandatory quality to be shipped. |
| | | | Color | No | string(65) | Mandatory color to be shipped. |
| | | | Source | No | string(65) | Mandatory origin to be shipped. |
| | | | Version | No | string(65) | Mandatory version to be shipped. It is mandatory in case of requesting a non assembled kit item, and must correspond with an enabled version of the kit. |
| | | | ProductionMethod | No | string(65) | Mandatory production method to be shipped. |
| | | | PostProductionTreatment | No | string(65) | Mandatory post-production treatment to be shipped. |
| | | | Size | No | string(65) | Mandatory size to be shipped. |
| | | | Weight | No | decimal | Mandatory weight to be shipped. Decimal number greater than 0. |
| | | CustomAttribute | No | Group | Data about the custom line attributes of the shipping order. It contains the data needed to define the custom attributes of a line of the shipping order from the ERP. |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | | Transport | No | Group | Data about the line transport of the shipping order. It contains the data necessary to define the transport of a line of the shipping order from the ERP. |
| | | | AgencyCode | No | string(50) | Agency to make the shipment. Agency code must exists in the WMS. Otherwise the WMS will return an error. |
| | | | TransportType | No | string(65) | Transport type to make the shipment. |
| | CustomAttribute | No | Group | Custom attributes for the shipping order. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | CreationDateOnERP | No | DateTime | Creation date of the shipping order in the ERP. |
| | Address | No | Group | Data about the shipping address of the shipping order. It contains the necessary data to define the shipping address of the shipping order from the ERP. |
| | | ZipCode | No | string(65) | Address ZIP Code. |
| | | AddressLine | No | string(65) | First address line. |
| | | AddressLine2 | No | string(65) | Extra address line. |
| | | City | No | string(65) | Address city. |
| | | State | No | string(65) | Address state. |
| | | Country | No | string(65) | Address country. (Two-letter ISO country code). |
| | | Comment | No | string(1000) | Address comment. |
| | ShipExpiredStock | No | bool | Indicates whether the order lines ship expired stock. If it is 1 (true) it will be assigned to all the lines of the order only expired stock. Otherwise the order ships unexpired stock. |
| | PrepackagingConfiguration | No | Group | Data about the prepackaging configuration of the shipping order. It contains the necessary data to define the prepackaging configuration of the shipping order from the ERP. |
| | | Operation | No | Enumeration | Operation to do. Possibles values: 0 (Create), 1 (Update), 2 (Delete), 3 (UPSERT).. |
| | | PrepackagingProcess | No | Enumeration | Indicates the process in which the preapackaging is performed (Picking, Consolidation o Packing). Posibles valores: 0 (Picking), 1 (Consolidation), 2 (Packing). |
| | | PrepackagingWorkingMode | No | Enumeration | If it is NonStrict, it enables the possibility to modify the prepackaging during the process, creating new containers or using different container types than those indicated. Possible values: 0 (Strict), 1 (NonStrict). If it is not filled, the value Strict will be taken by default. |
| | | TransactionalLineList | No | bool | Indicator of transactionality for the line list. If 1 (true), the whole list must be treated as an atomic transaction. If 0 (false), each element must be individually transactioned. |
| | | CompleteLineList | No | bool | Indicator of completeness for the line list. If 1 (true), the whole list must be treated as the only lines allowed for the shipping order. If 0 (false), more lines appart from those in the list can exist for this shipping order. |
| | | PrepackagingContainersList | No | List | List of prepackaging containers. |
| | | | Operation | No | Enumeration | Operation to do. Possibles values: 0 (Create), 1 (Update), 2 (Delete), 3 (UPSERT). |
| | | | ContainerType | No | string(50) | Container type code. It must be registered in EasyWMS. Otherwise an error will occur. |
| | | | PrepackagingLines | No | List | List of prepackaging lines for this outbound order. |
| | | | | Operation | No | Enumeration | Operation to do. Possibles values: 0 (Create), 1 (Update), 2 (Delete), 3 (UPSERT). |
| | | | | LineQuantity | No | decimal | Quantity to be located of the stock of the corresponding line in the container. It must be a positive number greater than 0. |
| | | | | OrderLineNumber | No | long | The order number of the shipping order line. Corresponds to the LineNumber field. It must be unique per container. Otherwise, an error will be reported. It is the key unique identifier of the prepackaging line for operations U, D and S. |
| | | | OrderContainer | No | long | The order number of the container for the shipping order. It must be a positive number greater than 0. It must be unique in shipping order. Otherwise, an error will be reported. It is the key unique identifier for U, D, and S operations. |
| | OwnerCode | No | string(50) | Code of the owner to whom the shipping order belongs. You must reference an existing owner in the system, otherwise error will be reported. |
##### Routes - RUT
**Message type**: RUT (Routes)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Expeditions.Contracts.Commands.RouteErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows creating, modifying, deleting and upserting the routes and shipping orders managed in Easy WMS. - Routes created with this message, will have _ReceivedFromERP_ set true, and will be completely created so its status will be _Waiting_. - It is not allowed to change the _Site_ in existing routes - Only routes created by RUT message could be deleted or modified using RUT messages with operations Update (1), Delete (2) or Upsert (3) - When deleting, not all data is necessary but only primary key data (marked in red). - When adding or removing shipping orders tothe route orders list, or cancelling the route itself, the order will be removed or added from the route list, but not from the Easy WMS system. - When not any dock is set, the default shipping dock for the site is used (when existing) - Shipping orders included into the _SORs_ 1..n group, can be existing shipping orders or new ones, which would be created in the system. Existing ones will inherit from the route its priority, expected dock, carrier, and autorelease date, as well as being released, stopped, or paused according to the route current state. - SOR elements into the route _SORs_ group will be treated as if received in separated SOR messages including them into the route, except for priority, autorelease date and expected dock which will be the same as in the route. - When _SORs_ group attribute _transactional_ is set true, if any order import fails, thre route shouldn’t be created. Otherwise (_transactional false_) the route will be created without the order that fails. - It’s not mandatory to include the lines of the outbound order. If not included, the existing ones are ketp.
**Structure**:
**RUT**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | Flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| **Operation** | **Yes** | Enumeration | Operation to perform.
0: Create, 1: Update, 2: Delete, 3: Upsert |
| **Code** | **Yes** | string(50) | Route code.
When a non-existing value is included and an ooperation 0 (Create) or 3 (Upsert) is performed, this will be created. |
| NewCode | No | string(50) | New route code.
Only used when a modification is performed 1 (Update), 3 (Upsert). |
| **Site** | **Yes** | string(50) | Warehouse site code.
Has to be an existing site, and it is not allowed to modify it. |
| Data | No | Group | Data about the route. Contains all necessary data to define an route from the ERP |
| | Priority | No | Enumeration | Priority for the route and its orders.
Possible values: 0 (Urgente), 1 (Alta), 2 (Normal), 3 (Baja), 4 (Muy baja). |
| | Document | No | string(65) | Route document name. |
| | CommodityType | No | string(65) | Commodity type. |
| | Driver | No | Group | Driver data of the route. |
| | | AgencyCode | No | string(50) | Agency code associated to this route.
Code has to exist in the system, or an error will be notified. |
| | | DriverName | No | string(65) | Driver name. |
| | | TruckPlate | No | string(50) | Truck license plate. |
| | | TrailerPlate | No | string(50) | Trailer license plate. |
| | Planning | No | Group | Planning data of the route. |
| | | EstimatedLoadDate | No | DateTime | Estimated load date and time.
UTC date-time format. |
| | | EstimatedDeliveryDate | No | DateTime | Estimated delivery date and time.
UTC date-time format. |
| | | AutoReleaseDate | No | DateTime | Automatic release date and time. When set, route will be auto-released in EasyWMS. Route auto-release date takes priority over shipping order auto-release date .
UTC date-time format. |
| | | ExpectedDockStationCode | No | string(50) | Expected load dock code.
The dock has to exist in the system or an error will be notified. |
| | | AssignedDockStationCode | No | string(50) | Assigned load dock code.
The dock has to exist in the system or an error will be notified. |
| | TransactionalSorList | No | bool | Indicator of transactionality for the sor list. If it is true, the whole list must be treated as an atomic transaction.
If it is false, each element must be individually transactioned. |
| | CompleteSorList | No | bool | Indicator of completeness for the sor list. In case it is true, the whole list must be treated as the only sors allowed for the route.
If it is false, more sors appart from those in the list can exist for this route. |
| | SorList | No | List | List of outbound orders for this route. |
| | | Operation | No | Enumeration | Operation to perform with the shipping order data. Operation 2 (Delete) doesn’t delete the order; it just removes it from the route.
An error might raise if the operation is not allowed for the order’s status.
Possible values: 0 (Create), 1 (Update), 2 (Delete), 3 (Upsert). If it’s not included, it will take the value 3 (Upsert) by default. |
| | | **Code** | **Yes** | string(50) | Outbound order code.
When a non-existing value is included and a creation operation 0 (Crear) is performed, the order will be created.
If the code already exists in the system, it will include the order into the route. |
| | | OutboundType | No | Enumeration | The outbound order’s type. It is mandatory when creating a new outbound order.
Possible values: 0 (Customer), 1 (Return), 2 (Transfer), 4 (DirectTransfer). |
| | | AccountCode | No | string(50) | The account code for when the order type is Customer. associated to this outbound order.
Code has to exist in Easy WMS, or an error will be notified.
It cannot be null or empty when the type of the order is Customer. |
| | | OutboundClassCode | No | string(50) | Outbound class code. It will only be taken into account when the order type is Customer.
The code has to be an existing shipping class code which can be received from ERP or an error will be notified. |
| | | SupplierCode | No | string(50) | Supplier code for when the order type is Return.
Code has to exist in the system, or an error will be notified. Only used when shipping order type is Return. |
| | | WarehouseToCode | No | string(50) | Warehouse code where the stock will be transfered when the order type is Transfer or DirectTransfer.
The site has to exist in the system, or an error will be notified. Only used when shipping order type is Transfer or DirectTransfer. |
| | | Document | No | string(65) | Name of the delivery note file for the outbound order. |
| | | Source | No | string(65) | Free text to describe the outbound order’s origin. |
| | | Description | No | string(1000) | Outbound order’s description. |
| | | DeliveryInstructions | No | string(1000) | Outbound order’s delivery instructions. |
| | | ValidDate | No | DateTime | The date after which the order is considered outdated.
UTC date-time format. |
| | | ShipExpiredStock | No | bool | If it is true (1) it will be assigned to all the lines of the order only expired stock. Otherwise the order ships unexpired stock.
It takes the value false (0) by default. |
| | | FollowSequence | No | bool | If it’s true (1) the sequence indicated by the outbound order lines will be followed. False (0) otherwhise.
It takes the value 0 (false) by default. |
| | | StopNumber | No | long | Stop number where outbound order will be delivered.
Positive number greater than zero. |
| | | EstimatedNumCont | No | long | Estimated number of containers that will be shipped in the order.
Positive number greater than zero. |
| | | PlannedLoadDate | No | DateTime | Expected load date.
UTC date-time format. |
| | | PlannedShippingDate | No | DateTime | Estimated shipping date.
UTC date-time format. |
| | | PackingLocationCode | No | string(50) | Packing location code.
Packing location has to exist in the system, or an error will be notified. |
| | | ClientContainerTypeCode | No | string(50) | Expected client container types.
It must match an existing container type, or an error will be notified. |
| | | ClientContainerNumLabels | No | long | Needed number of labels for the client containers.
Positive number greater than 0. |
| | | ShipReportNumCopies | No | long | Number of copies to print of outbound order report.
Positive number greater than 0. |
| | | PackingListNumCopies | No | long | Number of copies to print of packing list.
Positive number greater than 0. |
| | | TransactionalLineList | No | bool | Indicator of transactionality for the line list. If it is true, the whole list must be treated as an atomic transaction.
If it is false, each element must be individually transactioned. |
| | | CompleteLineList | No | bool | Indicator of completeness for the line list. In case it is true, the whole list must be treated as the only lines allowed for the inbound order.
If it is false, more lines appart from those in the list can exist for this inbound order. |
| | | LineList | No | List | List of lines for this outbound order. |
| | | | Operation | No | Enumeration | Operation to be performed with the data of each line. An error may be reported if the operation is not allowed for the shipping order status. Operation 2 (Delete) will involve a deletion when the shipping order is in creation or a cancellation of the line when the shipping order is released. Possible values: 0 (Create), 1 (Update), 2 (Delete), 3 (Upsert). |
| | | | **LineNumber** | **Yes** | long | Line number. It must be unique in shipping order and greater than 0. Otherwise, an error will be reported. It is the line’s unique key identifier for operations 1 (Update), 2 (Delete) and 3 (Upsert). |
| | | | MaxLots | No | long | Maximum number of lots that can be shipped if the product has a lot in its logistics profile. Positive number greater than 0. |
| | | | ProductCode | No | string(50) | Code of the ordered item. If a container is also indicated, it indicates where the item is wanted. You must reference an existing item code in the system. Otherwise, an error will be reported. It is mandatory if ContainerCode does not exist. |
| | | | OwnerCode | No | string(50) | Owner of the ordered item. It is not necessary when what is being ordered is a container. In case of not indicating owner when an item is being ordered, it is considered: a) If there is only one owner for the indicated item, it will be this.b) If there are several owners for the indicated item and one is marked as default, it will be this.c) Otherwise an error will occur. You must reference an existing owner code in the system, otherwise an error will be reported. Owner of the ordered item. This is required only when a value is entered in ProductCode. |
| | | | ContainerCode | No | string(50) | Free text that references the code of the ordered container if a specific one is required. If an item is also requested, indicate which container you want that item from. It is mandatory if there is no ProductCode. |
| | | | Comment | No | string(1000) | Comment for the shipping order line. |
| | | | Quantity | No | Group | Data about the quantity of the line of the shipping order. It contains the data needed to define the quantity of a line of the shipping order from the ERP. |
| | | | | QuantityOrdered | No | decimal | Quantity to ship, in the specified UoM. Positive number greater than 0 |
| | | | | UnitOfMeasureCode | No | string(50) | Unit of Measure of the line quantity. Has to be an existing UoM into Easy WMS, or an error will be notified. |
| | | | | RequiredUnitOfMeasure | No | bool | When 1 (true), the stock has to be shipped in the specified UoM When 0 (false), the stock quantity could be shipped in a different UoM Default value is 0 (false) |
| | | | | QuantityToReserve | No | decimal | Quantity to be reserved before shipping in the specified UoM. Positive number greater than 0. |
| | | | | QuantityRejected | No | decimal | ejected to be shipped quantity in the specified UoM. Positive number greater than 0. |
| | | | | AllowAssignStockExcess | No | bool | When 1 (true) it is allowed to ship over quantity, when 0 (false) it is not.Default value is 0 (false). |
| | | | Terms | No | Group | Data about the terms of the shipping order line. It contains the data necessary to define the terms of a line of the shipping order from the ERP. |
| | | | | FavouriteContainerTypeCode | No | string(50) | Preferred container type when shipping containers.Only used when no value set in ContainerCode. Has to be an existing container type into EasyWMS, or an error will be notified. |
| | | | | FavouriteUnitOfMeasureCode | No | string(50) | Preferred UoM (Unit of Measure) to ship the stock.It must be equal to that specified in UnitOfMeasureCode or to break it. Has to be an existing UoM into Easy WMS, or an error will be notified. |
| | | | | CatchWeight | No | bool | Indicates that the weight of the stock must be recorded in shipment 1 (true), 0 (false) otherwise. |
| | | | | RequiredToShip | No | bool | When 1 (true), this line is mandatory to ship the whole order. When not introduced, default value is 0 (false). |
| | | | | IsCritical | No | bool | When 1 (true), the line must be served complete. If it cannot be served complete, none of the line is served. When not introduced, default value is 0 (false). |
| | | | | UseAlternativeProducts | No | bool | |
| | | | | Status | No | Group | Data about the stock status required by the line of the shipping order. It contains the necessary data to define the required stock status of a line of the output order from the ERP. |
| | | | | | FavouriteStockStatusCode | No | string(50) | Preferred stock status for this line. Has to be an existing status code into EasyWMS, or an error will be notified. Only used when LneTrmStaReq is not set. |
| | | | | | RequireStockStatusCode | No | string(50) | Mandatory stock status for this line. Has to be an existing status code into EasyWMS, or an error will be notified. |
| | | | | | RejectStockStatusCode | No | string(50) | Not allowed stock status for this line. Has to be an existing status code into EasyWMS, or an error will be notified. |
| | | | | ContainerTypeCode | No | string | Type of container required to ship. It must reference an existing container type on the system, otherwise the error will be reported. |
| | | | Customer | No | Group | Data about the line of the shipping order of the customer ERP. It contains the necessary data to indicate the customer ERP information of the shipping order line. |
| | | | | ProductCode | No | string(65) | Open text to specify the stock customer code. |
| | | | | LineNo | No | long | Open text to specify the customer stock line number. |
| | | | AltProduct | No | Group | Data about the alternative product the line of the shipping order. It contains the necessary data to define the alternative product of a line of the shipping order from the ERP. |
| | | | | ProductCode | No | string(50) | Alternative item code. Has to be an existing item code, owned by the same owner into Easy WMS, or an error will be notified. |
| | | | | FromFactor | No | decimal | Units of the original item that are replaced with the quantity specified in ToFactor specified in the item base UoM. Positive number greater than 0. |
| | | | | ToFactor | No | decimal | Units of the substitutive item that replace the quantity specified in FromFactor. Positive number greater than 0. |
| | | | | UnitOfMeasureCodeTo | No | string(50) | UoM used to describe the quantity specified in ToFactor. Has to be an existing UoM into Easy WMS, or an error will be notified. |
| | | | PurchasePrice | No | Group | Data about the price of the product line of the shipping order. It contains the necessary data to define the price of the product of a line of the shipping order from the ERP. |
| | | | | **Quantity** | **Yes** | decimal | Informative field with the line total price. Positive number greater than 0. |
| | | | | **Currency** | **Yes** | string(65) | Currency related to LneCstPurchase. Only when Quantity is set. |
| | | | LogisticAttributes | No | Group | Data about the line logistic attributes of the shipping order. It contains the necessary data to define the logistic attributes of a line of the shipping order from the ERP. |
| | | | | LotCode | No | string(65) | Mandatory LOT to be shipped. |
| | | | | SerialNumber | No | string(65) | Mandatory serial number to be shipped. |
| | | | | ProductionDate | No | DateTime | Earlier production date to be shipped. UTC date-time format |
| | | | | ExpirationDate | No | DateTime | Earlier expiration date to be shipped. UTC date-time format. |
| | | | | BestBeforeDate | No | DateTime | Earlier best before date to be shipped. UTC date-time format. |
| | | | | DaysOfLife | No | long | Lower shelf life to be shipped. Positive number greater than 0. |
| | | | | Quality | No | string(65) | Mandatory quality to be shipped. |
| | | | | Color | No | string(65) | Mandatory color to be shipped. |
| | | | | Source | No | string(65) | Mandatory origin to be shipped. |
| | | | | Version | No | string(65) | Mandatory version to be shipped. It is mandatory in case of requesting a non assembled kit item, and must correspond with an enabled version of the kit. |
| | | | | ProductionMethod | No | string(65) | Mandatory production method to be shipped. |
| | | | | PostProductionTreatment | No | string(65) | Mandatory post-production treatment to be shipped. |
| | | | | Size | No | string(65) | Mandatory size to be shipped. |
| | | | | Weight | No | decimal | Mandatory weight to be shipped. Decimal number greater than 0. |
| | | | CustomAttribute | No | Group | Data about the custom line attributes of the shipping order. It contains the data needed to define the custom attributes of a line of the shipping order from the ERP. |
| | | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | | | Transport | No | Group | Data about the line transport of the shipping order. It contains the data necessary to define the transport of a line of the shipping order from the ERP. |
| | | | | AgencyCode | No | string(50) | Agency to make the shipment. Agency code must exists in the WMS. Otherwise the WMS will return an error. |
| | | | | TransportType | No | string(65) | Transport type to make the shipment. |
| | | CustomAttribute | No | Group | Custom attributes for the outbound order |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | | OwnerCode | No | string | Outbound owner code. |
| | CustomAttribute | No | Group | Custom attributes for the route. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
##### Work Orders - WOR
**Message type**: WOR (Work Order received)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.WorkOrderErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: With this message we can get the information about the work orders received to prepare. - Work Orders will be created and their status will be _Waiting_. - When we receive the information to cancel one work order, we only need the fields marked in red. - It´s not allowed to modify the Site for an existing work order. - Work orders received from the ERP will be created with the _ReceivedFromERP_ field to _true_. - From the ERP, we can only change de work orders created in the ERP. - If the work order is a _Kitting_ or _Dekitting_ order, the fields _ItemCode_, _KitItemVersion_ and _OwnerCode_ will be requeired. - The _OBL_ column defines the obligation for the field to be informed. If the field is not informed and it is an update, we must pay attention to the value of the _ignorenull_ tag.
**Structure**:
**WOR**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | WOR mandatory boolean attribute. When true (1) null or not existing data fields keep its original value; when false (0) data fields are set to void. |
| **Operation** | **Yes** | Enumeration | Operation to perform with the work order data. An error may be reported if the operation is not allowed for the state of the order.
Operation 2: Delete will involve cancellation in all cases, except when already we have quantity mounted / disassembled that it will be a close.
Allowed values: 0: Create, 1: Update, 2: Delete, 3: UPSERT. |
| **Code** | **Yes** | string(50) | Work order.
If we try to create an order with 0: Create or 3: UPSERT, the order will be created successfully. If the operations is 1: Update or 2: Delete, the system will throw an error message. |
| **Site** | **Yes** | string(50) | Site.
The site should exists in the system and it is not possible to modify it. |
| Data | No | Group | Data about the work order. It contains all necessary data to define an work order from the ERP. |
| | **Priority** | **Yes** | Enumeration | Order priority.
Possible values: Urgent, High, Normal, Low, VeryLow. |
| | **WorkOrderType** | **Yes** | Enumeration | Work order type.
If the order is Kitting or Dekitting type, the ItemCode field, KitItemVersion field and OwnerCode field are required. |
| | WorkLocationCode | No | string(50) | Work location code.
If the work location received does not exist, or is not a valid work zone, the system throws an error message. |
| | ItemCode | No | string(50) | Item Code.
It must reference an existing item code, otherwise you will be notified of an error. |
| | OwnerCode | No | string(50) | Owner.
It must reference an existing provider code in the system, otherwise you will be notified of error. |
| | KitItemVersion | No | string(50) | Kit version.
It must reference an existing version in the system for the requested kit. |
| | **Quantity** | **Yes** | long | Ordered quantity.
Natural number greater than 0. |
| | Description | No | string(1000) | Description. |
| | CustomAttribute | No | Group | Custom attributes for the work order. |
| | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
#### Exported messages
Messages that will be sent in Export direction (from MAP to the ERP).
##### Shipping order status change - SOC
**Message type**: SOC (Shipping order status change)
**Import / Export**: Export
**Version**: 01
**Description**: With this message, Easy WMS notifies any status change of an existing shipping order.
- Shipping orders that has been grouped o merged, once grouped or merged, don’t changes of status, so changes in the status of their preparation (_Released, Working, Paused_) shouldn’t be expected like for orders non grouped or merged.
**Structure**:
**SOC01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Warehouse code of the shipping order |
| **SorCode** | **Yes** | string(50) | Shipping order code |
| **Status** | **Yes** | string | Current status of the shipping order. Possible values: Secured, Waiting, Assigned, Release, Working, Paused, StockFailure, Merged, Grouped |
| **UpdateDate** | **Yes** | DateTime | UTC date and time of the status change of the shipping order |
##### Shipping order close or finalization - SOF
For the shipping order close or finalization message there are two versions: [SOF01](communications/EasyWMS_WebApi_en.html.md#SOF01) y [SOF02](communications/EasyWMS_WebApi_en.html.md#SOF02)
###### Shipping order close or finalization - SOF01
**Message type**: SOF (Shipping order close or finalization)
**Import / Export**: Export
**Version**: 01
**Description**: With this message, Easy WMS notifies the stock shipped related to an existing shipping order in the system, because the order has been closed or finished.
- When the shipping order has been created by a RUT message received from ERP, route code will be part of the finalization SOF data.
- When partial closing is used, each closing will generate a SOF message containing the closing number and only the shipping order lines closed.
- When the close of an outbound order is forced but it didn’t ship any stock, no order lines will be sent.
- When cancelling shipping orders, no order lines will be sent in the SOF message (all pending lines will be cancelled).
**Structure**:
**SOF01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site where the shipping is done |
| **SorCode** | **Yes** | string(50) | Shipping order code |
| **Status** | **Yes** | string | Status in which the order has been closed or finalized. Finalization statuses are Cancelled and Closed. Possible values: Waiting, Release, Working, Paused, StockFailure, Cancelled, Closed, Secured |
| ClosingNum | No | long | Closing number. Positive integer greater than 0. It will be mandatory when what has occurred is a closing |
| Document | No | string(65) | Delivery note |
| Source | No | string(65) | Open text to describe the shipping |
| ShipExpiredStock | No | bool | Order requires expired stock or not |
| Transport | No | Transport | Transport data of the shipping order |
| **Preparation** | **Yes** | Group | Preparation data of the shipping order |
| | PrpReleaseDate | No | DateTime | Shipping order release date and time. UTC date-time format |
| | **PrpContainers** | **Yes** | long | LPNs shipped into the shipping order. Positive integer greater than or equal to 0 |
| | PrpContType | No | string(50) | Type of expected client containers indicated on the shipping order |
| | PrpDock | No | string(50) | Dock assigned for order loading |
| | PrpShippingDate | No | DateTime | Estimated shipping date. UTC date-time format |
| Delivery | No | Group | Delivery data of the shipping order |
| | DlvTrackingNumber | No | string(1000) | Tracking number of the delivery |
| | DlvCarrierCode | No | string(50) | Carrier for current delivery |
| Lines | No | Group | Shipping order lines |
| | **Line** | **Yes** | List | Shipping order line |
| | | **LneNumber** | **Yes** | long | Line number. Unique number in the message |
| | | LneItemCode | No | string(50) | Ordered stock item code for this line. Mandatory when LneContCode has no value |
| | | LneContCode | No | string(50) | Requested container code. This field will contain value when LneItemCode does not have one |
| | | LneOwnerCode | No | string(50) | Owner for this ordered stock line |
| | | LneComment | No | string(1000) | Comment for the stock line |
| | | LneQuantity | No | Group | Defines the quantity of the line. Only to be used when LneItemCode has a value |
| | | | **LneQtyOrder** | **Yes** | decimal | Ordered quantity of the item, in the indicated UoM. Positive number greater than 0 |
| | | | LneQtyFree | No | decimal | Quantity of the item shipped free of charge, in the indicated UoM. Positive number greater than 0 |
| | | | **LneQtyUoMCode** | **Yes** | string(50) | Unit of measure in which line quantities are referenced |
| | | LneCustomerData | No | Group | Line customer data |
| | | | LneCtmCode | No | string(65) | Open text to specify the stock customer code |
| | | | LneCtmLineNumber | No | long | Número de línea de pedido correspondiente para el cliente |
| | | LneCost | No | Group | Cost data of line items |
| | | | LneCstPurchase | No | decimal | Information field with the total cost of the line. Positive number greater than zero |
| | | | LneCstCurrency | No | string(65) | Currency in which the cost is indicated. It will only be filled in if LneCstPurchase has value |
| | | LneAttributes | No | LneAttributesOut | Logistic attributes required by the line |
| | | LneCustomAttributes | No | LneCustomAttributes | Custom attributes of the line |
| | | LneDetails | No | Group | Datos de los stocks expedidos. Sólamente se utilizará cuando LneContCode no tenga valor |
| | | | LneDetail | No | List | Shipped stock data |
| | | | | LneDItemCode | No | string(50) | Shipped stock item code for this line |
| | | | | LneDOwnerCode | No | string(50) | Shipped stock owner for this line |
| | | | | **LneDIsAlternative** | **Yes** | bool | Indicates whether the item shipped for the line is an alternative item (true, 1) or the ordered item (false, 0). |
| | | | | LneDWeight | No | decimal | Stock weight recorded when shipping. Positive number greater than 0 |
| | | | | LneDClientContCode | No | string(50) | LPN (license plate number) for the shipped stock line |
| | | | | LneDQuantity | No | Group | Shipped quantity data |
| | | | | | **LneDQtyShipped** | **Yes** | decimal | Shipped quantity (in the specified UoM). Positive number greater than 0 |
| | | | | | **LneDQtyUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the line quantity shipped |
| | | | | LneDAttributes | No | Group | Logistic attribute shipped |
| | | | | | LneDAttLot | No | string(128) | Lot logistic attribute shipped |
| | | | | | LneDAttSN | No | string(128) | Serial number logistic attribute shipped |
| | | | | | LneDAttProdDate | No | DateTime | Production date logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttExpDate | No | DateTime | Expiration date logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttBBDate | No | DateTime | Best before date logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttDaysLife | No | DateTime | Shelf life data logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttQuality | No | string(128) | Quality logistic attribute shipped |
| | | | | | LneDAttColor | No | string(128) | Color logistic attribute shipped |
| | | | | | LneDAttSource | No | string(128) | Origin logistic attribute shipped |
| | | | | | LneDAttVersion | No | string(128) | Version logistic attribute shipped |
| | | | | | LneDAttProdMethod | No | string(128) | Production method logistic attribute shipped |
| | | | | | LneDAttPostTreat | No | string(128) | Post-production treatment logistic attribute shipped |
| | | | | | LneDAttSize | No | string(128) | Size logistic attribute shipped |
| | | | | LneDCustomAttributes | No | Group | Custom attributes shipped |
| | | | | | LneDCstAtt01 | No | string(1000) | Custom attribute 1 |
| | | | | | LneDCstAtt02 | No | string(1000) | Custom attribute 2 |
| | | | | | LneDCstAtt03 | No | string(1000) | Custom attribute 3 |
| | | | | | LneDCstAtt04 | No | string(1000) | Custom attribute 4 |
| | | | | | LneDCstAtt05 | No | string(1000) | Custom attribute 5 |
| | | | | | LneDCstAtt06 | No | string(1000) | Custom attribute 6 |
| | | | | | LneDCstAtt07 | No | string(1000) | Custom attribute 7 |
| | | | | | LneDCstAtt08 | No | string(1000) | Custom attribute 8 |
| | | | | | LneDCstAtt09 | No | string(1000) | Custom attribute 9 |
| | | | | | LneDCstAtt10 | No | string(1000) | Custom attribute 10 |
| | | | | | LneDCstAtt11 | No | string(1000) | Custom attribute 11 |
| | | | | | LneDCstAtt12 | No | string(1000) | Custom attribute 12 |
| | | | | | LneDCstAtt13 | No | string(1000) | Custom attribute 13 |
| | | | | | LneDCstAtt14 | No | string(1000) | Custom attribute 14 |
| | | | | | LneDCstAtt15 | No | string(1000) | Custom attribute 15 |
| | | | | | LneDCstAtt16 | No | string(1000) | Custom attribute 16 |
| | | | | | LneDCstAtt17 | No | string(1000) | Custom attribute 17 |
| | | | | | LneDCstAtt18 | No | string(1000) | Custom attribute 18 |
| | | | | | LneDCstAtt19 | No | string(1000) | Custom attribute 19 |
| | | | | | LneDCstAtt20 | No | string(1000) | Custom attribute 20 |
| | | LneVASDetails | No | Group | List of VAS applied to the line |
| | | | LneVASDetail | No | List | Data of VAS applied to the line |
| | | | | **LneVASsTemplate** | **Yes** | string(50) | VAS template applied to the line |
| | | | | LneVASsPreparedQuantity | No | decimal | Quantity of the line to which the VAS template has been applied. It will only be filled in case the applied VAS template is on stock |
| | | | | LneVASsComment | No | string(1000) | Additional VAS comment applied to the line |
| CustomAttributes | No | CustomAttributes | Custom attributes of the shipping order |
###### Shipping order close or finalization - SOF02
**Message type**: SOF (Shipping order close or finalization)
**Import / Export**: Export
**Version**: 02
**Description**: With this message, Easy WMS notifies the stock shippied related to an existing shipping order in the system, because the order has been closed or finished.
- When the shipping order has been created by a RUT message received from ERP, route code will be part of the finalization SOF data.
- When partial closing is used, each closing will generate a SOF message containing the closing number and only the shipping order lines closed.
- When the close of an outbound order is forced but it didn’t ship any stock, no order lines will be sent.
- When cancelling shipping orders, no order lines will be sent in the SOF message (all pending lines will be cancelled).
**Structure**:
**SOF02**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site where the shipping is done |
| **SorCode** | **Yes** | string(50) | Shipping order code |
| **Status** | **Yes** | string | Status in which the order has been closed or finalized. Finalization statuses are Cancelled and Closed. Possible values: Waiting, Release, Working, Paused, StockFailure, Cancelled, Closed, Secured |
| **OutboundType** | **Yes** | string | The outbound order’s outbound type. Possible values: Customer, Return, Transfer, Manual, DirectTransfer, KitAssembly, Manufacturing, KitDisassembly, Replenishment, Desk |
| ClosingNum | No | long | Closing number. Positive integer greater than 0. It will be mandatory when what has occurred is a closing |
| Document | No | string(65) | Delivery note |
| Source | No | string(65) | Open text to describe the shipping |
| ShipExpiredStock | No | bool | Order requires expired stock or not |
| Transport | No | Transport | Transport data of the shipping order |
| **Preparation** | **Yes** | Group | Preparation data of the shipping order |
| | PrpReleaseDate | No | DateTime | Shipping order release date and time. UTC date-time format |
| | **PrpContainers** | **Yes** | long | LPNs shipped into the shipping order. Positive integer greater than or equal to 0 |
| | PrpContType | No | string(50) | Type of expected client containers indicated on the shipping order |
| | PrpDock | No | string(50) | Dock assigned for order loading |
| | PrpShippingDate | No | DateTime | Estimated shipping date. UTC date-time format |
| Lines | No | Group | Shipping order lines |
| | **Line** | **Yes** | List | Shipping order line |
| | | **LneNumber** | **Yes** | long | Line number. Unique number in the message |
| | | LneItemCode | No | string(50) | Ordered stock item code for this line. Mandatory when LneContCode has no value |
| | | LneContCode | No | string(50) | Requested container code. This field will contain value when LneItemCode does not have one |
| | | LneOwnerCode | No | string(50) | Owner for this ordered stock line |
| | | LneComment | No | string(1000) | Comment for the stock line |
| | | LneQuantity | No | Group | Defines the quantity of the line. Only to be used when LneItemCode has a value |
| | | | **LneQtyOrder** | **Yes** | decimal | Ordered quantity of the item, in the indicated UoM. Positive number greater than 0 |
| | | | LneQtyFree | No | decimal | Quantity of the item shipped free of charge, in the indicated UoM. Positive number greater than 0 |
| | | | **LneQtyUoMCode** | **Yes** | string(50) | Unit of measure in which line quantities are referenced |
| | | LneCustomerData | No | Group | Line customer data |
| | | | LneCtmCode | No | string(65) | Open text to specify the stock customer code |
| | | | LneCtmLineNumber | No | long | Número de línea de pedido correspondiente para el cliente |
| | | LneCost | No | Group | Cost data of line items |
| | | | LneCstPurchase | No | decimal | Information field with the total cost of the line. Positive number greater than zero |
| | | | LneCstCurrency | No | string(65) | Currency in which the cost is indicated. It will only be filled in if LneCstPurchase has value |
| | | LneAttributes | No | LneAttributesOut | Logistic attributes required by the line |
| | | LneCustomAttributes | No | LneCustomAttributes | Custom attributes of the line |
| | | LneDetails | No | Group | Datos de los stocks expedidos. Sólamente se utilizará cuando LneContCode no tenga valor |
| | | | LneDetail | No | List | Shipped stock data |
| | | | | LneDItemCode | No | string(50) | Shipped stock item code for this line |
| | | | | LneDOwnerCode | No | string(50) | Shipped stock owner for this line |
| | | | | **LneDIsAlternative** | **Yes** | bool | Indicates whether the item shipped for the line is an alternative item (true, 1) or the ordered item (false, 0). |
| | | | | LneDWeight | No | decimal | Stock weight recorded when shipping. Positive number greater than 0 |
| | | | | LneDClientContCode | No | string(50) | LPN (license plate number) for the shipped stock line |
| | | | | LneDQuantity | No | Group | Shipped quantity data |
| | | | | | **LneDQtyShipped** | **Yes** | decimal | Shipped quantity (in the specified UoM). Positive number greater than 0 |
| | | | | | **LneDQtyUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the line quantity shipped |
| | | | | LneDAttributes | No | Group | Logistic attribute shipped |
| | | | | | LneDAttLot | No | string(128) | Lot logistic attribute shipped |
| | | | | | LneDAttSN | No | string(128) | Serial number logistic attribute shipped |
| | | | | | LneDAttProdDate | No | DateTime | Production date logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttExpDate | No | DateTime | Expiration date logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttBBDate | No | DateTime | Best before date logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttDaysLife | No | DateTime | Shelf life data logistic attribute shipped. UTC date-time format |
| | | | | | LneDAttQuality | No | string(128) | Quality logistic attribute shipped |
| | | | | | LneDAttColor | No | string(128) | Color logistic attribute shipped |
| | | | | | LneDAttSource | No | string(128) | Origin logistic attribute shipped |
| | | | | | LneDAttVersion | No | string(128) | Version logistic attribute shipped |
| | | | | | LneDAttProdMethod | No | string(128) | Production method logistic attribute shipped |
| | | | | | LneDAttPostTreat | No | string(128) | Post-production treatment logistic attribute shipped |
| | | | | | LneDAttSize | No | string(128) | Size logistic attribute shipped |
| | | | | LneDCustomAttributes | No | Group | Custom attributes shipped |
| | | | | | LneDCstAtt01 | No | string(1000) | Custom attribute 1 |
| | | | | | LneDCstAtt02 | No | string(1000) | Custom attribute 2 |
| | | | | | LneDCstAtt03 | No | string(1000) | Custom attribute 3 |
| | | | | | LneDCstAtt04 | No | string(1000) | Custom attribute 4 |
| | | | | | LneDCstAtt05 | No | string(1000) | Custom attribute 5 |
| | | | | | LneDCstAtt06 | No | string(1000) | Custom attribute 6 |
| | | | | | LneDCstAtt07 | No | string(1000) | Custom attribute 7 |
| | | | | | LneDCstAtt08 | No | string(1000) | Custom attribute 8 |
| | | | | | LneDCstAtt09 | No | string(1000) | Custom attribute 9 |
| | | | | | LneDCstAtt10 | No | string(1000) | Custom attribute 10 |
| | | | | | LneDCstAtt11 | No | string(1000) | Custom attribute 11 |
| | | | | | LneDCstAtt12 | No | string(1000) | Custom attribute 12 |
| | | | | | LneDCstAtt13 | No | string(1000) | Custom attribute 13 |
| | | | | | LneDCstAtt14 | No | string(1000) | Custom attribute 14 |
| | | | | | LneDCstAtt15 | No | string(1000) | Custom attribute 15 |
| | | | | | LneDCstAtt16 | No | string(1000) | Custom attribute 16 |
| | | | | | LneDCstAtt17 | No | string(1000) | Custom attribute 17 |
| | | | | | LneDCstAtt18 | No | string(1000) | Custom attribute 18 |
| | | | | | LneDCstAtt19 | No | string(1000) | Custom attribute 19 |
| | | | | | LneDCstAtt20 | No | string(1000) | Custom attribute 20 |
| | | | | LneDUserDefinedStatus | No | string(50) | User defined stock status |
| | | | | LneDReceptionDefaultStatus | No | string(50) | Receipt status defined during receipt of stock |
| CustomAttributes | No | CustomAttributes | Custom attributes of the shipping order |
##### Truck loads finalization - LOF
**Message type**: LOF (Truckload finalization)
**Import / Export**: Export
**Version**: 01
**Description**: With this message, Easy WMS notifies the finalization of a truck load, specifying included shipping orders and LPNs. - Only correctly loaded trucks will be notified. _Cancelled_ loads will not be notified because stock will not leave the warehouse site.
**Structure**:
**LOF01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site where the load is done |
| **LoadCode** | **Yes** | string(50) | Load code |
| **LoadDate** | **Yes** | DateTime | Date and time of the load. UTC date-time format |
| RouteCode | No | string(50) | Route that contains the load. Only used when the route was created from a RUT ERP message |
| Dock | No | string(50) | Shipping dock from where the truck was loaded |
| Weight | No | decimal | Weight of the load. Positive number greater than 0 |
| Description | No | string(65) | Load description |
| Comments | No | string(1000) | Load open text comment |
| CommodityType | No | string(1000) | Commodity type |
| Driver | No | Driver | Data about the driver. It contains the necessary data to define the driver from the ERP |
| Bill | No | Group | Data about the bill. It contains the necessary data to define the bill from the ERP |
| | BllName | No | string(1000) | Bill name |
| | BllAddress | No | string(1000) | Bill address |
| | BllZipCode | No | string(50) | Bill address ZIP code |
| | BllCity | No | string(65) | Bill address city |
| | BllState | No | string(65) | Bill state |
| | BllCountry | No | string(65) | Bill address country |
| Containers | No | Group | Data about the containers. It contains the necessary data to define the containers from the ERP |
| | Container | No | List | Data about the container. It contains the necessary data to define the container from the ERP |
| | | CntCode | No | string(50) | Stock LPN (license plate number) sent |
| | | CntType | No | string(50) | Stock container type |
| | | CntSorCode | No | string(50) | Stock shipping order code |
| | | IsSlave | No | bool | If true (value 1) the container is a slave container: It has no stock but fisically exists. If empty, default value is false (value 0) |
| | | Lines | No | Group | Data about the lines of the shipping order. It contains the necessary data to define the lines of the shipping order from the ERP |
| | | | Line | No | List | Data about the line of the shipping order. It contains the necessary data to define the line of the shipping order from the ERP |
| | | | | SorCode | No | string(50) | Shipping order code |
| | | | | **LneNumber** | **Yes** | long | Line number in the shipping order |
| | | | | LneItemCode | No | string(50) | Stock item code |
| | | | | LneOwnerCode | No | string(50) | Stock owner |
| | | | | **LneIsAlternative** | **Yes** | bool | When true (1), an alternative item was sent. When false (0), requested items was sent |
| | | | | LneQtyShipped | No | decimal | Line stock quantity shipped. Positive number greater than 0 |
| | | | | LneQtyUoMCode | No | string(50) | UoM (Unit of Measure) of the line quantity |
| | | | | LneWeight | No | decimal | Weight of the stock of the line. Positive number greater than 0 |
| | | | | LneComment | No | string(1000) | Line open text comment |
| | | | | LneCustomerData | No | Group | Data about the customer. It contains the necessary data to define the customer data from the ERP |
| | | | | | LneCtmCode | No | string(65) | Informative open text customer stock code |
| | | | | | LneCtmLineNumber | No | long | Informative customer order number |
| | | | | LneAttributes | No | LneAttributesOut | Data about the line attributes. It contains the necessary data to define the line attributes from the ERP |
| | | | | LneCustomAttributes | No | LneCustomAttributes | Data about the line custom attributes. It contains the necessary data to define the custom attributes of the line from the ERP |
| | | Containers | No | Group | Data about the containers. It contains the necessary data to define the containers from the ERP |
| Stocks | No | Group | Data about the stock. It contains the necessary data to define the stock from the ERP |
| | Line | No | List | Data about the line of the shipping order. It contains the necessary data to define the line of the shipping order from the ERP |
| | | SorCode | No | string(50) | Shipping order code |
| | | **LneNumber** | **Yes** | long | Line number in the shipping order |
| | | LneItemCode | No | string(50) | Stock item code |
| | | LneOwnerCode | No | string(50) | Stock owner |
| | | **LneIsAlternative** | **Yes** | bool | When true (1), an alternative item was sent. When false (0), requested items was sent |
| | | LneQtyShipped | No | decimal | Line stock quantity shipped. Positive number greater than 0 |
| | | LneQtyUoMCode | No | string(50) | UoM (Unit of Measure) of the line quantity |
| | | LneWeight | No | decimal | Weight of the stock of the line. Positive number greater than 0 |
| | | LneComment | No | string(1000) | Line open text comment |
| | | LneCustomerData | No | Group | Data about the customer. It contains the necessary data to define the customer data from the ERP |
| | | | LneCtmCode | No | string(65) | Informative open text customer stock code |
| | | | LneCtmLineNumber | No | long | Informative customer order number |
| | | LneAttributes | No | LneAttributesOut | Data about the line attributes. It contains the necessary data to define the line attributes from the ERP |
| | | LneCustomAttributes | No | LneCustomAttributes | Data about the line custom attributes. It contains the necessary data to define the custom attributes of the line from the ERP |
| CustomAttributes | No | CustomAttributes | Data about the custom attributes. It contains the necessary data to define the custom attributes from the ERP |
##### Work Order Finalization - WOF
**Message type**: WOF (Work order closed or finished)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used to notify the ERP of changes in the stock caused by a work order, which has been closed or canceled.
- If we cancel a work order after any quantity has been processed, the status of the order will be closed status. If any quantity has been yet, the status will be cancelled.
- This message will be sent only in the work orders created by the ERP.
**Structure**:
**WOF01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Site |
| **WorCode** | **Yes** | string(50) | Work order |
| **Status** | **Yes** | string | Status in which the order has been closed or finished. The finishing status are Cancelled or Closed |
| **WorType** | **Yes** | string | Work order type. If the order is Kitting or Dekitting type, the ItemCode field, KitItemVersion field and OwnerCode field are requeired. With feature UseSameValuesForWorkTypeInWOR01AndWOF01Message enabled possible, values: KitAssembly, KitDisassembly, else Kitting, Dekitting, |
| **WorkLocationCode** | **Yes** | string(50) | Work zone location |
| ItemCode | No | string(50) | Item code |
| OwnerCode | No | string(50) | Owner code |
| KitItemVersion | No | string(50) | Kit version |
| **Quantity** | **Yes** | long | Ordered quantity |
| **QuantityProc** | **Yes** | long | Processed quantity. For the kits working orders, it will be the assembled quantity (Kitting) or disassembled (Dekitting) |
| **StockConsumed** | **Yes** | Group | Data about the stock consumed. It contains the necessary data to define the stock consumed from the ERP |
| | StockDetails | No | List | Data about the stock details. It contains the necessary data to define the stock details from the ERP |
| | | **ItemCode** | **Yes** | string(50) | Item code |
| | | **OwnerCode** | **Yes** | string(50) | Owner code in case that the type is return |
| | | **Quantity** | **Yes** | decimal | Consumed quantity |
| | | **QtyUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the quantity |
| | | **Location** | **Yes** | string(50) | Work location code |
| | | Container | No | string(50) | Container source code (only if it is known) |
| | | StockAttributes | No | StockAttributes | Data about the stock attributes. It contains the necessary data to define the stock attributes from the ERP |
| | | StockCustomAttributes | No | CustomAttributes | Data about the stock custom attributes. It contains the necessary data to define the stock custom attributes from the ERP |
| **StockCreated** | **Yes** | Group | Data about the stock created. It contains the necessary data to define the stock created from the ERP |
| | StockDetails | No | List | Data about the stock details. It contains the necessary data to define the stock details from the ERP |
| | | **ItemCode** | **Yes** | string(50) | Item code |
| | | **OwnerCode** | **Yes** | string(50) | Owner code in case that the type is return |
| | | **Quantity** | **Yes** | decimal | Consumed quantity |
| | | **QtyUoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the quantity |
| | | **Location** | **Yes** | string(50) | Work location code |
| | | Container | No | string(50) | Container source code (only if it is known) |
| | | StockAttributes | No | StockAttributes | Data about the stock attributes. It contains the necessary data to define the stock attributes from the ERP |
| | | StockCustomAttributes | No | CustomAttributes | Data about the stock custom attributes. It contains the necessary data to define the stock custom attributes from the ERP |
| CustomAttributes | No | CustomAttributes | Data about the custom attributes. It contains the necessary data to define the custom attributes from the ERP |
### Request and notifications
#### Imported messages
Messages that will be received in Import direction (from the ERP to MAP).
##### Stock status change request - STR
**Message type**: STR (Stock status change request)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.StockStatusChangeRequestERPCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message type allows to change specific stock status
- As a response to this request, when stock status is set or removed, a STC (stock status change) message will be sent to notify the change done
- Only _upsert_ or delete operations are permitted (2 (Delete), 3 (Upsert))
- When _upserting_, the user stock status is always set, even if deleting previous user stock status is required
- When deleting, user status and/or reception status can be deleted
**Structure**:
**STR**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Operation** | **Yes** | Enumeration | Operation to perform with the status. UPSERT (3: UPSERT) will be about the user status. The delete (2: Delete) will perform about the user status and/or receipt status.0: Create, 1: Update, 2: Delete, 3: UPSERT |
| **Site** | **Yes** | string(50) | Code of the warehouse site. Has to be an existing site, and It is not allowed to modify it |
| **ItemCode** | **Yes** | string(50) | Item code. Has to be an existing item code, or an error will be notified |
| OwnerCode | No | string(50) | Item owner code.
When not set:
\- If only one owner exists into the system, this
value will be set
\- If there is a default owner, this value will be
set
In any other way, an error is notified |
| FltContainerCode | No | string | Container code that contains the item stock (to filter) |
| FltLocationCode | No | string | Location code that contains the item stock (to filter) |
| FltLogisticAttributes | No | Group | Logistic attributes (to filter) |
| | BestBeforeDate | No | DateTime | Best before date. |
| | Colour | No | string(65) | Colour. |
| | DaysOfLife | No | DateTime | Date when the days of life of the stock will expire. |
| | ExpirationDate | No | DateTime | Expiration date. |
| | ProductionMethod | No | string(65) | Production method. |
| | ProductionDate | No | DateTime | Production date. |
| | PostProductionTreatment | No | string(65) | Post production treatment. |
| | Quality | No | string(65) | Quality. |
| | SerialNumber | No | string(65) | Serial number. |
| | Size | No | string(65) | Size. |
| | Source | No | string(65) | Source. |
| | Version | No | string(65) | Version. |
| | LotCode | No | string(65) | Lot code. |
| FltCustomAttribute | No | Group | Custom attributes (to filter) |
| | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| **StaCode** | **Yes** | string(50) | User status to be set. User or reception status to be deleted. Has to be an existing status code in Easy WMS, or an error will be notified. |
| StaUsrEnd | No | DateTime | User status end in date UTC date-time format. Only used when upserting (3: UPSERT) |
| StaUsrComment | No | string(1000) | User status optional comment. Only used when upserting (3: UPSERT) |
##### Stock count request - SCR
**Message type**: SCR (Stock count request)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.StockCountRequestErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message allows to request a stock count with the currently existing data in Easy WMS. Stock to count can be filtered. SCR messages are always responded with WSC01 (same version) messages. - SCR messages only request the counting, so no modifications are done to the stock data. - Specific stock to be counted can be filtered by using the groups _Filter_, _Items_ or _Containers_. - Stock status filters simultaneously by user status and reception status. - One data group at most (_Filter_, _Items_ or _Containers_) can be used to filter in each SCR message in order to avoid redundant stock counting. - It is possible to request a total count with no filter on it. In this case a WSC message with all the site stock will be responded. - When _MassiveCount_ is true, WSC message will group identical stock lines in different locations or LPN. Different status or different logistic attributes will not be grouped. - When _MassiveCount_ is false, WSC will contain a stock line for each stock line in the site.
**Structure**:
**SCR**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site. |
| **MassiveCount** | **Yes** | bool | When is true the identical stock lines in different locations will be grouped. If it is false the message returns every single stock line. |
| Batch | No | string(50) | Unique code used to group different messages in the same batch. |
| Filter | No | Group | Defines the filter by item categories. If this data group has value not _Items_ nor _Containers_ data groups are allowed. |
| | TypeCode | No | string(50) | Item type which stock will be counted. |
| | FamilyCode | No | string(50) | Item family which stock will be counted. |
| | OwnerCode | No | string(50) | Owner who owns the stock which will be counted. |
| Items | No | List | Defines the filter by an item or a list of items. If this data group has value not _Filter_ nor _Containers_ data groups are allowed. |
| | **ItemCode** | **Yes** | string(50) | Item which stock will be counted. |
| | OwnerCode | No | string(50) | Owner of the specific item to be counted.
When not set, default owner or unique owner is assumed.If there is more than one product and there is not default owner returns quantity zero. |
| | StatusCode | No | string(50) | User or reception status stock to be counted. |
| | Attributes | No | Group | The logistic attributes of the item to filter. |
| | | BestBeforeDate | No | DateTime | Best before date. |
| | | Colour | No | string(65) | Colour. |
| | | DaysOfLife | No | DateTime | Date when the days of life of the stock will expire. |
| | | ExpirationDate | No | DateTime | Expiration date. |
| | | ProductionMethod | No | string(65) | Production method. |
| | | ProductionDate | No | DateTime | Production date. |
| | | PostProductionTreatment | No | string(65) | Post production treatment. |
| | | Quality | No | string(65) | Quality. |
| | | SerialNumber | No | string(65) | Serial number. |
| | | Size | No | string(65) | Size. |
| | | Source | No | string(65) | Source. |
| | | Version | No | string(65) | Version. |
| | | LotCode | No | string(65) | Lot code. |
| Containers | No | List | Defines the filter by a container or a list of containers. If this data group has value not _Filter_ nor _Items_ data groups are allowed. |
| | **ContainerCode** | **Yes** | string(50) | Code of the container to be counted. |
##### Count order request - COR
**Message type**: COR (Count Order Request)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.CountOrderErpCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: This message is used to request the creation, update or deletion of a count order and its lines (it can indicate any of the characteristics allowed for a count order in Easy WMS)
- COR messages are always answered with COF messages with the same count code number. The main difference between the SCR message and the COR message is that the COR message corresponds to the COF message, which merely contains the stock of the counted locations (as indicated in COR). The WSC, as a result of the SCR message, responds to all the stock in the warehouse.
- It allows to modify the count code, the description and the priorities; as well as any data on its lines (as well as delete them), as long as they have not been released.
- Once the count has been released, any new lines in the count will be auto-released, unlike orders created directly in Easy WMS.
- Count lines that are added when the count has already been released will be released automatically. This behavior is exclusive for count lines created through this message.
- The message contains the _ignoreNull_ parameter that allows specifying the treatment for non-mandatory empty labels. If the parameter is set to _true_ it will ignore all empty fields and it will create the order/line (except for parameters that are of type date). When the parameter is set to _false_, and there are empty non-mandatory fields, it will not create/update anything included in the message and will return an error.
- The message contains the _transactional_ parameter that defines the behavior on an error in a line. When set to _true_, and there is an error on one line, it will not process any of the lines (even if the rest contain no errors). If the parameter is set to _false_, only errored lines will be ignored, and well-defined lines will be processed.
- The message contains the _complete_ parameter, which defines the behavior on order updates. If the parameter is set to _true_ it will update the command with everything contained in the message, removing any previously created lines. If the parameter is set to _false_, it will honor what already exists in the command and only update/create/delete what is set in the new message.
**Structure**:
**COR**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| IgnoreNulls | No | bool | Flag to ignore null values. If it is set to true, null values are not modified in the upsert and update operations. |
| **Operation** | **Yes** | Enumeration | Operation to be carried out with the count order.An error may be reported if the operation is not allowed for the order status.Operation D will result in a deletion when the order is being created or a cancellation when it is released. 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| **Code** | **Yes** | string(50) | Código de la orden de recuento |
| NewCode | No | string(50) | New count order code.It will only be used if you want to change(operations U, S) |
| **Site** | **Yes** | string(50) | Code of the system site where the stock is located.An existing site must be included in the system. |
| Data | No | Group | Data about the count order. It contains the necessary data to define a count order from the ERP. |
| | Description | No | string(1000) | Count order’s description |
| | **Priority** | **Yes** | Enumeration | Count order priority. Possible values: Urgent, High, Normal, Low, VeryLow |
| | CustomAttribute | No | Group | Data about the custom attributes.It contains the necessary data to define the custom attributes from the ERP |
| | | Attribute1 | No | string | |
| | | Attribute2 | No | string | |
| | | Attribute3 | No | string | |
| | | Attribute4 | No | string | |
| | | Attribute5 | No | string | |
| | | Attribute6 | No | string | |
| | | Attribute7 | No | string | |
| | | Attribute8 | No | string | |
| | | Attribute9 | No | string | |
| | | Attribute10 | No | string | |
| | | Attribute11 | No | string | |
| | | Attribute12 | No | string | |
| | | Attribute13 | No | string | |
| | | Attribute14 | No | string | |
| | | Attribute15 | No | string | |
| | | Attribute16 | No | string | |
| | | Attribute17 | No | string | |
| | | Attribute18 | No | string | |
| | | Attribute19 | No | string | |
| | | Attribute20 | No | string | |
| | LineList | No | List | Data about the lines of the count order.It contains the necessary data to define the lines of the count order from the ERP |
| | | Operation | No | Enumeration | Operation to be carried out with the line.An error may be reported if the operation is not allowed by the order status. Possible values: 0: Create, 1: Update, 2: Delete, 3: UPSERT |
| | | Item | No | Group | Data about the item. It containers the necessary data to define the item to count from the EPR |
| | | | **ProductCode** | **Yes** | string(50) | Code of the product to be counted.You must reference an existing item code in the system, otherwise the error will be reported. |
| | | | OwnerCode | No | string(50) | Owner’s code of the item to be counted.If no owner is indicated:a) If there is only one owner for the item indicated, it will be taken.b) If there are several owners for the indicated item and one is marked as the default, it will be this one.c) If there is no stock for the indicated owner, a zero quantity will be counted. You must reference an existing owner code in the system, otherwise the error will be reported. |
| | | | ProductCountAttErpData | No | Group | Data about the item line type custom attributes. It contains the necessary data to define the custom attributes of the line from the ERP |
| | | | | LotCode | No | string(65) | Lot logistic attribute.Filter the items with exact match.If it does not exist in the system, the count will be zero for this item. |
| | | | | SerialNumber | No | string(65) | Serial number logistic attribute. Filter the items with exact match. If it does not exist in the system, the count will be zero for this item |
| | | | | Quality | No | string(65) | Quality logistic attribute. Filter the items with exact match. If it does not exist in the system, the count will be zero for this item. |
| | | | | Color | No | string(65) | Color logistic attribute. Filter the items with exact match.If it does not exist in the system, the count will be zero for this item. |
| | | | | Source | No | string(65) | Source logistic attribute. Filter the items with exact match. If it does not exist in the system, the count will be zero for this item |
| | | | | Version | No | string(65) | Version logistic attribute. Filter the items with exact match. If it does not exist in the system, the count will be zero for this item. |
| | | | | ProductionMethod | No | string(65) | Production method logistic attribute. Filter the items with exact match. If it does not exist in the system, the count will be zero for this item. |
| | | | | PostTreatment | No | string(65) | Post-production method logistic attribute. Filter the items with exact match. If it does not exist in the system, the count will be zero for this item. |
| | | | | Size | No | string(65) | Size logistic attribute. Filter the items with exact match. If it does not exist in the system, the count will be zero for this item. |
| | | | | BestBeforeDateMin | No | DateTime | Logistic attribute date of days of life.Filters items with greater or equal days-of-life(and less than MaxAttDaysLife).In UTC time |
| | | | | BestBeforeDateMax | No | DateTime | Logistical attribute: best before date. Filters items with matching dates equal to or previous. Filters items with matching dates equal to or previous than this date (and less than MaxAttBBDate).In UTC time |
| | | | | ExpirationDateMin | No | DateTime | Logistic attribute expiration date. Filters items with date matches equal to or later than this date (and less than MaxAttExpDate). In UTC time |
| | | | | ExpirationDateMax | No | DateTime | Logistic attribute expiration date. Filters items with date matches equal to or previous than this date (and less than MaxAttExpDate). In UTC time |
| | | | | ProductionDateMin | No | DateTime | Manufacturing data logistic attribute. Filter the items with dates equal to or later than this date (and less than MaxAttProdDate). In UTC time |
| | | | | ProductionDateMax | No | DateTime | Manufacturing data logistic attribute. Filter the items with dates equal to or previous than this date (and less than MaxAttProdDate). In UTC time |
| | | | | DaysOfLifeDateMin | No | DateTime | Logistic attribute date of days of life. Filters items with later or equal days-of-life (and less than MaxAttDaysLife).In UTC time |
| | | | | DaysOfLifeDateMax | No | DateTime | Logistic attribute date of days of life. Filters items with previous or equal days-of-life (and less than MaxAttDaysLife). In UTC time |
| | | Container | No | Group | Data about the container. It containers the necessary data to define the container to count from the EPR |
| | | | **ContainerCode** | **Yes** | string(50) | Code of the container to be counted.If the container code refers to a customer container, no line/order must be created to count it and the container value will be returned to the ERP with all the loose stock recorded in it.If the container code does not exist in the system, a count will be returned to zero for that container |
| | | Location | No | Group | Data about the location. It containers the necessary data to define the location to count from the EPR |
| | | | PutawayZoneCode | No | string(50) | Warehouse area. You generate a bin count task for all existing bins within this zone. You must indicate an existing zone of the warehouse, otherwise an error will be indicated. |
| | | | AisleCode | No | string(50) | Warehouse aisle. It will generate a count task for each location that is linked to this aisle.You must indicate an existing aisle of the warehouse, otherwise an error will be indicated. |
| | | | LocationMaxCode | No | string(50) | Final location of range of locations. Generates a count task for each location in the range of locations set between the bin codes set by this parameter and LocationFrom. The value of this cell can be equal to the LocationFrom criterion, indicating that only one location on this line is counted at any one time. You must indicate a valid location code, otherwise an error will be indicated. |
| | | | LocationMinCode | No | string(50) | Initial location of range of locations. Generates a count task for each location in the range of locations set between the location codes set by this parameter and LocationTo. You must indicate a valid location code, otherwise an error will be indicated. |
| | | | XMax | No | long | X maximum. Within the selected zone, corridor or range of locations. This value sets the maximum X coordinate that the location must have in order to generate a count task. It must be greater than the MinimumX value. You must indicate a positive integer. If “MaximumX” and “MinimumX” have values, it must be less than “MaximumX”. |
| | | | XMin | No | long | X minimum.Within the selected zone, corridor or range of locations.This value sets the minimum X coordinate that the location must have to generate a count task.It must be less than the MaximumX value. You must indicate a positive integer. If “MaximumX” and “MinimumX” have values, it must be less than “MaximumX”. |
| | | | YMax | No | long | Y maximum.Within the selected zone, aisle or range of locations.This value sets the maximum Y coordinate that the location must have to generate a count task.It must be higher than the MinimumY value. You must indicate a positive integer. If “MaximumX” and “MinimumX” have values, it must be less than “MaximumX”. |
| | | | YMin | No | long | Y minimum.Within the selected zone, corridor or range of locations.This value sets the minimum Y coordinate that the location must have in order to generate a count task. It must be less than the MaximumY value. You must indicate a positive integer. If “MaximumX” and “MinimumX” have values, it must be less than “MaximumX”. |
| | | **LineNumber** | **Yes** | long | Sets the count line number |
| | | OwnerCodeCountLine | No | string(50) | Owner code item to count |
| | | CustomAttribute | No | Group | Data about the line custom attributes. It contains the necessary data to define the custom attributes of the line from the ERP |
| | | | Attribute1 | No | string(1000) | Attribute 1. Default value is empty string. |
| | | | Attribute2 | No | string(1000) | Attribute 2. Default value is empty string. |
| | | | Attribute3 | No | string(1000) | Attribute 3. Default value is empty string. |
| | | | Attribute4 | No | string(1000) | Attribute 4. Default value is empty string. |
| | | | Attribute5 | No | string(1000) | Attribute 5. Default value is empty string. |
| | | | Attribute6 | No | string(1000) | Attribute 6. Default value is empty string. |
| | | | Attribute7 | No | string(1000) | Attribute 7. Default value is empty string. |
| | | | Attribute8 | No | string(1000) | Attribute 8. Default value is empty string. |
| | | | Attribute9 | No | string(1000) | Attribute 9. Default value is empty string. |
| | | | Attribute10 | No | string(1000) | Attribute 10. Default value is empty string. |
| | | | Attribute11 | No | string(1000) | Attribute 11. Default value is empty string. |
| | | | Attribute12 | No | string(1000) | Attribute 12. Default value is empty string. |
| | | | Attribute13 | No | string(1000) | Attribute 13. Default value is empty string. |
| | | | Attribute14 | No | string(1000) | Attribute 14. Default value is empty string. |
| | | | Attribute15 | No | string(1000) | Attribute 15. Default value is empty string. |
| | | | Attribute16 | No | string(1000) | Attribute 16. Default value is empty string. |
| | | | Attribute17 | No | string(1000) | Attribute 17. Default value is empty string. |
| | | | Attribute18 | No | string(1000) | Attribute 18. Default value is empty string. |
| | | | Attribute19 | No | string(1000) | Attribute 19. Default value is empty string. |
| | | | Attribute20 | No | string(1000) | Attribute 20. Default value is empty string. |
| | | IsInformed | No | bool | Indicates if count is informed (true, 1) or not (false, 0) |
| | **TransactionalLineList** | **Yes** | bool | Indicator of transactionality for the line list. If it is true, the whole list must be treated as an atomic transaction.
If it is false, each element must be individually transactioned. |
| | **CompleteLineList** | **Yes** | bool | Indicator of completeness for the line list. In case it is true, the whole list must be treated as the only lines allowed for the inbound order.
If it is false, more lines appart from those in the list can exist for this inbound order. |
##### Container Move Confirmation - CMC
**Message type**: CMC (Container Movement Confirmation)
**Import / Export**: Import
**Command name**: Mecalux.ITSW.EasyWMS.Modules.Contracts.Commands.ContainerMovementConfirmationERPCommand, Mecalux.ITSW.EasyWMS.Modules.Contracts
**Description**: When movements from an outbound point are not managed via Easy WMS, the CMC message is used for the ERP to confirm the movement from outbound conveyor to the next destination..
- CMC message allow “1” (delete) and “0” (update) operations .
- Delete operation doest not requires a destination, and the container Will be removed on Easy WMS.
- With the update operation the destination is a mandatory field, and Easy WMS will move the container on outbound conveyor to the location indicated in CMC message. If this operation has not destination, Easy WMS will return an error message.
**Structure**:
**CMC**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **ContainerCode** | **Yes** | string(50) | Container code |
| **Operation** | **Yes** | Enumeration | Indicates the operation that will be executed (1: Update: Update, move container, 2: Delete: Delete, delete container) |
| ForceDeletionOfEmptyHolderContainer | No | bool | Indicates that the holder container will be deleted (if empty) when Operation is “Delete” |
| LocationCode | No | string(50) | Location code to move container when Operation is “Update” |
| **WarehouseCode** | **Yes** | string(50) | Warehouse code to move container when Operation is “Update” |
#### Exported messages
Messages that will be sent in Export direction (from MAP to the ERP).
##### Kitting - KST
**Message type**: KST (Kit stock assembled)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used to notify the assembly of stock of kits inEasy WMS so that the ERP can know the new stock created and the components that have been used to mount it.
**Structure**:
**KST01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Warehouse stock site |
| WorkOrderCode | No | string(50) | Work order code |
| **KitItemCode** | **Yes** | string(50) | Kit item code |
| **KitOwnerCode** | **Yes** | string(50) | Kit item owner code |
| **KitQuantity** | **Yes** | long | Quantity mounted. Positive number greater than 0 |
| **KitQuantityUomCode** | **Yes** | string(50) | UoM (Unit of Measure) of the quantity |
| KitLocation | No | string(50) | Location code |
| KitContainer | No | string(50) | LPN |
| **KitVersion** | **Yes** | string(65) | Kit version |
| KitAttLot | No | string(128) | Lot logistic attribute |
| KitAttSN | No | string(128) | Serial number logistic attribute |
| KitAttProdDate | No | DateTime | Production date logistic attribute. UTC date-time format |
| KitAttExpDate | No | DateTime | Expiration date logistic attribute. UTC date-time format |
| KitAttBBDate | No | DateTime | Best before date logistic attribute. UTC date-time format |
| KitAttDaysLife | No | DateTime | Shelf life data logistic attribute. UTC date-time format |
| KitAttQuality | No | string(128) | Quality logistic attribute |
| KitAttColor | No | string(128) | Color logistic attribute |
| KitAttSource | No | string(128) | Source logistic attribute |
| KitAttProdMethod | No | string(128) | Production method logistic attribute |
| KitAttPostTreat | No | string(128) | Post-production treatment logistic attribute |
| KitAttSize | No | string(128) | Size logistic attribute |
| **Components** | **Yes** | Group | Data about the components. It contains the necessary data to define the components from the ERP |
| | **Component** | **Yes** | List | Data about the component. It contains the necessary data to define the component from the ERP |
| | | **CompItemCode** | **Yes** | string(50) | Item component code |
| | | **CompOwnerCode** | **Yes** | string(50) | Item component owner |
| | | **CompQtty** | **Yes** | long | Quantity. Positive number greater than 0 |
| | | **CompQttyUomCode** | **Yes** | string(50) | UoM (Units of Measure) of the quantity |
| | | CompLocationCode | No | string(50) | Location code |
| | | CompContainerCode | No | string(50) | LPN |
| | | CompWeight | No | decimal | Weight. Positive number greater than 0 |
| | | CompAttLot | No | string(128) | Lot logistic attribute |
| | | CompAttSN | No | string(128) | Serial number logistic attribute |
| | | CompAttProdDate | No | DateTime | Fabrication date logistic attribute. UTC date-time format |
| | | CompAttExpDate | No | DateTime | Expiration date logistic attribute. UTC date-time format |
| | | CompAttBBDate | No | DateTime | Best before date logistic attribute. UTC date-time format |
| | | CompAttDaysLife | No | DateTime | Shelf life logistic attribute.UTC date-time format |
| | | CompAttQuality | No | string(128) | Quality logistic attribute |
| | | CompAttColor | No | string(128) | Color logistic attribute |
| | | CompAttSource | No | string(128) | Source logistic attribute |
| | | CompAttProdMethod | No | string(128) | Production method logistic attribute |
| | | CompAttPostTreat | No | string(128) | Post-production treatment logistic attribute |
| | | CompAttSize | No | string(128) | Size logistic atributte |
| | | CompAttVersion | No | string(128) | Version logistic attribute |
| | | CompCustomAttributes | No | CompCustomAttributes | Data about the component custom attributes. It contains the necessary data to define the component custom attributes from the ERP |
| KitCustomAttributes | No | KitCustomAttributes | Data about the kit custom attributes. It contains the necessary data to define the kit custom attributes from the ERP |
##### Dekitting – UNK
**Message type**: UNK (Kit stock disassembled)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used to notify the disassembly of stock of kits inEasy WMS so that the ERP can know the new stock of the components and the current stock of the kit.
**Structure**:
**UNK01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Warehouse stock site |
| WorkOrderCode | No | string(50) | Work order code |
| **KitItemCode** | **Yes** | string(50) | Kit item code |
| **KitOwnerCode** | **Yes** | string(50) | Kit item owner code |
| **KitQuantity** | **Yes** | long | Quantity dissasembled. Positive number greater than 0 |
| **KitQuantityUomCode** | **Yes** | string(50) | UoM (Units of Measure) of the quantity |
| KitLocation | No | string(50) | Location code |
| **KitVersion** | **Yes** | string(65) | Kit version |
| KitAttLot | No | string(128) | Lot logistic attribute |
| KitAttSN | No | string(128) | Serial number logistic attribute |
| KitAttProdDate | No | DateTime | Production date logistic attribute. UTC date-time format |
| KitAttExpDate | No | DateTime | Expiration date logistic attribute. UTC date-time format |
| KitAttBBDate | No | DateTime | Best before date logistic attribute. UTC date-time format |
| KitAttDaysLife | No | DateTime | Shelf life data logistic attribute. UTC date-time format |
| KitAttQuality | No | string(128) | Quality logistic attribute |
| KitAttColor | No | string(128) | Color logistic attribute |
| KitAttSource | No | string(128) | Source logistic attribute |
| KitAttProdMethod | No | string(128) | Production method logistic attribute |
| KitAttPostTreat | No | string(128) | Post-production treatment logistic attribute |
| KitAttSize | No | string(128) | Size logistic attribute |
| **Components** | **Yes** | Group | Data about the components. It contains the necessary data to define the components from the ERP |
| | **Component** | **Yes** | List | Data about the component. It contains the necessary data to define the component from the ERP |
| | | **CompItemCode** | **Yes** | string(50) | Item component code |
| | | **CompOwnerCode** | **Yes** | string(50) | Item component owner |
| | | **CompQtty** | **Yes** | long | Quantity. Positive number greater than 0 |
| | | **CompQttyUomCode** | **Yes** | string(50) | UoM (Units of Measure) of the quantity |
| | | CompLocationCode | No | string(50) | Location code |
| | | CompWeight | No | decimal | Weight. Positive number greater than 0 |
| | | CompCustomAttributes | No | CompCustomAttributes | Data about the component custom attributes. It contains the necessary data to define the component custom attributes from the ERP |
| KitCustomAttributes | No | KitCustomAttributes | |
##### Stock variation - STV
**Message type**: STV (Stock variation)
**Import / Export**: Export
**Version**: 01
**Description**: With this message, Easy WMS notifies stock quantity variations due to adjustment - Stock quantity adjustments are actions performed without previous ERP knowledge. When variations in the stock quantity are a result of an ERP notified actions (i.e. shipping or receipts) no STV message is sent, because finish notification messages will be sent when the action is done. - This message notifies stock quantity increases as well as decreases and logistic attributes modifications.
**Structure**:
**STV01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Operation** | **Yes** | string | Performed operation: - _C_: stock quantity increase (creation) - _D_: stock quantity decrease (deletion) |
| **Site** | **Yes** | string(50) | Warehouse stock site code. |
| **ItemCode** | **Yes** | string(50) | Item code. |
| **OwnerCode** | **Yes** | string(50) | Item owner code. |
| LocationCode | No | string(50) | Current stock location code. |
| ContainerCode | No | string(50) | Current stock container code. |
| Status | No | Group | Stocks assigned status. |
| | StaUsrCode | No | string(50) | Current user stock status. |
| | StaUsrEnd | No | DateTime | Current user status end date. |
| | StaUsrComment | No | string(1000) | Current user status comment. |
| | StaRecCode | No | string(50) | Current reception status code. |
| | StaRecEnd | No | DateTime | Current reception status end date. |
| FilterAttributes | No | FltAttributes | This data group will be used as a filter to indicate the specific selection of the stock that has changed in the system. The values of the filter will be the previous values of the stock attributes. In case of deletion, this group will also be used for attributes present in the stock line to be deleted, but not required by the logistic profile of the item. |
| FilterCustomAttributes | No | FltCustomAttributes | This data group will only be used as a filter to indicate the specific selection of the stock that has changed in the system. The values of the filter will be the previous values of the customized of the stock attributes. In case of deletion, this group will also be used for attributes present in the stock line to be deleted, but not required by the logistic profile of the item. |
| **QuantityVar** | **Yes** | decimal | Added or diminished quantity. If quantity has not been modified this value will be zero. |
| **UoMCode** | **Yes** | string(50) | Item unit of measure. |
| ReasonCode | No | string(50) | Adjust reason code. |
| ERPReasonCode | No | string(50) | ERP adjust reason code. |
| Comment | No | string(1000) | Open text adjust comment. |
| Attributes | No | Attributes | In this group, the new values of the stock attributes will be specified in case of modification. |
| CustomAttributes | No | CustomAttributes | In this group, the new values of the stock attributes will be specified in case of modification. |
##### Stock status change- STC
**Message type**: STC (Stock status change)
**Import / Export**: Export
**Version**: 01
**Description**: This message is a response of a previous STR ERP request, or a warehouse stock status change notified by Easy WMS.
- Every single creation or deletion of stock status will generate a specific STC message notification.
**Structure**:
**STC01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the stock warehouse site |
| **ItemCode** | **Yes** | string(50) | Item Code |
| OwnerCode | No | string(50) | Stock owner code |
| **Quantity** | **Yes** | decimal | Stock quantity |
| **UoMCode** | **Yes** | string(50) | UoM (Unit of Measure) of the quantity |
| Filter | No | Filter | Filter to select the specific stock where the status was modified |
| **Status** | **Yes** | Group | Status |
| | **StaUsrEmpty** | **Yes** | bool | When true, no user status set currently. When false, StaUsrCode is the current user status |
| | StaUsrPrevCode | No | string(50) | User status previous to current user status |
| | StaUsrCode | No | string(50) | Current user status |
| | StaUsrEnd | No | DateTime | Current user status end date |
| | StaUsrComment | No | string(1000) | Current user status comment |
| | **StaRecEmpty** | **Yes** | bool | When true, no reception status set currently. When false, StaRecCode is the current reception status |
| | StaRecPrevCode | No | string(65) | Recepction status previous to current reception status |
| | StaRecCode | No | string(65) | Current reception status |
| | StaRecEnd | No | DateTime | Current reception status end date |
##### Warehouse stock count - WSC
**Message type**: WSC (Warehouse stock count)
**Import / Export**: Export
**Version**: 01
**Description**: This message allows to request a stock count with the currently existing data in Easy WMS. Stock to count can be filtered. SCR messages are always responded with WSC01 messages - The WSC messages always are the response of same version SCR messages. It is not possible to activate different SCR and WSC versions. - The stock is taken into account since its reception has been closed to it is shipped in a shipping order. - The ASN containers will not be counted since the container has been confirmated and the ASO has been sent. - When the WSC responds to a massive count request (SCR with _MassiveCount_ _true_), WSC message will group identical stock lines in different locations or LPN. Different status or different logistic attributes will not be grouped - When the WSC responds to a detailed count request (SCR with _MassiveCount_ _false_), WSC will contain a stock line for each stock line in the site - When the SCR requests the count of various _Items_ or _Containers_, one response for each one will be sent.
**Structure**:
**WSC01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site. |
| **WSCDate** | **Yes** | DateTime | Count effective date. |
| Batch | No | string(50) | Unique code used to group different messages in the same batch. It is the same code as the _batch_ code in the _SCR_ request. |
| Stocks | No | Group | The counted stock lines (grouped if it is a massive count). |
| | Stock | No | List | |
| | | ItemCode | No | string(50) | Stock item code. |
| | | OwnerCode | No | string(50) | Stock owner code. |
| | | TypeCode | No | string(50) | Stock item type code. |
| | | FamilyCode | No | string(50) | Stock item family code. |
| | | LocationCode | No | string(50) | The location where is the stock (only for not massive count). |
| | | ContainerCode | No | string(50) | The LPN (_License Plate Number_) where is the stock (only for not massive count). |
| | | **Quantity** | **Yes** | decimal | Stock line quantity. In case of massive count contains the sum of the quantities in the grouped lines. |
| | | UoMCode | No | string(50) | The unit of measure of the stock. |
| | | Status | No | Group | Current user stock status. |
| | | | StaUsrCode | No | string(50) | Current user stock status. |
| | | | StaUsrEnd | No | DateTime | Current user status end date. |
| | | | StaUsrComment | No | string(1000) | Current user status comment. |
| | | | StaRecCode | No | string(65) | Current reception status code. |
| | | | StaRecEnd | No | DateTime | Current reception status end date. |
| | | Attributes | No | Attributes | The stock logistic attributes of the stock. |
| | | CustomAttributes | No | CustomAttributes | Custom attributes of the stock. |
##### Count order finalization - COF
**Message type**: COF (Count Order Finalization)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used as a response to the warehouse count order request (COR). It contains the inventory (stock/containers) existing in the counted locations.
- COF messages must always be responses to COR requests with the same version number. It is not possible to activate different versions of COR and COF, as it will imply that COF responses will no longer be received, since the same response version cannot be found.
- Advance notice containers(ASN) will not be considered in the count until they are confirmed (ASO).
- COF message will also notify you the status of the count order. Which may be finalized (“closed”) and will have their corresponding stock lines, or canceled (“cancelled”) in this case there will be no record of any location.
- The COF message will also notify the status changes in the order (“closed” and “cancelled”). When the orders are cancelled, the message will only include the header, indicating the data of the order and its status. When the order is closed, the status change will be notified in the header and the body of the message will include the stock. Deleted orders (before being released) will not issue any COF message.
- When the closing of a count order that has been created by the COR message is forced, for all the count lines that have not been counted, the stock registered in the warehouse will be included in the message, despite not having been counted.
- For item and container counts, in automatic warehouses, the location of origin of the container in the message structure will be omitted.
**Structure**:
**COF01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the system site where the stock is located. |
| **CountCode** | **Yes** | string(50) | Count order code. |
| **Status** | **Yes** | string | Ending order status. Possible values: Closed, Cancelled |
| **UpdateDate** | **Yes** | DateTime | Date and time in UTC time when the order status change transaction occurred. |
| Lines | No | Group | Data about the lines of the count order. |
| | **Line** | **Yes** | List | Data about the line of the count order. |
| | | **LineNumber** | **Yes** | long | Sets the count line number with which it was indicated in the COR message. |
| | | Container | No | Group | Data about the container set in count order line. |
| | | | **CntCode** | **Yes** | string(50) | Code of the container requested for counting. |
| | | | **CntCodeExists** | **Yes** | bool | Indicates whether or not the code exists in the warehouse. If the container code does not exist in the system, this value will be set to zero |
| | | | LocationCode | No | string(50) | Code of the location of the container at that time. In the case of an automatic warehouse, the location is omitted. This is because containers are usually counted at a workstation |
| | | | Stocks | No | Group | Stock counted in the container |
| | | | | Stock | No | List | Contains the counted stock data |
| | | | | | **ItemCode** | **Yes** | string(50) | Item code. |
| | | | | | OwnerCode | No | string(50) | Stock owner code. |
| | | | | | **Quantity** | **Yes** | decimal | Existing stock quantity. Positive number greater than or equal to zero |
| | | | | | **UoMCode** | **Yes** | string(50) | Unit of Measurement in which the quantity is expressed. |
| | | | | | ContainerCode | No | string(50) | Code of the container that contains the stock. |
| | | | | | UserStatus | No | Group | Stock user status |
| | | | | | | StaUsrCode | No | string(50) | Stock current user status |
| | | | | | | StaUsrEnd | No | DateTime | Stock current user status end date. Date and hour in UTC |
| | | | | | | StaUsrComment | No | string(1000) | Stock current user status comment |
| | | | | | Attributes | No | Attributes | Data about the stock line attributes. |
| | | Locations | No | Group | Data about the locations set in count order line. |
| | | | Location | No | List | Data about the location set in count order line. |
| | | | | LocationCode | No | string(50) | Counted location code. |
| | | | | LocationEmpty | No | bool | Indicates if the counted location is empty. 1 = location with stock and 0 = empty location. |
| | | | | Stocks | No | Group | Contains the counted stock data |
| | | | | | Stock | No | List | Contains the counted stock data |
| | | | | | | **ItemCode** | **Yes** | string(50) | Item code. |
| | | | | | | OwnerCode | No | string(50) | Stock owner code. |
| | | | | | | **Quantity** | **Yes** | decimal | Existing stock quantity. Positive number greater than or equal to zero |
| | | | | | | **UoMCode** | **Yes** | string(50) | Unit of Measurement in which the quantity is expressed. |
| | | | | | | ContainerCode | No | string(50) | Code of the container that contains the stock. |
| | | | | | | UserStatus | No | Group | Stock user status |
| | | | | | | | StaUsrCode | No | string(50) | Stock current user status |
| | | | | | | | StaUsrEnd | No | DateTime | Stock current user status end date. Date and hour in UTC |
| | | | | | | | StaUsrComment | No | string(1000) | Stock current user status comment |
| | | | | | | Attributes | No | Attributes | Data about the stock line attributes. |
| | | LneCustomAttributes | No | LneCustomAttributes | Data about the line custom attributes set in count order line. |
| CustomAttributes | No | CustomAttributes | Data about the count order custom attributes. |
##### Container output to PS - COS
**Message type**: COS (Container Shipped)
**Import / Export**: Export
**Version**: 01
**Description**: This message is sent to inform of the arrival of a container at the outbound conveyor.
- When a container finishes an order at an outbound conveyor, the ERP is informed. This message will allow you to manage, through the ERP communications, movements from the output conveyor.
- If the container has a destination after the output point, the message will indicate that destination and, if applicable, the order to which the container is associated.
- If the destination of the container is the output point itself, the destination fields will be sent empty.
**Structure**:
**COS01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Warehouse site code |
| **StationCode** | **Yes** | string(50) | Station code |
| **LocationCode** | **Yes** | string(50) | Location code |
| **ContainerCode** | **Yes** | string(50) | Container code |
| ContainerType | No | string(50) | Container type |
| OutboundOrderCode | No | string(50) | Outbound order code |
| OutboundOrderLineNumber | No | long | Outbound order line number |
| RouteCode | No | string(50) | Route code |
| StopNumber | No | long | Stop number when the task has a route |
| StationToCode | No | string(50) | Station destination code |
| LocationToCode | No | string(50) | Location destination code |
| **ShippingDate** | **Yes** | DateTime | Shipping date |
| CustomAttributes | No | CustomAttributes | Data about the custom attributes |
##### Client container closed in MP - COC
**Message type**: COC (Container closed)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used to notify to ERP when a client container is closed on the preparation table.
- When a container is closed on a preparation table, the ERP is informed. This message will allow to manage, through the ERP, movements from the preparation table to its destination station.
- The message will inform about the destination of the container, if it has destination, or empty if the container has not destination
**Structure**:
**COC01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **Site** | **Yes** | string(50) | Code of the warehouse site |
| **StationCode** | **Yes** | string(50) | Code of the station |
| **LocationCode** | **Yes** | string(50) | Location code |
| **ContainerCode** | **Yes** | string(50) | Code of the container |
| ContainerType | No | string(50) | Container type |
| OutboundOrderCode | No | string(50) | Outbound order code |
| RouteCode | No | string(50) | Route code |
| StopNumber | No | long | Stop number when the task has a route |
| StationToCode | No | string(50) | Station destination code |
| LocationToCode | No | string(50) | Location destination code |
| **CloseDate** | **Yes** | DateTime | Close Date |
| CustomAttributes | No | CustomAttributes | Data about the custom attributes |
##### Suggested ABC Classification - SAC
**Message type**: SAC (Suggested ABC Classification)
**Import / Export**: Export
**Version**: 01
**Description**: The purpose of this message is to notify the ERP about misclassify items in terms of ABC classification and suggest a proper one. - This message is only sent when the ABC Evaluation has been executed and the **_“Notify to ERP”_** button has been selected. - This message informs all the values with which the **_“ABC Evaluation”_** was executed and all of the items that, under these tested values, are considered to be misclassified (as well as their suggested ABC classification value).
**Structure**:
**SAC01**
| Field | Required | Format | Description |
| --- | --- | --- | --- |
| **CurrentDate** | **Yes** | DateTime | Date in UTC time when the message was generated. |
| **DefinedVariables** | **Yes** | Group | Variable values with which the ABC Evaluation was executed. |
| | LastDays | No | long | Indicates the number of reatroactive days from the _LastCalculationDate_ that are used for extract the data to analyze. |
| | InitialDate | No | DateTime | The initial date of the time interval where the evaluation data has been recovered (date-time in UTC) |
| | FinalDate | No | DateTime | The final date of the time interval where the evaluation data has been recovered (date-time in UTC) |
| | **AnalysisType** | **Yes** | string(50) | This value indicates the behavior with which items had been classified: _Inclusive_ if an item has any participation in a higher ABC classification, regardless if most of its value belongs to a lower classification, it will be assigned to the higher classification. _Exclusive_ if the item is assigned the lowest classification in which its value participates. |
| | **PickingMovements** | **Yes** | bool | Indicates if picking tasks have been included in the ABC evaluation. |
| | **PutawayMovements** | **Yes** | bool | Indicates if putaway tasks have been included in the ABC evaluation. |
| | **ReplenishmentMovements** | **Yes** | bool | Indicates if replenishment tasks have been included in the ABC evaluation. |
| | **ShippingMovements** | **Yes** | bool | Indicates if shipping tasks have been included in the ABC evaluation. |
| | **LastCalculationDate** | **Yes** | DateTime | Indicates the date when the evaluation was executed (date-time in UTC). |
| **Lines** | **Yes** | Group | This group holds only the items with a different values in categories _AnalysisABC_ and _SuggestedABCClassification_. |
| | **Line** | **Yes** | List | |
| | | **ItemCode** | **Yes** | string(50) | Evaluated item code. |
| | | **Owner** | **Yes** | string(50) | Owner of the evaluted item. |
| | | **AnalysisABC** | **Yes** | string(50) | Registered ABC classification. |
| | | **SuggestedABCClassification** | **Yes** | string(50) | Suggested ABC classification after the analysis. |
### Errors
#### Exported messages
Messages that will be sent in Export direction (from MAP to the ERP).
##### Error message - ERR
**Type of message**: ERR (Error)
**Import / Export**: Export
**Version**: 01
**Description**: This message is used to notifies about the errors happened during ERP batch or XML messages import:
- Some errors that could happen are:
- Non existing reference
- Mandatory data field not set
- Validating error
- Data lock error
- Import service error
- Unknown error
- Depending on the _transactional_ mode of the element that produces the error, the ERR message could contain only one, or several errors into the _NestedErrors_ group:
- When _transactional_ attribute is true, only one error could happen in one element, because if this error happens, the processing of the message will be stopped and reverted
- When _transactional_ attribute is false, multiple errors could happen in one element, and the ERR message would contain every error description during processing
- The _ErrException_ element contains not only the description of the error exception, but also identifies the specific element in the message group that has produced the error by its primary key data
**Structure**:
**ERR01**
Reference in New Issue View Git Blame Copy Permalink