PlantScanner
Home
Sobre a PlantScanner
Home
Sobre a PlantScanner
  1. Ordens de Produção
  • Default module
    • Developers
    • O que são as propriedades?
    • Documentação de endpoints - PlantScanner
    • SKUs e Insumos
      • SKUs e Insumos
      • Gets all materials.
      • Synchronize materials batch between customer ERP and PlantScanner bases.
    • Ordens de Produção
      • Ordens de Produção ( Ordens de Trabalho )
      • (GraphQL) Get work orders
        POST
      • Gets work orders that have been planned or executed between the specified dates or by the work order code.
        GET
      • Gets work orders that with production details
        GET
      • Synchronize work orders batch between customer ERP and PlantScanner bases.
        POST
      • Synchronize work orders batch current execution.
        POST
      • Synchronize work order properties data
        POST
      • Synchronize work orders batch planning dates.
        POST
    • Estoque
      • Estoque
      • Synchronize materials inventories between customer ERP and PlantScanner bases.
    • Alertas de Produção
      • Alertas de Produção
      • Synchronize work orders batch between customer ERP and PlantScanner bases.
    • Tempos de Mão de Obra
      • Tempos de Mão de Obra
      • Get employee logged hours with work order info if one was in execution.
    • Inspeções de Qualidade
      • Inspeções de Qualidade
      • Gets inspections that have been planned or executed between the specified dates or by the work order code.
      • Synchronize inspections batch between customer ERP and PlantScanner bases.
      • Synchronize inspections batch current execution.
      • Synchronize work order properties data
    • SKUs e Templates de Produção
      • Lista os processos vinculados a um determinado Process Execution Template.
      • Vincula, em lote, um ou mais processos a um ou mais Process Execution Templates.
      • Remove, em lote, o vínculo entre processos e um ou mais Process Execution Templates.
    • Processos de Inspeção
      • Processos de Inspeção
      • Gets all inspections processes
      • Synchronize inspection processes batch between customer ERP and PlantScanner bases.
    • Listas de Qualidade
      • Listas de Qualidade
      • Gets work orders checks that have been planned or executed between the specified dates or by the work order code.
    • Lotes Consumidos
      • Lotes Consumidos
      • Synchronize work orders batch between customer ERP and PlantScanner bases.
      • Sync consumed raw material quantity based on updated quantity in work order.
    • Histórico de Ordens
      • Synchronize work orders batch between customer ERP and PlantScanner bases.
    • Estações de Trabalho
      • Estações de Trabalho
      • Gets work stations with shifts and area.
    • Esquemas
      • Schemas
      • RequestBodies
        • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_SyncWorkOrdersRuntimeRequestArray
      • PlantScanner.API.Application.Boundaries.GetAlerts_ResultWorkOrderStatus
      • PlantScanner.API.Application.Boundaries.GetAlerts_ResultWorkOrder
      • PlantScanner.API.Application.Boundaries.GetAlerts_ResultWorkStation
      • PlantScanner.API.Application.Boundaries.GetAlerts_ResultAlertType
      • PlantScanner.API.Application.Boundaries.GetAlerts_ResultAlertStatus
      • System_TimeSpan
      • PlantScanner.API.Application.Boundaries.GetAlerts_ResultAlert
      • PlantScanner.API.WebApi.Dtos.V1.GetAlerts_GetAlertsResponse
      • PlantScanner.API.WebApi.Dtos.Errors_ValidationError
      • PlantScanner.API.WebApi.Dtos.Errors_InternalServerError
      • PlantScanner.API.WebApi.Dtos.Errors_ToManyRequestsError
      • PlantScanner.API.Application.Boundaries.GetEmployeeHours_ResultEmployee
      • PlantScanner.API.Application.Boundaries.GetEmployeeHours_ResultWorkOrder
      • PlantScanner.API.Application.Boundaries.GetEmployeeHours_ResultWorkStation
      • PlantScanner.API.Application.Boundaries.GetEmployeeHours_ResultEmployeeHour
      • PlantScanner.API.WebApi.Dtos.v1.GetEmployeeHours_GetEmployeeHoursResponse
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultWorkOrderType
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultWorkOrderStatus
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultArea
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultWorkStation
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultEmployee
      • PlantScanner.Domain.Model_WorkOrderProperties
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultWorkOrder
      • PlantScanner.API.WebApi.Dtos.V1.GetWorkOrders_GetWorkOrdersResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncWorkOrderProperties
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncInspectionsRequestInnerWorkOrderDetails
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncInspectionsRequest
      • PlantScanner.API.Application.Boundaries_AffectedItemsStatistics
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncWorkOrdersResponse
      • PlantScanner.API.Application.Boundaries_FailedItemDescription
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncWorkOrdersPartialSuccessResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_MachineIntegrationPauseDto
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_SyncWorkOrdersRuntimeRequest
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_MachineIntegration
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_CurrentWorkStation
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_SyncWorkOrdersRuntimeResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_SyncWorkOrderProperties
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_SyncWorkOrderPropertiesRequest
      • PlantScanner.API.Application.Boundaries.GetMaterials_ResultInspection
      • PlantScanner.API.WebApi.Dtos.v1.GetWorkOrdersChecks_GetInspectionsProcessesResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterials_SyncInspectionProcessRequestInnerMaterial
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterials_SyncInspectionProcessRequest
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterials_SyncMaterialsResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterials_SyncMaterialsPartialSuccessResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterialInventories_SyncMaterialInventoriesRequestInnerInventory
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterialInventories_SyncMaterialInventoriesRequestInnerMaterialInventory
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterialInventories_SyncMaterialInventoriesRequest
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterialInventories_SyncMaterialInventoriesResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterialInventories_SyncMaterialInventoriesPartialSuccessResponse
      • PlantScanner.API.Application.Boundaries.GetMaterials_ResultProcess
      • PlantScanner.API.Application.Boundaries.GetMaterials_ResultMaterial
      • PlantScanner.API.WebApi.Dtos.v1.GetWorkOrdersChecks_GetMaterialsResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterials_SyncMaterialsRequestInnerMaterial
      • PlantScanner.API.WebApi.Dtos.V1.SyncMaterials_SyncMaterialsRequest
      • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultProgrammedStoppageStatus
      • PlantScanner.API.WebApi.Dtos.v1.ProcessExecutionTemplateProcesses_ProcessExecutionTemplateProcessLinkResponse
      • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultArea
      • PlantScanner.API.WebApi.Dtos.v1.ProcessExecutionTemplateProcesses_GetProcessExecutionTemplateProcessesResponse
      • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultWorkStation
      • Microsoft.AspNetCore.Mvc_ProblemDetails
      • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultEmployee
      • PlantScanner.API.WebApi.Dtos.v1.ProcessExecutionTemplateProcesses_ProcessExecutionTemplateProcessLinkRequest
      • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultProgrammedStoppageTemaplate
      • PlantScanner.API.WebApi.Dtos.v1.ProcessExecutionTemplateProcesses_ProcessExecutionTemplateProcessBatchRequest
      • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultProgrammedStoppage
      • PlantScanner.API.WebApi.Dtos.v1.ProcessExecutionTemplateProcesses_ProcessExecutionTemplateProcessItemResult
      • PlantScanner.API.WebApi.Dtos.V1.GetProgrammedStoppages_GetProgrammedStoppagesResponse
      • PlantScanner.API.WebApi.Dtos.v1.ProcessExecutionTemplateProcesses_ProcessExecutionTemplateProcessBatchResponse
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultProducedQuantityLog
      • PlantScanner.API.Application.Boundaries.GetWorkOrders_ResultWorkOrderProduction
      • PlantScanner.API.WebApi.Dtos.V1.GetWorkOrders_GetWorkOrdersProductionResponse
      • PlantScanner.API.Application.Boundaries.SyncWorkOrders_WorkOrderToSyncStatus
      • PlantScanner.API.Application.Boundaries.SyncWorkOrders_ConsumedRawMaterialToSync
      • PlantScanner.API.Application.Boundaries.SyncWorkOrders_RawMaterialToSync
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncWorkOrdersRequestInnerWorkOrder
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncWorkOrdersRequestInnerWorkOrderDetails
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrders_SyncWorkOrdersRequest
      • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersPlanning_SyncWorkOrdersPlanningRequest
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrderType
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrderStatus
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrderQualityCheckResponse
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrderQualityCheckQuestion
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrderQualityCheckQuestionGroup
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrderQualityCheck
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrderProcessChecks
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersChecks_ResultWorkOrder
      • PlantScanner.API.WebApi.Dtos.v1.GetWorkOrdersChecks_GetWorkOrdersChecksResponse
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersConsumedRawMaterials_ResultWorkOrderType
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersConsumedRawMaterials_ResultWorkOrderStatus
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersConsumedRawMaterials_ResultConsumedRawMaterial
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersConsumedRawMaterials_ResultRawMaterial
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersConsumedRawMaterials_ResultWorkOrder
      • PlantScanner.API.WebApi.Dtos.V1.GetWorkOrdersConsumedRawMaterials_GetWorkOrdersConsumedRawMaterialsResponse
      • PlantScanner.API.WebApi.Dtos.V1.SyncConsumedRawMaterial_ConsumedRawMaterialRequest
      • PlantScanner.API.WebApi.Dtos.V1.SyncConsumedRawMaterial_SyncConsumedRawMaterialRequest
      • PlantScanner.API.WebApi.Dtos.V1.SyncConsumedRawMaterial_SyncConsumedRawMaterialResponse
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersHistory_ResultWorkOrderType
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersHistory_ResultWorkOrderStatus
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersHistory_ResultWorkStation
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersHistory_ResultEmployee
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersHistory_ResultWorkOrderRuntime
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersHistory_ResultWorkOrderPlanningHistory
      • PlantScanner.API.Application.Boundaries.GetWorkOrdersHistory_ResultWorkOrderHistory
      • PlantScanner.API.WebApi.Dtos.V1.GetWorkOrdersHistory_GetWorkOrdersHistoryResponse
      • PlantScanner.API.Application.Boundaries.GetWorkStations_ResultArea
      • PlantScanner.API.Application.Boundaries.GetWorkStations_ResultInterval
      • PlantScanner.API.Application.Boundaries.GetWorkStations_ResultShift
      • PlantScanner.API.Application.Boundaries.GetWorkStations_ResultWorkStation
      • PlantScanner.API.WebApi.Dtos.V1.GetWorkOrders_GetWorkStationsResponse
      • PlantScanner.API.WebApi.Dtos.Hooks_ConsumedRawMaterialDetailHookDto
      • PlantScanner.API.WebApi.Dtos.Hooks_RawMaterialHookDto
      • PlantScanner.API.WebApi.Dtos.Hooks_WorkOrderDto
      • PlantScanner.Domain.Enum_HookTypeEnum
      • PlantScanner.API.WebApi.Dtos.Hooks_WorkOrderHookDto
      • PlantScanner.API.WebApi.Dtos.Hooks_MaterialSupplyHookDto
      • PlantScanner.API.WebApi.Dtos.Hooks_MaterialSupplyPayedHook
      • PlantScanner.API.WebApi.Dtos.Hooks_WorkOrderExecutionError
      • PlantScanner.API.WebApi.Dtos.Hooks_WorkOrderExecutionErrorsResponse
      • PlantScanner.API.WebApi.Dtos.Hooks_ProductionAlertDto
      • PlantScanner.API.WebApi.Dtos.Hooks_ProductionAlertHookDto
  • Consistem ERP API — Itens + PPCP Padrão v1.0
    • Itens Genéricos
      • Cadastros genericos - Empresas
      • Obter listagem de Itens Genéricos
      • Cadastrar um Item Genérico
      • Duplicar um Item Genérico
      • Obter um Item Genérico específico
    • Engenharia
      • Obter Engenharia (roteiro/BOM)
      • Obter itens alternativos para componente
      • Cadastrar itens alternativos para componente
      • Obter anexo da engenharia por revisão
      • Adicionar anexos da engenharia
      • Excluir anexos da engenharia
    • Ordem de Fabricação
      • Obter listagem de ordens de fabricação
      • Cadastrar uma ordem de fabricação
      • Obter uma ordem de fabricação específica
      • Atualizar uma ordem de fabricação
      • Excluir uma ordem de fabricação
      • Liberar uma OF bloqueada
      • Cancelamento de ordem de fabricação
      • Estornar uma ordem de fabricação
    • Processos da OF
      • Obter manutenção de processos da OF
      • Alterar manutenção de processos da OF
      • Incluir manutenção de processos da OF
      • Remover manutenção de processos da OF
    • Insumos da OF
      • Obter listagem de insumos da ordem de fabricação
      • Alterar insumo da ordem de fabricação
      • Cadastrar insumo da ordem de fabricação
      • Excluir insumo da ordem de fabricação
    • Lançamentos de OF
      • Decompor código de barras em OF, lote e sequência operacional
      • Abertura de lançamento de OF com código de barras
      • Fechamento de lançamento de OF com código de barras
      • Estornar ordem de fabricação (lançamento)
      • Excluir um lançamento de ordem de fabricação
      • Abertura de paralisação de OF com código de barras
      • Fechamento de paralisação de OF com código de barras
      • Abertura de paralisação de máquina ou linha
      • Fechamento de paralisação de máquina ou linha
    • Esquemas
      • Erro
      • ErroResponse
      • DadosCustomizados
      • Mascara
      • DadosItensClientes
      • DadosSaida
      • DadosEntrada
      • DadosTecnicosItem
      • FornecedorHomologado
      • DadosQualidade
      • ItemFilho
      • AnexoItem
      • SaldoEstoque
      • ListaClassificacoesInsumos
      • ItemGenerico
      • ItemGenericoPut
      • DuplicarItemGenericoPut
      • ListaItemGenerico
      • EngenhariaComponente
      • EngenhariaOperacao
      • Engenharia
      • ItemAlternativo
      • ItensAlternativosResponse
      • AlternativosPut
      • AnexoEngenhariaResponse
      • OrdemFabricacaoLote
      • DadosLote
      • InsumoGet
      • PendenciaInsumoPut
      • ListaInsumosGet
      • ManutencaoProcessoOF
      • ProcessosOFRequest
      • ProcessosOFResponse
      • OrdemFabricacao
      • OrdemFabricacaoPut
      • OrdemFabricacaoPost
      • ListaOrdemFabricacao
      • LiberarPut
      • CancelamentoPost
      • EstornoPost
      • DecomporCodigoBarrasResponse
      • OperadorProprio
      • OperadorTerceirizado
      • AberturaLancamentoOFRequest
      • LancamentoOFResponse
      • LancamentoNaoConformidade
      • LancamentoSubproduto
      • LancamentoTagOF
      • FechamentoLancamentoOFRequest
      • AberturaParalisacaoOFRequest
      • FechamentoParalisacaoOFRequest
      • AberturaParalisacaoMaquinaLinhaRequest
      • FechamentoParalisacaoMaquinaLinhaRequest
      • ParalisacaoMaquinaLinhaResponse
  • TOTVS Brassuco — totvsproducao (HML) — leituras
    • 01 - Ordens de Produção
      • Listar OPs por data de emissão
      • Buscar OP por número
    • 02 - Itens (SKU)
      • Listar itens por data de implantação
      • Buscar item por código
    • 03 - Estoque (consulta via POST)
      • Consultar saldos por itens
    • 99 - Validações de comportamento
      • OP inexistente (espera encontrouOrdem=false)
      • Item inexistente (espera itens=[])
      • OP sem dataInicial (espera 400 / 17006)
      • OP com data ISO YYYY-MM-DD (conversão de hífen)
      • Estoque com lista vazia (espera erro)
  1. Ordens de Produção

Ordens de Produção ( Ordens de Trabalho )

Ordem de Produção no PlantScanner#

A ordem de produção é o elemento central do controle produtivo no PlantScanner. Ela representa a solicitação formal para produzir um determinado SKU, especificando insumos, quantidades, status e propriedades customizadas.

Principais campos de uma ordem de produção#

code: Código único da ordem de produção.
status: Situação atual da ordem (ex: ReadyToExecute, WaitingForMaterialsReservation, Executed, Cancelled).
operationCode: Dentro do objeto work order details, quando enviado várias work orders é necessário o código da operação. A operação é a sequência que aquela ordem irá fazer para chegar até o produto final. Geralmente é usado quando a ordem passa por diferentes estações de trabalho (ex: MASSA, FORNO, EMBALAGEM) nesse exemplo seriam geradas três ordens de produção e cada uma teria seu apontamento individualizado.
note: Observações ou instruções gerais da ordem.
requestedQuantity: Quantidade planejada para produção.
producedGoodQuantity: Quantidade já produzida.
properties: Lista de propriedades customizadas (ver Propriedades).
materials: Lista de insumos e SKUs envolvidos na ordem. Cada material pode conter lotes consumidos (consumedRawMaterials).

Exemplo de payload de ordem de produção#

{
    "workOrderDetails": [
        {
            "code": "000001",
            "customer": "Cliente",
            "promiseDate": "2025-02-05",
            "workOrders": [
                {
                    "status": "ReadyToExecute",
                    "note": "Ordem de produção para apresentação",
                    "requestedQuantity": 43,
                    "operationCode": "MASSA",
                    "producedGoodQuantity": 2,
                    "properties": [
                        {
                            "key": "BTN:Botao-Alerta",
                            "value": "<button onclick=\"alert('Javascript executado.')\">Botão</button>",
                            "name": "Botão customizado de ação"
                        },
                        {
                            "key": "TXT:Texto-Auxiliar",
                            "value": "Clique no botão em necessidade de ajuda",
                            "name": "Ajuda"
                        }
                    ],
                    "materials": [
                        {
                            "code": "SKU001",
                            "quanitity": 200,
                            "sequence": 0 // Etapa que deve ser consumido
                        },
                        {
                            "code": "INS001",
                            "quantity": 50,
                            "sequence": 1,
                            "consumedRawMaterials": [
                                {
                                    "quantity": 30,
                                    "serialNumber": "LT001"
                                },
                                {
                                    "quantity": 20,
                                    "serialNumber": "LT002"
                                }
                            ]
                        },
                        {
                            "code": "INS001",
                            "quantity": 50,
                            "sequence": 1,
                            "isReadOnly": true // Em caso de material baixa por explosão
                        },
                        {
                            "code": "INS001",
                            "quantity": 50,
                            "sequence": 1,
                            "hasBatch": false // Em caso de materiais que não possuem lote para apontamento
                        }
                    ]
                },
                {
                    "status": "ReadyToExecute",
                    "note": "Ordem de produção para apresentação",
                    "requestedQuantity": 1,
                    "operationCode": "FORNO"
                }
            ]
        }
    ]
}

Observações#

A ordem de produção pode conter diversas propriedades para customização da interface e lógica de produção.
Os materiais associados podem ser tanto SKUs (produto a ser produzido) quanto insumos (materiais consumidos).
O campo consumedRawMaterials dentro de um insumo representa os lotes de insumo reservado para aquela ordem. Cada item contém a quantidade e o número de série/lote do insumo utilizado.
O status da ordem determina as ações disponíveis para o operador.
Para mais detalhes sobre propriedades, consulte a página Propriedades
Modificado em 2025-10-16 19:25:40
Página anterior
Synchronize materials batch between customer ERP and PlantScanner bases.
Próxima página
(GraphQL) Get work orders
Built with