Carga de Devolução

---

Cadastro de Carga de Devolução

O endpoint PostAddReturnOrderLoad é responsável por cadastrar uma nova carga de devolução no sistema MIMS.

---

Como cadastrar uma carga de devolução

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostAddReturnOrderLoad
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddReturnOrderLoad"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
ReturnLoadNo	String(25)	Sim	Código externo da carga de devolução
BranchNo	String(25)	Sim	Código externo da filial
ReturnLoadDate	DataHora	Sim	Data do carregamento
RoutingDate	DataHora	Não	Data/Hora da montagem da carga
TransporterNo	String(25)	Sim	Código externo do transportador
DriverNo	String(25)	Sim	Código externo do motorista
VehiclePlateNo	String(8)	Sim	Placa do veículo
ReplacedTransporterNo	String(25)	Não	Código externo do transportador substituto
ReplacedDriverNo	String(25)	Não	Código externo do motorista substituto
ReplacedVehiclePlateNo	String(8)	Não	Placa do veículo substituto
DispatchingDate	DataHora	Não	Data prevista para início de carregamento
isBlocked	Boolean	Sim	Flag que indica se a carga de devolução será criada com status bloqueado
Notes	String(2000)	Não	Observação
SalesReturnOrderList	AddReturnOrderLoadItemList	Sim	Lista com todos os códigos externos dos pedidos de devolução da carga de devolução

Observação

• Caso o parâmetro RoutingDate não for informado, será usado a data informada no parâmetro ReturnLoadDate

📝 Objeto AddReturnOrderLoadItemList

O objeto AddReturnOrderLoadItemList representa um pedido de venda da carga de devolução.

Parâmetros de Entrada

Parâmetros	Tipo	Obrigatório	Descrição
SalesReturnOrderNo	String(25)	Sim	Código externo do pedido de devolução da carga de devolução

---

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método
ReturnLoadCode	Integer	Sim	Código interno da carga de devolução gerada no sistema MIMS

---

Exemplo 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"
}'

---

Exemplo de Response

{
  "WebServiceReturn": {
    "Status": "wrsSuccess",
    "ErrorCode": "",
    "Message": "",
    "Actor": "",
    "ReturnQuestion": null
  },
  "ReturnLoadCode": 1001
}

---

🐞 Possíveis Erros

Código	Mensagem
ARL‑001	Parâmetro Código Externo da Carga de Devolução (ReturnLoadNo) informado já existe!
ARL‑002	Pedido de Devolução de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] pertence a uma carga de devolução diferente. Processo Abortado!
ARL‑003	Pedido de Devolução de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] está bloqueado. Operação não permitida!
ARL‑004	O status Pedido de Devolução de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] ("[valor enviado na requisição]") não está disponível para carregamento. Processo Abortado!
ARL‑005	Parâmetro Código Externo do Transportador (TransporterNo) pertence a um fornecedor que não é do tipo "Transportador". Operação não permitida!
ARL‑006	O vinculo entre transportador x veículo do pedido de devolução de venda é diferente da ligação entre transportador x veículo da carga de devolução. Processo abortado!

Exclusão de Carga de Devolução

O endpoint PostDeleteReturnOrderLoad é responsável por executar a exclusão de uma carga de devolução no MIMS.

---

Como excluir uma carga de devolução

Request HTTP Post

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/PostDeleteReturnOrderLoad
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteReturnOrder"

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
ReturnLoadNo	String(25)	Sim	Código externo da carga de devolução
BranchNo	String(25)	Sim	Código externo da filial
ErrorIfNotFound	Boolean	Não	Retorna erro caso a carga de devolução informada não exista no banco de dados

Retorno

Parâmetro	Tipo	Obrigatório	Descrição
WebServiceReturn	WebServiceReturn	Sim	Informações padrão de resposta do WebService na execução do método

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteReturnOrderLoad"' \
--header 'Content-Type: application/json' \
--data '{
    "ReturnLoadNo": "RL12345",
    "BranchNo": "101",
    "ErrorIfNotFound": false
}'

---

Exemplo de Response

{
  "WebServiceReturn": {
      "Status": "wrsSuccess",
      "ErrorCode": "",
      "Message": "",
      "Actor": "",
      "ReturnQuestion": null
  }
}

---

🐞 Possíveis Erros

Código	Mensagem
DRL‑001	O status atual da Carga de devolução informada ("[valor enviado na requisição]") não está disponível para exclusão. O status da Carga de devolução deve ser "[status permitido]" ou "[status permitido]"!
DRL‑002	O caminhão da Carga de devolução informada já foi pesado. Operação não permitida!

---