Carga de Entrada de Produto
Cadastro de Carga de Entrada de Produto
O endpoint PostAddProductEntrance é responsável pelo cadastro de uma carga de entrada de produtos de terceiros no sistema MIMS.
Como cadastrar uma carga de entrada de produtos de terceiros
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostAddProductEntrance |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostAddProductEntrance" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| BranchNo | String(25) | Sim | Código externo na filial |
| LoadNo | String(25) | Sim | Código externo da carga |
| LoadDate | DataHora | Sim | Data da carga |
| LoadMode | LoadMode | Sim | Enumerador com os possíveis valores para o Modo de carregamento: ImPurchase (Compra) ou ImTransfer (Transferência) |
| TransporterNo | String(25) | Sim | Código externo do transportador |
| DriverNo | String(25) | Sim | Código externo do motorista |
| LoadCreatedUserNo | String(25) | Sim | Código externo do usuário da criação da carga |
| VehiclePlateNo | String(8) | Sim | Placa do veículo |
| Notes | String(25) | Não | Observações |
| ProductEntranceList | AddProductEntrance | Sim | Lista com as entradas da carga |
📝 Objeto AddProductEntrance
O objeto AddProductEntrance representa uma entrada de produtos na carga.
Parâmetros de Entrada
Parâmetro Tipo Obrigatório Descrição PurchaseOrderNo String(25) Sim Código externo do pedido de compra no ERP PurchaseOrderDate DataHora Sim Data/hora da entrada SupplierNo String(25) Sim Código externo do fornecedor DocumentNo String(25) Não Documento DocumentTypeNo DocumentType Não Código do tipos de documento DocumentDate DataHora Não Data/hora da emissão do documento EntranceOrderNo Integer Não Número do pedido de entrada Notes String(25) Não Observações ProductEntranceItemList AddProductEntranceItem Sim Lista com os produtos da entrada
📝 Objeto AddProductEntranceItem
O objeto AddProductEntranceItem representa um item da entrada de produtos.
Parâmetros de Entrada
Parâmetro Tipo Obrigatório Descrição ProductNo String(25) Sim Código externo do produto da entrada WarehouseNo String(25) Sim Código externo do almoxarifado do material da entrada SupplierNo String(25) Sim Código externo do fornecedor CostCenterNo String(25) Não Código externo do centro de custo do material ProductSupplyContractNo String(25) Não Código externo do contrato de fornecimento de produtos Qty Float Sim Quantidade de caixas Weight Float Não Peso unitário da caixa ProductionDate DataHora Não Data de produção ExpirationDate DataHora Não Data de validade SupplierLotNo String(50) Sim Lote do fornecedor do produto UnitValue Float Sim Valor unitário do produto DiscountValue Float Não Valor de desconto do produto
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 |
| LoadProductEntranceCode | Integer | Sim | Código interno da carga de entrada de produtos gerado no sistema MIMS |
Exemplo de Request
POST http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/PostAddProductEntrance
Content-Type: application/json
{
"BranchNo": "BR001",
"LoadNo": "LOAD123",
"LoadDate": "2025-02-20T12:00:00Z",
"VehiclePlateNo": "ABC1234",
"LoadMode": "ImPurchase",
"TransporterNo": "TRANS001",
"DriverNo": "DRV001",
"LoadCreatedUserNo": "USER001",
"Notes": "Carga de produtos terceirizados",
"ProductEntranceList": [
{
"PurchaseOrderNo": "PO123",
"PurchaseOrderDate": "2025-02-20T10:00:00Z",
"SupplierNo": "SUP001",
"DocumentTypeNo": "Invoice",
"DocumentNo": "DOC123",
"DocumentDate": "2025-02-20T11:00:00Z",
"EntranceOrderNo": 1,
"Notes": "Entrada de produtos frescos",
"ProductEntranceItemList": [
{
"ProductNo": "PROD001",
"WarehouseNo": "WH001",
"SupplierNo": "SUP001",
"CostCenterNo": "CC001",
"ProductSupplyContractNo": "CONTRACT001",
"Qty": 100.0,
"Weight": 15.0,
"ProductionDate": "2025-02-20T09:00:00Z",
"ExpirationDate": "2025-08-20T23:59:59Z",
"SupplierLotNo": "LOT001",
"UnitValue": 25.50,
"DiscountValue": 2.50
}
]
}
]
}
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
},
"LoadProductEntranceCode": 789
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| ALP‑001 | Parâmetro Código Externo da Carga de Entrada de Produto (LoadProductEntranceNo) informado já existe! |
Exclusão de Carga de Entrada de Produto
O endpoint PostDeleteLoadProductEntrance deleta uma carga de entrada de produtos de terceiros.
Como excluir uma carga de entrada de produtos de terceiros
Request HTTP POST
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostDeleteLoadProductEntrance |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostDeleteLoadProductEntrance" |
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 na filial |
| 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 'http://localhost:8080/datasnap/rest/RESTWebServiceMethods/"PostDeleteLoadProductEntrance"' \
--header 'Content-Type: application/json' \
--data '{
"BranchNo": "101",
"LoadNo": "1133",
"ErrorIfNotFound": true
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| DLP‑001 | O status atual ("[status atual da carga]") da "LoadNo" não está disponível para exclusão. O status da carga deve ser "BQ" ou "AB"! |
| DLP‑002 | Não foi encontrado o "LoadNo" informado! |
| DLP‑003 | Exclusão não permitida para o "LoadNo" informado, pois há identificações vinculadas. |
| DLP‑004 | Exclusão não permitida para o "LoadNo" informado, pois há paletes vinculados. |
Fechar Carga de Entrada de Produto
O endpoint PostFinishLoadProductEntrance altera o status da carga com base nas validações dentro do método.
Como alterar o status da carga
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostFinishLoadProductEntrance |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostFinishLoadProductEntrance" |
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 |
| 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 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostFinishLoadProductEntrance"' \
--header 'Content-Type: application/json' \
--data '{
"LoadNo": "LOAD123",
"BranchNo": "BR001",
"ErrorIfNotFound": true
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| FLP‑001 | O status atual ("[status atual da carga]") da "LoadNo" informada não é permitido alterar. O status de carga deve ser "FE" ou "FD"! |