Carga de Devolución
Registro de Carga de Devolución
El endpoint PostAddReturnOrderLoad es responsable de registrar una nueva carga de devolución en el sistema MIMS.
Cómo registrar una carga de devolución
HTTP POST Request
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostAddReturnOrderLoad |
| Ejemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddReturnOrderLoad" |
Parámetros de Entrada
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| ReturnLoadNo | String(25) | Sí | Código externo de carga de devolución |
| BranchNo | String(25) | Sí | Código externo de la filial |
| ReturnLoadDate | DataHora | Sí | Fecha de carga |
| RoutingDate | DataHora | No | Fecha/hora de armado de carga |
| TransporterNo | String(25) | Sí | Código externo del transportista |
| DriverNo | String(25) | Sí | Código externo del conductor |
| VehiclePlateNo | String(8) | Sí | Placa del vehículo |
| ReplacedTransporterNo | String(25) | No | Código externo del transportista de reemplazo |
| ReplacedDriverNo | String(25) | No | Código externo del conductor de reemplazo |
| ReplacedVehiclePlateNo | String(8) | No | Placa del vehículo de reemplazo |
| DispatchingDate | DataHora | No | Fecha esperada de inicio de carga |
| isBlocked | Boolean | Sí | Flag que indica si la carga de devolución será creada con estado bloqueado |
| Notes | String(2000) | No | Observación |
| SalesReturnOrderList | AddReturnOrderLoadItemList | Sí | Lista con todos los códigos externos de órdenes de devolución en la carga de devolución |
Observación
- Si el parámetro
RoutingDateno es informado, se utilizará la fecha informada en el parámetroReturnLoadDate
📝 Objeto AddReturnOrderLoadItemList
El objeto AddReturnOrderLoadItemList representa una orden de venta en la carga de devolución.
Parámetros de Entrada
Parámetros Tipo Obligatorio Descripción SalesReturnOrderNo String(25) Sí Código externo de orden de devolución de la carga de devolución
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Informaciones estándar de respuesta del WebService en la ejecución del método |
| ReturnLoadCode | Integer | Sí | Código interno de carga de devolución generado en el sistema MIMS |
Ejemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddReturnOrderLoad"' \
--header 'Content-Type: application/json' \
--data '{
"ReturnLoadNo": "RL12345",
"BranchNo": "101",
"ReturnLoadDate": "2025-02-07T00:00:00",
"RoutingDate": "2025-02-07T00:00:00",
"TransporterNo": "030703",
"VehiclePlateNo": "GFI2I13",
"ReplacedVehiclePlateNo": "MHW6C93",
"ReplacedTransporterNo": "031771",
"ReplacedDriverNo": "46049853835",
"DriverNo": "27213585886",
"SalesReturnOrderList": [
{
"SalesReturnOrderNo": 2314504
}
],
"DispatchingDate": "2025-02-07T00:00:00",
"isBlocked": false,
"Notes": "Carga Filial 1"
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"ReturnLoadCode": 1001
}
🐞 Posibles Errores
| Código | Mensaje |
|---|---|
| ARL‑001 | El parámetro Código Externo de Carga de Devolución (ReturnLoadNo) informado ya existe! |
| ARL‑002 | La Orden de Devolución de Venta "[valor enviado en la solicitud]" informada en el índice [[código del índice]] pertenece a una carga de devolución diferente. Proceso Abortado! |
| ARL‑003 | La Orden de Devolución de Venta "[valor enviado en la solicitud]" informada en el índice [[código del índice]] está bloqueada. Operación no permitida! |
| ARL‑004 | El estado de la Orden de Devolución de Venta "[valor enviado en la solicitud]" informada en el índice [[código del índice]] ("[valor enviado en la solicitud]") no está disponible para carga. Proceso Abortado! |
| ARL‑005 | El parámetro Código Externo de Transportista (TransporterNo) pertenece a un proveedor que no es de tipo "Transportista". Operación no permitida! |
| ARL‑006 | El vínculo entre transportista x vehículo de la orden de devolución de venta es diferente del vínculo entre transportista x vehículo de la carga de devolución. Proceso abortado! |
Exclusión de Carga de Devolución
El endpoint PostDeleteReturnOrderLoad es responsable de ejecutar la exclusión de una carga de devolución en MIMS.
Cómo excluir una carga de devolución
HTTP POST Request
| Tipo de Solicitud | URL Ejemplo |
|---|---|
| POST | {{url_base}}/PostDeleteReturnOrderLoad |
| Ejemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteReturnOrder" |
Parámetros de Entrada
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| ReturnLoadNo | String(25) | Sí | Código externo de carga de devolución |
| BranchNo | String(25) | Sí | Código externo de la filial |
| ErrorIfNotFound | Boolean | No | Retorna error si la carga de devolución informada no existe en la base de datos |
Retorno
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sí | Informaciones estándar de respuesta del WebService en la ejecución del método |
Ejemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteReturnOrderLoad"' \
--header 'Content-Type: application/json' \
--data '{
"ReturnLoadNo": "RL12345",
"BranchNo": "101",
"ErrorIfNotFound": false
}'
Ejemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Posibles Errores
| Código | Mensaje |
|---|---|
| DRL‑001 | El estado actual de la Carga de Devolución informada ("[valor enviado en la solicitud]") no está disponible para exclusión. El estado de la Carga de Devolución debe ser "[estado permitido]" o "[estado permitido]"! |
| DRL‑002 | El camión de la Carga de Devolución informada ya fue pesado. Operación no permitida! |