Carga de Devolução

Descrição

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

---

Como cadastrar uma nova 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 da montagem da carga.
TransporterNo	String(25)	Sim	Código Externo do Transportador.
VehiclePlateNo	String(8)	Sim	Placa do veículo.
ReplacedVehiclePlateNo	String(8)	Não	Placa do veículo substituto.
DriverNo	String(25)	Sim	Código Externo do Motorista.
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.

Objeto: AddLoadSalesOrderItem

Descrição: Representa um pedido de venda da carga de devolução.

Propriedades

Nome	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 --request POST '{{url_base}}/PostAddReturnOrderLoad' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
{
  "ReturnLoadNo": "RL12345",
  "BranchNo": "BR001",
  "ReturnLoadDate": "2025-02-01T08:00:00",
  "RoutingDate": "2025-02-02T10:00:00",
  "TransporterNo": "T001",
  "VehiclePlateNo": "XYZ1234",
  "ReplacedVehiclePlateNo": "ABC5678",
  "DriverNo": "D123",
  "DispatchingDate": "2025-02-03T06:30:00",
  "isBlocked": false,
  "Notes": "Carga retornando ao centro de distribuição.",
  "SalesReturnOrderList": [
    {
      "SalesReturnOrderNo": "SRO001"
    },
    {
      "SalesReturnOrderNo": "SRO002"
    }
  ]
}

---

Exemplo de Response

{
  "WebServiceReturn": {
    "Success": true,
    "Message": "Carga de devolução cadastrada com sucesso."
  },
  "ReturnLoadCode": 1001
}

---

Exclusão de Carga de Devolução

Descrição

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

---

Como excluir uma nova Linhagem

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 --request GET '{{url_base}}/PostDeleteReturnOrder' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
{
  "ReturnLoadNo": "RL12345",
  "BranchNo": "BR001",
  "ErrorIfNotFound": true
}

---

Exemplo de Response

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

---