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"
        }
      ]
    }
  ]
}

Documentação de endpoints - PlantScanner

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

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

Exemplo de Payload#

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

Exemplo de Payload#

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

Exemplo de Payload#

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

Exemplo de Payload#

Documentação de Integração de API

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

Exemplo de Payload

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

Exemplo de Payload

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

Exemplo de Payload

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

Exemplo de Payload