Consulta de Inventário via API GET

Estas api's estão disponíveis a partir da versão 1.55.0 do sistema.
Em ambas as APIs, é necessário sempre fornecer o parâmetro inventoryDescription com a descrição do inventário a ser consultado.

Consulta a nível de EPC

Esse endpoint permite, através de um GET HTTP no caminho /inventory/epc/v2 consultar os EPCs inventariados:

curl 'http://SERVER:PORT/api/inventory/epc/v2?pageSize=100&pageIndex=0&inventoryDescription=Inv' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'

Resposta em caso de sucesso

{
    "items": [
        {
            "epc": "303800000000007FF5655B02",
            "batch": null,
            "fraction": null,
            "productReference": "100",
            "productDescription": "100 - 1 - P",
            "placeReference": null,
            "placeName": null,
            "inventoryPlaceReference": "456",
            "inventoryPlaceName": "456",
            "costcenterReference": null,
            "costcenterName": null,
            "inventoryStatus": "PENDING",
            "inventoryDescription": "Inv",
            "inventoryDate": "2025-04-01",
            "inventoryCustom": null,
            "productCustom": null,
            "epcCustom": null,
            "placeCustom": null,
            "costCenterCustom": null
        }
    ],
    "errorMessage": null
}

Consulta a nível de Produto

Esse endpoint permite, através de um GET HTTP no caminho /inventory/product/v2 consultar os Produtos inventariados:

curl 'http://SERVER:PORT/api/inventory/product?pageSize=100&pageIndex=0&inventoryDescription=Inv' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'

Resposta em caso de sucesso

{
    "items": [
        {
            "productReference": "100",
            "productDescription": "100 - 1 - P",
            "inventoryDescription": "Inv",
            "inventoryStatus": "PENDING",
            "inventoryDate": "2025-04-01",
            "placeReference": null,
            "placeName": null,
            "costcenterName": null,
            "costcenterReference": null,
            "countEpc": 2,
            "sumFraction": 0.0,
            "productCustom": null,
            "inventoryCustom": null,
            "placeCustom": null,
            "costcenterCustom": null
        }
    ],
    "errorMessage": null
}

Descrição dos campos

Campos das duas APIs:

• productReference - Referência do produto inventariado
• productDescription - Descrição do produto inventariado
• inventoryDescription - Descrição do inventário
• inventoryStatus - Status do Inventário:
  • PENDING - Pendente
  • DONE - Concluído
• inventoryDate - Data do inventário
• placeReference - Referência do local do epc inventariado
• placeName - Nome do local do epc inventariado
• costcenterName - Nome do Centro de Custo inventariado
• costcenterReference - Referência do Centro de Custo inventariado
• productCustom - Campos personalizados do produto
• inventoryCustom - Campos personalizados do inventário
• placeCustom - Campos personalizados do Local
• costcenterCustom - Campos personalizados do Centro de Custo

Somente na API /inventory/epc:

• epc - EPC inventariado
• batch - Lote do epc inventariado
• fraction - Fração do epc inventariado
• inventoryPlaceReference - Referência do local onde o inventário foi realizado
• inventoryPlaceName - Nome do local onde o inventário foi realizado
• epcCustom - Campos personalizados do epc

Somente na API /inventory/product:

• countEpc - Total de EPCs inventariados desse produto
• sumFraction - Somatório das frações dos EPCs inventariados desse produto

Resposta em caso de erro

{
    "errorMessage": "Mensagem de erro"
}

Autenticação

A chamada para esses endpoints necessitam autenticação do tipo Basic(Base64 encoded) com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678

• integração:12345678 => Base64 encoded => aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
• Header de autenticação => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Parâmetros da requisição:

• SERVER - O IP ou DNS do servidor onde o sistema Valesoft está instalado
• PORT - A porta definida na instalação do sistema.
• pageIndex - Índice da página atual de resultado, iniciando em 0
• pageSize - Quantidade de itens da página atual de resultado

Filtragem dos resultados

É possível filtrar através de parâmetros query quaisquer campos presentes no resultado da api, com exceção de inventoryStatus e inventoryDate, como por exemplo filtro de epc com &epc=30380000000000BFF5655B3A.