Consulta de movimentações via API GET

Consulta a nível de EPC

Esse endpoint permite, através de um GET HTTP no caminho /movimentation/epcs consultar as movimentações dos EPC's:

curl 'http://SERVER:PORT/api/movimentation/epcs?pageSize=300&pageIndex=0&epc=3038000000F453FFF5655B05' \
-H '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 API

É possível filtrar através de parâmetros query como no exemplo cURL acima onde é filtrado o epc epc=3038000000F453FFF5655B05.

Filtros disponiveis

• movimentationId - ID da movimentação - Ex d70b6046-c15a-45f2-81f0-99b4684df82a
• movimentationType - Tipo de movimentação
  • Opções disponíveis:
    • CREATE - Criação de EPC
    • UPDATE - Alteração de EPC
    • IN - Entrada de EPC em local
    • OUT - Saída de EPC de local
    • PARENT_IN - Vínculo de EPC Pai
    • PARENT_OUT - Desvinculo de EPC Pai
• movimentationDate - Faixa de Data e hora da movimentação no formato yyyy-MM-dd HH:mm:ss, Ex ?movimentationDate=2024-10-22 00:00:00&movimentationDate=2024-10-22 23:59:59
• batch - Lote
• status - Status do EPC
  • Opções disponíveis:
    • ACTIVE - Ativo
    • DISABLE - Inativo
    • DONE - Concluído
• fraction - Fração
• epc - EPC - Ex 3038000000F453FFF5655B05
• sku - SKU do produto - Ex 123.456
• fullDescription - Descrição do produto - Ex Cadeira Master
• placeReference - Referência do Local Atual - Ex B001
• placeName - Nome do Local Atual - Ex Local 01
• documentReference - Referência do Documento - Ex NFE0000002
• documentDescription - Descrição do Documento - Ex Nota fiscal
• costcenterReference - Referência do Centro de Custo - Ex - 1234
• costcenterName - Nome do Centro de Custo - Ex Financeiro
• alreadyRead - Movimentação Lida - true ou false
• previousPlaceReference - Referência do Local Anterior - Ex A001
• previousPlaceName - Nome do Local Anterior - Ex Local 1

Resposta em caso de sucesso

{
    "items": [
        {
            "id": "d70b6046-c15a-45f2-81f0-99b4684df82a",
            "movimentationType": "IN",
            "movimentationDate": "2024-10-22 16:23:51.477",
            "batch": null,
            "status": "ACTIVE",
            "fraction": 0.0,
            "epc": "3038000000F453FFF5655B05",
            "sku": "250191",
            "fullDescription": "250191 - 250191",
            "placeReference": "local 1",
            "placeName": "local 1",
            "documentReference": "NFE0000002",
            "documentDescription": "171024",
            "costCenterReference": null,
            "previousPlaceReference": null,
            "previousPlaceName": null,
            "costCenterName": null,
            "alreadyRead": false,
            "documentCustom": null,
            "placeCustom": null,
            "costCenterCustom": null,
            "epcCustom": {}
        },
    ]
}

Descrição dos campos

Campos da API:

• id - Identificador da movimentação
• movimentationType - Tipo da movimentação
• movimentationDate - Data da movimentação
• batch - Lote
• status - Status
• fraction - Fração
• epc - EPC
• sku - Sku do produto
• fullDescription - Descrição do produto
• placeReference - Referência do local
• placeName - Nome do local
• documentReference - Referência do documento
• documentDescription - Descrição do documento
• costCenterReference - Referência do centro de custo
• costCenterName - Nome do centro de custo
• alreadyRead - Já lido (Alterável apenas via API)
• documentCustom - Custom do do documento
• placeCustom - Custom do local
• costCenterCustom - Custom do centro de custo
• epcCustom - Custom do epc
• previousPlaceReference - Referência do local anterior do EPC
• previousPlaceName - Nome do local anterior do EPC

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