Saltar al contenido principal

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 SolicitudURL Ejemplo
POST{{url_base}}/PostAddReturnOrderLoad
Ejemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddReturnOrderLoad"

Parámetros de Entrada

ParámetroTipoObligatorioDescripción
ReturnLoadNoString(25)Código externo de carga de devolución
BranchNoString(25)Código externo de la filial
ReturnLoadDateDataHoraFecha de carga
RoutingDateDataHoraNoFecha/hora de armado de carga
TransporterNoString(25)Código externo del transportista
DriverNoString(25)Código externo del conductor
VehiclePlateNoString(8)Placa del vehículo
ReplacedTransporterNoString(25)NoCódigo externo del transportista de reemplazo
ReplacedDriverNoString(25)NoCódigo externo del conductor de reemplazo
ReplacedVehiclePlateNoString(8)NoPlaca del vehículo de reemplazo
DispatchingDateDataHoraNoFecha esperada de inicio de carga
isBlockedBooleanFlag que indica si la carga de devolución será creada con estado bloqueado
NotesString(2000)NoObservación
SalesReturnOrderListAddReturnOrderLoadItemListLista con todos los códigos externos de órdenes de devolución en la carga de devolución
Observación
  • Si el parámetro RoutingDate no es informado, se utilizará la fecha informada en el parámetro ReturnLoadDate

📝 Objeto AddReturnOrderLoadItemList

El objeto AddReturnOrderLoadItemList representa una orden de venta en la carga de devolución.

Parámetros de Entrada

ParámetrosTipoObligatorioDescripción
SalesReturnOrderNoString(25)Código externo de orden de devolución de la carga de devolución

Retorno

ParámetroTipoObligatorioDescripción
WebServiceReturnWebServiceReturnInformaciones estándar de respuesta del WebService en la ejecución del método
ReturnLoadCodeIntegerCó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ódigoMensaje
ARL‑001El parámetro Código Externo de Carga de Devolución (ReturnLoadNo) informado ya existe!
ARL‑002La 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‑003La 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‑004El 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‑005El parámetro Código Externo de Transportista (TransporterNo) pertenece a un proveedor que no es de tipo "Transportista". Operación no permitida!
ARL‑006El 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 SolicitudURL Ejemplo
POST{{url_base}}/PostDeleteReturnOrderLoad
Ejemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteReturnOrder"

Parámetros de Entrada

ParámetroTipoObligatorioDescripción
ReturnLoadNoString(25)Código externo de carga de devolución
BranchNoString(25)Código externo de la filial
ErrorIfNotFoundBooleanNoRetorna error si la carga de devolución informada no existe en la base de datos

Retorno

ParámetroTipoObligatorioDescripción
WebServiceReturnWebServiceReturnInformaciones 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ódigoMensaje
DRL‑001El 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‑002El camión de la Carga de Devolución informada ya fue pesado. Operación no permitida!