Carga

Descrição

O endpoint PostAddLoad cadastra uma nova carga no sistema MIMS e pode ser visualizado na tela TRP003.

---

Como cadastrar uma nova carga

Request HTTP Post

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

Parâmetros de Entrada

Parâmetro	Tipo	Obrigatório	Descrição
LoadNo	String(25)	Sim	Código externo da Carga
BranchNo	String(25)	Sim	Código externo da Filial
LoadDate	DataHora	Sim	Data do carregamento
RoutingDate	DataHora	Não	Data da montagem da carga
VehiclePlateNo	String(8)	Sim	Placa do veículo
Blocked	Boolean	Sim	Indica se a carga será criada com status bloqueado
Notes	String(2000)	Não	Observação
LoadType	LoadType	Sim	Enumerador com os possíveis valores para a Modalidade da Carga: ltTotalized (Totalizada), ltMixed (Mista) ou ltSalesOrder (Pedido de venda)
DispatchingDate	DataHora	Não	Data prevista para início de carregamento
DriverNo	String(25)	Sim	Código externo do Motorista
TransporterNo	String(25)	Sim	Código externo do Transportador
ShippingType	ShippingType	Não	Enumerador com os possíveis valores para o Tipo de carregamento: sptCarton (Caixa), sptPallet (Paletizado) ou sptMixed (Misto)
ContainerNo	String(25)	Não	Número do contêiner
LoadGroupNo	String(25)	Não	Código externo da carga agrupadora
IsLoadGroup	Boolean	Não	Flag que indica que a carga é uma carga agrupadora
IsDistributionCenterTransfer	Boolean	Não	Flag que indica que a carga é usada para transferência entre CDs
SalesOrderList	AddLoadSalesOrderItemList	Não	Lista com todos os códigos externos dos pedidos da carga
EffectedLoadDate	DataHora	Não	Data de efetivação da carga
EffectedLoadUserNo	String(25)	Não	Código Externo do Usuário da efetivação da carga
TransporterNotes	String(2000)	Não	Observação para o transportador
DistributionCenterNo	String(25)	Não	Código Externo do centro de distribuição da carga

📝 Objeto AddLoadSalesOrderItem

Descrição

O objeto AddLoadSalesOrderItem representa um pedido de venda da carga.

Parâmetros de Entrada

Nome	Tipo	Obrigatório	Descrição
SalesOrderNo	String(25)	Não	Código externo do pedido da carga
SalesOrderCode	Integer	Não	Código do pedido de venda

Observação

• O parâmetro SalesOrderList é obrigatório somente quando a carga não for do tipo agrupadora, ou seja, quando o parâmetro IsLoadGroup estiver definido como false.

---

Retorno

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

---

Exemplo de Request

POST http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/PostAddLoad
Content-Type: application/json

{
  "BranchNo": "BR001",
  "LoadDate": "2025-03-10T08:00:00Z",
  "RoutingDate": "2025-03-10T07:00:00Z",
  "VehiclePlateNo": "ABC1234",
  "Blocked": true,
  "Notes": "iTotalized",
  "LoadType": "Saída",
  "DriverNo": "DRV001",
  "TransporterNo": "TRP001",
  "ShippingType": "sptPallet",
  "ContainerNo": "CONT001",
  "LoadGroupNo": "LGR001",
  "IsLoadGroup": false,
  "SalesOrderList": [
    {
      "SalesOrderNo": "SO123",
      "SalesOrderCode": 456
    }
  ],
  "EffectedLoadDate": "2025-03-10T09:00:00Z",
  "EffectedLoadUserNo": "USR001"
}

---

Exemplo de Response

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

---

Exclusão de Carga

Descrição

O endpoint PostDeleteLoad é responsável por excluir uma carga no sistema MIMS.

---

Como excluir uma carga

Request HTTP Post

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

Parâmetros de Entrada

Nome	Tipo	Obrigatório	Descrição
LoadNo	String(25)	Sim	Código externo da Carga
BranchNo	String(25)	Sim	Código externo da Filial
ErrorIfNotFound	Boolean	Não	Retorna erro caso a carga informada não exista no banco de dados

---

Retorno

Nome	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}}/PostDeleteLoad' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
{
  "LoadNo": "LOAD12345",
  "BranchNo": "BR001",
  "ErrorIfNotFound": true
}

---

Exemplo de Response

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

---

Fechamento de Carga

Descrição

O endpoint PostLoadClosure é responsável por realizar o fechamento de uma carga no sistema MIMS.

---

Como fechar uma carga

Request HTTP Post

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

Parâmetros de Entrada

Nome	Tipo	Obrigatório	Descrição
LoadNo	String(25)	Sim	Código externo da Carga
BranchNo	String(25)	Sim	Código externo da Filial
VehicleTare	Float	Não	Tara do veículo
VehicleGrossWeight	Float	Não	Peso Bruto do Veículo
TruckArrivalDate	DataHora	Não	Data/hora da chegada do caminhão
TruckDepartureDate	DataHora	Não	Data/hora da saída do caminhão
MinTolerance	Float	Não	Tolerância Mínima
MaxTolerance	Float	Não	Tolerância Máxima
ReleaseUserNo	String(25)	Não	Usuário de liberação
ReleaseReason	String(50)	Não	Motivo da liberação

---

Retorno

Nome	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}}/PostLoadClosureoad' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
{
  "LoadNo": "LOAD12345",
  "BranchNo": "BR001",
  "VehicleTare": 15000.5,
  "VehicleGrossWeight": 25000.75,
  "TruckArrivalDate": "2025-02-07T08:30:00",
  "TruckDepartureDate": "2025-02-07T09:45:00",
  "MinTolerance": 50.0,
  "MaxTolerance": 200.0,
  "ReleaseUserNo": "USR001",
  "ReleaseReason": "Carga verificada e aprovada"
}

---

Exemplo de Response

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

---

Notas de Dev

• Certifique-se de que BranchNo, VehiclePlateNo, DriverNo, TransporterNo, SalesOrderNo (se aplicável), LoadGroupNo (se aplicável) e outros códigos externos sejam válidos e existentes no sistema MIMS.
• Os campos LoadDate, RoutingDate, e EffectedLoadDate devem estar no formato ISO 8601 (ex.: 2025-03-10T08:00:00Z).
• O campo Blocked determina se a carga será criada com status bloqueado.
• O campo Notes aceita valores como iTotalized (Totalizada), iMixed (Mista), iSalesOrder (Pedido de venda).
• O campo ShippingType aceita valores como sptCarton (Caixa), sptPallet (Paletizado), sptMixed (Misto).
• O campo IsLoadGroup, quando false, torna o campo SalesOrderList obrigatório.
• O campo LoadGroupNo deve ser informado se IsLoadGroup for true.