Carga
Cadastro de Carga
O endpoint PostAddLoad cadastra uma nova carga no sistema MIMS e pode ser visualizado na tela TRP003.
Como cadastrar uma 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/Hora da montagem da carga |
| DispatchingDate | DataHora | Não | Data prevista para início de carregamento |
| EffectedLoadDate | DataHora | Não | Data de efetivação da carga |
| Blocked | Boolean | Sim | Indica se a carga será criada com status bloqueado |
| VehiclePlateNo | String(8) | Sim | Placa do veículo |
| DriverNo | String(25) | Sim | Código externo do motorista |
| TransporterNo | String(25) | Sim | Código externo do transportador |
| LoadType | LoadType | Sim | Enumerador com os possíveis valores para a Modalidade da Carga: ltTotalized (Totalizada), ltMixed (Mista) ou ltSalesOrder (Pedido de venda) |
| 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 |
| EffectedLoadUserNo | String(25) | Não | Código externo do usuário da efetivação da carga |
| DistributionCenterNo | String(25) | Não | Código externo do centro de distribuição da carga |
| 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 |
| Notes | String(2000) | Não | Observação |
| TransporterNotes | String(2000) | Não | Observação para o transportador |
| SalesOrderList | AddLoadSalesOrderItemList | Não | Lista com todos os códigos externos dos pedidos da carga |
Observação
- O parâmetro
SalesOrderListé obrigatório somente quando a carga não for do tipo agrupadora, ou seja, quando o parâmetroIsLoadGroupestiver definido como false.
📝 Objeto AddLoadSalesOrderItem
O objeto AddLoadSalesOrderItem representa um pedido de venda da carga.
Parâmetros de Entrada
Parâmetro Tipo Obrigatório Descrição SalesOrderNo String(25) Não Código externo do pedido de venda da carga SalesOrderCode Integer Não Código interno do pedido de venda da carga
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 |
| LoadCode | Integer | Sim | Código interno da carga gerada no sistema MIMS |
Exemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/PostAddLoad' \
--header 'Content-Type: application/json' \
--data-raw '{
"BranchNo": "BR001",
"LoadDate": "2025-03-10T08:00:00Z",
"RoutingDate": "2025-03-10T07:00:00Z",
"VehiclePlateNo": "ABC1234",
"Blocked": true,
"Notes": "Carga de exemplo",
"LoadType": "ltTotalized",
"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
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| ALO‑001 | Parâmetro Código Externo da Carga (LoadNo) informado já existe! |
| ALO‑002 | Erro ao gerar a programação do caminhão! |
| ALO‑003 | Erro ao gerar o item da programação do caminhão! |
| ALO‑004 | O status da Carga Agrupada (LoadGroupNo) informada ("[status da carga enviada na requisição]") não está disponível. O status da Carga Agrupada deve ser "Aberta" ou "Bloqueada"! |
| ALO‑005 | O Código Externo da Carga Agrupada(LoadGroupNo) não pertence a uma Carga Agrupada. Processo Abortado! |
| ALO‑006 | Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] pertence a uma carga diferente. Processo Abortado! |
| ALO‑007 | Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] é um pedido de venda direta. Operação não permitida! |
| ALO‑008 | Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] está bloqueado. Operação não permitida! |
| ALO‑009 | O status Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] ("[status do pedido de venda vinculado]") não está disponível para carregamento. Processo Abortado! |
| ALO‑010 | Parâmetro Código Externo do Transportador (TransporterNo) pertence a um fornecedor que não é do tipo "Transportador". Operação não permitida! |
| ALO‑011 | Se for uma carga agrupadora, o parâmetro "LoadGroupNo" não deve ser informado. Processo Abortado! |
| ALO‑012 | Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] não foi encontrado! |
| ALO‑013 | As cargas de transferência entre centros de distribuição não podem conter mais de um pedido de venda! |
| ALO‑014 | A carga foi informada como transferência (parâmetro IsDistributionCenterTransfer), porém, não foram encontradas configurações de transferência. Processo Abortado! |
| ALO‑015 | Uma carga de transferência (parâmetro IsDistributionCenterTransfer) não pode ser simultaneamente uma carga agrupadora (parâmetro IsLoadGroup)! |
| ALO‑016 | O almoxarifado de origem não pode ser o mesmo que o almoxarifado de destino em cargas de transferência. Processo abortado! |
Exclusão de Carga
O endpoint PostDeleteLoad é responsável por executar a exclusão de 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
| 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 |
| NotVerifyTruckWeighed | Boolean | Não | Flag que indica se a verificação do registro de pesagem do caminhão deve ser ignorada |
| ErrorIfNotFound | Boolean | Não | Retorna erro caso a carga 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 POST 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/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
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| DLO‑001 | Parâmetro Código Externo da Carga (LoadNo) é referente a uma Carga Agrupada e está relacionada com outras Cargas. Processo Abortado! |
| DLO‑002 | O status atual da Carga informada ("[valor enviado na requisição]") não está disponível para exclusão!. O status da Carga deve ser "Aberta" ou "Bloqueada"! |
| DLO‑003 | Existe um mapa de carregamento para a Carga informada. Operação não permitida! |
| DLO‑004 | O caminhão da Carga informada já foi pesado. Operação não permitida! |
| DLO‑005 | O "LoadNo" informado está bloqueado para a equipe de logística. Operação não permitida! |
Fechamento de Carga
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/"PostLoadClosure" |
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 |
| 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
| 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 POST 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/PostLoadClosure' \
--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
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| LDC‑001 | O status atual da Carga informada ("[valor enviado na requisição]") não está disponível para fechamento. O status da Carga deve ser "Aguardando Pesagem" ou "Fechada"! |
| LDC‑002 | Parâmetro Código Externo da Carga (LoadNo) é referente a uma Carga Agrupada, entretanto uma ou mais Cargas ainda não estão fechadas. Operação não permitida! |
Reabertura / Recomposição de Carga
O endpoint PostLoadReopening permite a reabertura (recomposição) de uma carga já fechada e enviada ao ERP.
Como realizar a reabertura / recomposição de uma carga
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostLoadReopening |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostLoadReopening" |
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 |
| ErrorIfNotClosed | Boolean | Não | Retorna erro caso a carga informada não esteja finalizada e tenha sido enviada ao ERP |
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/"PostLoadReopening"' \
--header 'Content-Type: application/json' \
--data '{
"LoadNo": "LOAD12345",
"BranchNo": "BR001",
"ErrorIfNotClosed": true
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| LRP‑001 | O status atual da Carga informada ("[valor enviado na requisição]") não está disponível para reabertura. O status da Carga deve ser "Fechada"! |