Pular para o conteúdo principal

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çãoURL Exemplo
POST{{url_base}}/PostAddLoad
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddLoad"

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
LoadNoString(25)SimCódigo externo da carga
BranchNoString(25)SimCódigo externo da filial
LoadDateDataHoraSimData do carregamento
RoutingDateDataHoraNãoData/Hora da montagem da carga
DispatchingDateDataHoraNãoData prevista para início de carregamento
EffectedLoadDateDataHoraNãoData de efetivação da carga
BlockedBooleanSimIndica se a carga será criada com status bloqueado
VehiclePlateNoString(8)SimPlaca do veículo
DriverNoString(25)SimCódigo externo do motorista
TransporterNoString(25)SimCódigo externo do transportador
LoadTypeLoadTypeSimEnumerador com os possíveis valores para a Modalidade da Carga: ltTotalized (Totalizada), ltMixed (Mista) ou ltSalesOrder (Pedido de venda)
ShippingTypeShippingTypeNãoEnumerador com os possíveis valores para o Tipo de carregamento: sptCarton (Caixa), sptPallet (Paletizado) ou sptMixed (Misto)
ContainerNoString(25)NãoNúmero do contêiner
LoadGroupNoString(25)NãoCódigo externo da carga agrupadora
EffectedLoadUserNoString(25)NãoCódigo externo do usuário da efetivação da carga
DistributionCenterNoString(25)NãoCódigo externo do centro de distribuição da carga
IsLoadGroupBooleanNãoFlag que indica que a carga é uma carga agrupadora
IsDistributionCenterTransferBooleanNãoFlag que indica que a carga é usada para transferência entre CDs
NotesString(2000)NãoObservação
TransporterNotesString(2000)NãoObservação para o transportador
SalesOrderListAddLoadSalesOrderItemListNãoLista 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âmetro IsLoadGroup estiver definido como false.
  • O uso simultâneo dos parâmetros IsDistributionCenterTransfer e IsLoadGroup não é permitido (ver erro ALO-015).

📝 Objeto AddLoadSalesOrderItem​

O objeto AddLoadSalesOrderItem representa um pedido de venda da carga.

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
SalesOrderNoString(25)NãoCódigo externo do pedido de venda da carga
SalesOrderCodeIntegerNãoCódigo interno do pedido de venda da carga

Retorno​

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
LoadCodeIntegerSimCódigo interno da carga gerada no sistema MIMS

Tipos de carga no MIMS​

O método PostAddLoad permite cadastrar diferentes tipos de carga no MIMS:

→ Carga normal​

Utilizada para a expedição convencional de pedidos de venda destinados ao cliente final, representando o cenário mais comum de criação de cargas no sistema.

  • Informar pelo menos um pedido na propriedade SalesOrderList.
  • O parâmetro IsDistributionCenterTransfer e o parâmetro IsLoadGroup deve permanecer ausente ou com valor false.
  • O tipo da carga (parâmetro LoadType) pode variar conforme a regra de negócio da integração.

Exemplo de Request​

{
  "BranchNo": "0102",
  "LoadNo": "LOADTAGAT1",
  "LoadDate": "2026-07-21T00:00:00",
  "RoutingDate": "2026-07-21T00:00:00",
  "DispatchingDate": "2026-07-21T00:00:00",
  "VehiclePlateNo": "MFD0E98",
  "Blocked": false,
  "LoadType": "ltTotalized",
  "ShippingType": "sptCarton",
  "DriverNo": "1",
  "TransporterNo": "033818",
  "DistributionCenterNo": "0102",
  "SalesOrderList": [
    {
      "SalesOrderNo": "ABTMPY",
      "RecnoSC5": 6430995
    }
  ]
}

→ Cargas de transferência entre centros de distribuição​

  • Informar IsDistributionCenterTransfer como true, indicando que é uma carga de transferencia.
  • Informar o centro de distribuição de destino no parâmetro em DistributionCenterNo.
  • Informar o pedido em SalesOrderList — cargas de transferência aceitam apenas um pedido de venda (ver erro ALO-013).
  • O parâmetro IsLoadGroup deve permanecer ausente ou com valor false.
Observação

Quando a carga não estiver bloqueada (Blocked = false), é obrigatório informar DistributionCenterNo e devem existir configurações de transferência válidas.

Exemplo de Request​

{
  "BranchNo": "0102",
  "LoadNo": "LOADTAGAT2",
  "LoadDate": "2026-07-21T00:00:00",
  "RoutingDate": "2026-07-21T00:00:00",
  "DispatchingDate": "2026-07-21T00:00:00",
  "VehiclePlateNo": "UDV6D02",
  "Blocked": false,
  "LoadType": "ltSalesOrder",
  "ShippingType": "sptCarton",
  "DriverNo": "1",
  "TransporterNo": "002922",
  "IsDistributionCenterTransfer": true,
  "DistributionCenterNo": "0102",
  "SalesOrderList": [
    {
      "SalesOrderNo": "ABTSBH",
      "RecnoSC5": 6434851
    }
  ]
}

→ Carga agrupadora de outras cargas​

  • Informar IsLoadGroup como true, indicando que é uma carga agrupadora.
  • A propriedade SalesOrderList deve ser enviada vazia, pois uma carga agrupadora não possui pedidos vinculados diretamente, pois seu objetivo é agrupar outras cargas, e não conter pedidos.
  • O parâmetro IsDistributionCenterTransfer deve permanecer ausente ou com valor false.
Observação
  • O parâmetro LoadGroupNo é utilizado para vincular uma carga a uma carga agrupadora já existente. O processo de criação deve seguir a seguinte sequência:
  1. Criar a carga agrupadora, informando IsLoadGroup como true e enviando a propriedade SalesOrderList vazia, ou seja, sem pedidos.
  2. Criar as cargas que serão agrupadas, informando IsLoadGroup como false (ou omitindo esse parâmetro), preenchendo normalmente a propriedade SalesOrderList e informando o número da carga agrupadora no parâmetro LoadGroupNo. Dessa forma, cada carga criada será vinculada à carga agrupadora previamente cadastrada.

Exemplo de Request​

{
  "BranchNo": "0102",
  "LoadNo": "LOADTAGAT3",
  "LoadDate": "2026-07-19T00:00:00",
  "RoutingDate": "2026-07-20T00:00:00",
  "DispatchingDate": "2026-07-20T00:00:00",
  "VehiclePlateNo": "ATX4F98",
  "Blocked": false,
  "LoadType": "ltTotalized",
  "ShippingType": "sptCarton",
  "DriverNo": "1",
  "TransporterNo": "033751",
  "SalesOrderList": [],
  "DistributionCenterNo": "0102",
  "IsLoadGroup": true
}

Exemplo de Response​

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

🐞 Possíveis Erros​

CódigoMensagem
ALO‑001Parâmetro Código Externo da Carga (LoadNo) informado já existe!
ALO‑002Erro ao gerar a programação do caminhão!
ALO‑003Erro ao gerar o item da programação do caminhão!
ALO‑004O 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‑005O Código Externo da Carga Agrupada(LoadGroupNo) não pertence a uma Carga Agrupada. Processo Abortado!
ALO‑006Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] pertence a uma carga diferente. Processo Abortado!
ALO‑007Pedido 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‑008Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] está bloqueado. Operação não permitida!
ALO‑009O 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‑010Parâmetro Código Externo do Transportador (TransporterNo) pertence a um fornecedor que não é do tipo "Transportador". Operação não permitida!
ALO‑011Se for uma carga agrupadora, o parâmetro "LoadGroupNo" não deve ser informado. Processo Abortado!
ALO‑012Pedido de Venda "[valor enviado na requisição]" informado no índice [[código do índice]] não foi encontrado!
ALO‑013As cargas de transferência entre centros de distribuição não podem conter mais de um pedido de venda!
ALO‑014A carga foi informada como transferência (parâmetro IsDistributionCenterTransfer), porém, não foram encontradas configurações de transferência. Processo Abortado!
ALO‑015Uma carga de transferência (parâmetro IsDistributionCenterTransfer) não pode ser simultaneamente uma carga agrupadora (parâmetro IsLoadGroup)!
ALO‑016O almoxarifado de origem não pode ser o mesmo que o almoxarifado de destino em cargas de transferência. Processo abortado!
ALO‑017A placa do veículo informada ("VehiclePlateNo") deve conter apenas letras e números. Verifique o formato da placa!


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çãoURL Exemplo
POST{{url_base}}/PostDeleteLoad
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteLoad"

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
LoadNoString(25)SimCódigo externo da carga
BranchNoString(25)SimCódigo externo da filial
NotVerifyTruckWeighedBooleanNãoFlag que indica se a verificação do registro de pesagem do caminhão deve ser ignorada
ErrorIfNotFoundBooleanNãoRetorna erro caso a carga informada não exista no banco de dados

Retorno​

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformaçõ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ódigoMensagem
DLO‑001Parâmetro Código Externo da Carga (LoadNo) é referente a uma Carga Agrupada e está relacionada com outras Cargas. Processo Abortado!
DLO‑002O 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‑003Existe um mapa de carregamento para a Carga informada. Operação não permitida!
DLO‑004O caminhão da Carga informada já foi pesado. Operação não permitida!
DLO‑005O "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çãoURL Exemplo
POST{{url_base}}/PostLoadClosure
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostLoadClosure"

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
LoadNoString(25)SimCódigo externo da carga
BranchNoString(25)SimCódigo externo da filial
VehicleTareFloatNãoTara do veículo
VehicleGrossWeightFloatNãoPeso bruto do veículo
TruckArrivalDateDataHoraNãoData/hora da chegada do caminhão
TruckDepartureDateDataHoraNãoData/hora da saída do caminhão
MinToleranceFloatNãoTolerância mínima
MaxToleranceFloatNãoTolerância máxima
ReleaseUserNoString(25)NãoUsuário de liberação
ReleaseReasonString(50)NãoMotivo da liberação

Retorno​

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformaçõ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ódigoMensagem
LDC‑001O 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‑002Parâ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çãoURL Exemplo
POST{{url_base}}/PostLoadReopening
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostLoadReopening"

Parâmetros de Entrada​

ParâmetroTipoObrigatórioDescrição
LoadNoString(25)SimCódigo externo da carga
BranchNoString(25)SimCódigo externo da filial
ErrorIfNotClosedBooleanNãoRetorna erro caso a carga informada não esteja finalizada e tenha sido enviada ao ERP

Retorno​

ParâmetroTipoObrigatórioDescrição
WebServiceReturnWebServiceReturnSimInformaçõ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ódigoMensagem
LRP‑001O status atual da Carga informada ("[valor enviado na requisição]") não está disponível para reabertura. O status da Carga deve ser "Fechada"!