Consulta de Inventário via API GET

Essas APIs estão disponíveis a partir da versão 1.33.0 do sistema e se tornam obsoletas a partir da versão 1.55.0. Para versões iguais ou superiores à 1.55.0, consulte: Consulta de Inventário V2

Consulta a nível de EPC

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

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

Resposta em caso de sucesso

{
    "items": [
        {
            "id": "ffd32f89-b147-4a20-a7d0-d3fc952082f6ffd32f89-b147-4a20-a7d0-d3fc952082f6",
            "epcId": "ffd32f89-b147-4a20-a7d0-d3fc952082f6",
            "epc": "30380000000000BFF5655B3A",
            "batch": null,
            "fraction": 0.0,
            "productId": "fd8ab592-dac3-405d-8bbc-263fad0ed1ce",
            "productReferenceId": "35ebe32c-fc1e-4ffc-8ccf-a6d692ef9a40",
            "productReference": "2",
            "productDescription": "2 - Produto 2",
            "placeId": "c5445c7c-1bf9-4bcb-8ed2-e178165f6c2e",
            "placeReference": "Local 1",
            "placeName": "Local 1",
            "inventoryPlaceId": "351615f1-097f-4a96-a2ca-ac6fd2637861",
            "inventoryPlaceReference": "Local 2",
            "inventoryPlaceName": "Local 2",
            "costcenterId": null,
            "costcenterReference": null,
            "costcenterName": null,
            "inventoryId": null,
            "inventoryStatus": null,
            "inventoryDescription": null,
            "inventoryDate": null,
            "inventoryCustom": null,
            "productCustom": null,
            "epcCustom": {},
            "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 consultar os Produtos inventariados:

curl 'http://SERVER:PORT/api/inventory/product?pageSize=100&pageIndex=0&productId=fd8ab592-dac3-405d-8bbc-263fad0ed1ce' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'

Resposta em caso de sucesso

{
    "items": [
        {
            "id": "35ebe32c-fc1e-4ffc-8ccf-a6d692ef9a4035ebe32c-fc1e-4ffc-8ccf-a6d692ef9a40",
            "productId": "fd8ab592-dac3-405d-8bbc-263fad0ed1ce",
            "productReferenceId": "35ebe32c-fc1e-4ffc-8ccf-a6d692ef9a40",
            "productReference": "2",
            "productDescription": "2 - Produto 2",
            "inventoryId": null,
            "inventoryDescription": null,
            "inventoryStatus": null,
            "inventoryDate": null,
            "placeId": "c5445c7c-1bf9-4bcb-8ed2-e178165f6c2e",
            "placeReference": "Local 1",
            "placeName": "Local 1",
            "inventoryPlaceId": "351615f1-097f-4a96-a2ca-ac6fd2637861",
            "inventoryPlaceReference": "Local 2",
            "inventoryPlaceName": "Local 2",
            "costcenterId": null,
            "costcenterName": null,
            "costcenterReference": null,
            "countEpc": 306,
            "sumFraction": 0.0,
            "productCustom": null,
            "inventoryCustom": null,
            "placeCustom": null,
            "costcenterCustom": null
        }
    ],
    "errorMessage": null
}

Descrição dos campos

Campos das duas APIs:

• productId - Identificador do produto inventariado
• productReferenceId - Identificador da referência do produto inventariado
• productReference - Referência do produto inventariado
• productDescription - Descrição do produto inventariado
• inventoryId - Identificador do inventário
• inventoryDescription - Descrição do inventário
• inventoryStatus - Status do Inventário:
  • PENDING - Pendente
  • DONE - Concluído
• inventoryDate - Data do inventário
• placeId - Identificador do local do epc inventariado
• placeReference - Referência do local do epc inventariado
• placeName - Nome do local do epc inventariado
• inventoryPlaceId - Identificador do local onde o inventário foi realizado
• inventoryPlaceReference - Referência do local onde o inventário foi realizado
• inventoryPlaceName - Nome do local onde o inventário foi realizado
• costcenterId - Identificador do Centro de Custo 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:

• epcId - Identificador do EPC inventariado
• epc - EPC inventariado
• batch - Lote do epc inventariado
• fraction - Fração do epc inventariado
• 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, incluindo campos personalizadas das tabelas envolvidas, como no exemplo cURL acima onde é filtrado o epc com &epc=30380000000000BFF5655B3A.