PlantScanner
Home
Sobre a PlantScanner
Home
Sobre a PlantScanner
  1. Home
  • Developers
  • O que são as propriedades?
  • Documentação de endpoints - PlantScanner
  • SKUs e Insumos
    • SKUs e Insumos
    • Gets all materials.
      GET
    • Synchronize materials batch between customer ERP and PlantScanner bases.
      POST
  • Ordens de Produção
    • Ordens de Produção ( Ordens de Trabalho )
    • 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.
      POST
  • Alertas de Produção
    • Alertas de Produção
    • Synchronize work orders batch between customer ERP and PlantScanner bases.
      GET
  • 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.
      GET
  • 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.
      GET
    • Synchronize inspections batch between customer ERP and PlantScanner bases.
      POST
    • Synchronize inspections batch current execution.
      POST
    • Synchronize work order properties data
      POST
  • 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.Application.Boundaries.GetAlerts_ResultWorkOrderStatus
    • PlantScanner.API.WebApi.Dtos.V1.SyncWorkOrdersRuntime_SyncWorkOrdersRuntimeRequestArray
    • 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.Application.Boundaries.GetProgrammedStoppages_ResultArea
    • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultWorkStation
    • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultEmployee
    • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultProgrammedStoppageTemaplate
    • PlantScanner.API.Application.Boundaries.GetProgrammedStoppages_ResultProgrammedStoppage
    • PlantScanner.API.WebApi.Dtos.V1.GetProgrammedStoppages_GetProgrammedStoppagesResponse
    • 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
Home
Sobre a PlantScanner
Home
Sobre a PlantScanner
  1. Home

Documentação de endpoints - PlantScanner

Documentação de Integração de API#

Este documento descreve os endpoints e payloads necessários para a integração de dados.

1. Sincronização de Materiais (Produtos Acabados)#

Este endpoint é utilizado para sincronizar SKUs e itens que serão produzidos.
Endpoint: /api/v1/Materials/synchronize
Método: POST

Exemplo de Payload#

{
  "materials": [
    {
      "code": "31-02339",
      "description": "CIF CREM ORIG 12X450ML",
      "unitOfMeasure": "UN",
      "baseQuantity": 1,
      "group": "UNILEVER",
      "operationCode": "ENVASE",
      "appliedDirectLabor": "01:00:00",
      "appliedDirectMachine": "00:00:00",
      "workStationCodes": [
        "ENHL0007",
        "ENHL0003"
      ]
    },
    {
      "code": "31-02338",
      "description": "CIF CREM ORIG 12X450ML",
      "unitOfMeasure": "UN",
      "baseQuantity": 1,
      "group": "UNILEVER",
      "operationCode": "ENVASE",
      "appliedDirectLabor": "00:02:00",
      "appliedDirectMachine": "00:00:00",
      "workStationCodes": [
        "ENHL0007",
        "ENHL0003"
      ]
    }
  ]
}

2. Sincronização de Matérias-Primas#

Utiliza o mesmo endpoint de sincronização de materiais, mas com uma estrutura de propriedades reduzida para itens que são consumidos (insumos).
Endpoint: /api/v1/Materials/synchronize
Método: POST

Exemplo de Payload#

{
  "materials": [
    {
      "code": "62-01060",
      "description": "LAS 96% MIX",
      "unitOfMeasure": "KG"
    },
    {
      "code": "62-01073",
      "description": "Soda Rayon",
      "unitOfMeasure": "KG"
    },
    {
      "code": "13-00822",
      "description": "Água Desmi",
      "unitOfMeasure": "KG"
    }
  ]
}

3. Sincronização de Ordens de Produção#

Este endpoint é responsável por enviar as ordens de produção, incluindo detalhes de execução, materiais consumidos e lotes.
Endpoint: /api/v1/WorkOrders/synchronize
Método: POST

Exemplo de Payload#

{
  "workOrdersDetails": [
    {
      "materialCode": "51-01602",
      "code": "1364378293",
      "workOrders": [
        {
          "status": "ReadyToExecute",
          "operationCode": "PRE-MIXER",
          "note": "string",
          "requestedQuantity": 9707,
          "producedGoodQuantity": 9700,
          "properties": [],
          "materials": [
            {
              "code": "13-00822",
              "sequence": 1,
              "quantity": 1972,
              "isReadOnly": true,
              "hasBatch": true,
              "consumedRawMaterials": [
                {
                  "quantity": 1972,
                  "serialNumber": "13-00822-00000001"
                }
              ]
            },
            {
              "code": "62-01060",
              "sequence": 2,
              "quantity": 7735,
              "isReadOnly": true,
              "hasBatch": true,
              "consumedRawMaterials": [
                {
                  "quantity": 7735,
                  "serialNumber": "62-01060-00000001"
                }
              ]
            }
          ]
        },
        {
          "status": "ReadyToExecute",
          "operationCode": "MIXER PRICIPAL",
          "note": "string",
          "requestedQuantity": 9707,
          "producedGoodQuantity": 9700,
          "properties": [],
          "materials": [
            {
              "code": "62-01060",
              "sequence": 8,
              "quantity": 297.86,
              "isReadOnly": true,
              "hasBatch": true,
              "consumedRawMaterials": [
                {
                  "quantity": 200.00,
                  "serialNumber": "62-01060-00000001"
                },
                {
                  "quantity": 97.86,
                  "serialNumber": "62-01060-00000002"
                }
              ]
            },
            {
              "code": "62-01221",
              "sequence": 9,
              "quantity": 2.81,
              "isReadOnly": true,
              "hasBatch": true,
              "consumedRawMaterials": [
                {
                  "quantity": 2.81,
                  "serialNumber": "62-01221-00000001"
                }
              ]
            }
          ]
        }
      ],
      "serialNumber": "1364378293-00000001",
      "customer": "UNILEVER",
      "promiseDate": "2019-08-24T14:15:22.123Z"
    }
  ]
}

4. Sincronização de Inventário de Materiais#

Este endpoint atualiza o estoque de materiais, incluindo localização, lote e validade.
Endpoint: /api/v1/MaterialInventories/synchronize
Método: POST

Exemplo de Payload#

{
  "materialsInventories": [
    {
      "materialCode": "13-00822",
      "updateOnly": true,
      "inventories": [
        {
          "location": "W20",
          "address": "W20-01",
          "batch": "20260226",
          "availableQuantity": 297.86,
          "readyToUse": true,
          "expiryDate": "2026-02-26"
        }
      ]
    },
    {
      "materialCode": "62-01060",
      "updateOnly": true,
      "inventories": [
        {
          "location": "W20",
          "address": "W20-01",
          "batch": "20260226",
          "availableQuantity": 7735,
          "readyToUse": true,
          "expiryDate": "2026-02-26"
        }
      ]
    },
    {
      "materialCode": "62-01073",
      "updateOnly": true,
      "inventories": [
        {
          "location": "Q20",
          "address": "Q20-01",
          "batch": "20260226",
          "availableQuantity": 6707,
          "readyToUse": true,
          "expiryDate": "2026-02-26"
        }
      ]
    }
  ]
}
Modificado em 2026-03-05 01:37:30
Página anterior
O que são as propriedades?
Próxima página
SKUs e Insumos
Built with