Rota para Consultar Produtos – Central de Atendimento

Nessa rota é possível consultar produtos cadastrados.

Requisição
- Método HTTP
- Endpoint
- Query string
- Headers
- Body
Resposta
- Retornos de sucesso
- Retornos de erro

Requisição

Método HTTP
GET

Endpoints

Consulta geral:
https://sped.plugstorage.com.br/api/v2/sped/produto/
Consulta por ID:
https://sped.plugstorage.com.br/api/v2/sped/produto/:id

A consulta pode ser feita:

Por ID
Por filtros na query string
Ou sem filtros

Exemplos de Uso

Consulta por protocoloLote:
https://sped.plugstorage.com.br/api/v2/sped/produto?token=token&protocoloLote=567ed8e3-cc93-410b-84fc-a9e8c2c49e2a

Consulta por ID:
https://sped.plugstorage.com.br/api/v2/sped/produto/680b95f20f5f21f40cb61ccb?token=token

Query String

Opção de buscar por parâmetros

Nome	Descrição
token	Token da SoftwareHouse
protocoloLote	(FILTRO) Valor do lote de protocolo recebido após o envio de produtos na rota POST
codigo	(FILTRO) Valor do código do produto cadastrado
ean	(FILTRO) Valor do código de barras EAN do produto cadastrado
geradoAutomaticamente	(FILTRO) True ou False. Filtra se os produtos retornados foram inseridos manualmente ou se foram processados automaticamente através das notas recebidas.
hashProximaPagina	Valor a ser preenchido para direcionar para próxima página

Só é possível utilizar um filtro por vez.
Em caso de não utilização de filtros, retornará todos os produtos cadastrados para o cliente com paginação de 50 páginas. Nesse mesmo retorno haverá o hashProximaPagina para consultar a próxima página.

Headers

Nome	Valor
Authorization	Basic encode64(email:senha)==

Body

Nenhum.

Resposta

Retornos de sucesso

Status code 200

{
  "produtos": [
    {
     "codigo": "cod1",
     "protocoloLote": "567ed8e3-cc93-410b-84fc-a9e8c2c49e2a",
     "descricao": "produto de testes 01",
     "ean": "1106209715406",
     "ncm": "12345678",
     "unidadeComercial": "UN",
     "unidadeEstoque": "UN",
     "status": "CADASTRADO",
     "id": "680b95f20f5f21f40cb61ccb"
    },
    {
     "codigo": "cod2",
     "protocoloLote": "567ed8e3-cc93-410b-84fc-a9e8c2c49e2a",
     "descricao": "produto de testes 01",
     "ean": "1106209715406",
     "ncm": "12345678",
     "unidadeComercial": "UN",
     "unidadeEstoque": "UN",
     "status": "CADASTRADO",
     "id": "680b95f30f5f21f40cb61ccc"
    },
    {
     "codigo": "cod3",
     "protocoloLote": "567ed8e3-cc93-410b-84fc-a9e8c2c49e2a",
     "descricao": "produto de testes 01",
     "ean": "1106209715406",
     "ncm": "12345678",
     "unidadeComercial": "UN",
     "unidadeEstoque": "UN",
     "status": "CADASTRADO",
     "id": "680b95f30f5f21f40cb61ccd"
    }
  ],
"hashProximaPagina": "680b95f30f5f21f40cb61ccd"
}

Retornos de erro

Status code 404

Contador não localizado

{
  "error": true,
  "message": "Nenhum(a) produto localizado(a) com os parâmetros informados."
}

Status code 401

Consulte essa documentação para saber os possíveis retornos de erros de autenticação.