VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Venda de balcão (PDV)

Busca de produtos do balcão

Busca produtos por nome, SKU ou código de barras e devolve o preço oficial do servidor para montar a venda.

O operador do balcão digita ou bipa um código e precisa achar o produto sem digitar o preço. Esta rota faz a busca no catálogo e devolve, para cada produto, o id (que vai em items[].product_id da venda) e o preço atual do servidor, em centavos.

GET/api/v1/admin/pos/products/lookupAdmin

Busca produtos para a venda de balcão

Parâmetros de consulta

qstringobrigatório
Texto da busca, com pelo menos 2 caracteres. Procura, sem diferenciar maiúsculas, em qualquer parte do nome, do SKU e do código de barras. Com menos de 2 caracteres a resposta é uma lista vazia, não um erro.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/pos/products/lookup?q=chinelo" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Produtos encontrados
json
{
  "items": [
    { "id": "4cbcf967-23e0-4705-88f7-a74a9a8c63f3", "name": "Chinelo Clássico Bege 00748", "sku": "SD-000748", "price_cents": 1990 },
    { "id": "b0159aa9-a354-49a1-a084-07459c14efc6", "name": "Chinelo Clássico Bege 02397", "sku": "SD-002397", "price_cents": 6990 }
  ]
}

Campos da resposta

itemsarray
Até 20 produtos, em ordem alfabética de nome. Vazio quando nada casa ou quando q tem menos de 2 caracteres.
items[].iduuid
Id do produto, para usar na venda.
items[].namestring
Nome do produto.
items[].skustring
SKU. Ausente se o produto não tiver.
items[].price_centsinteger
Preço de venda atual, em centavos.

Erros

StatusQuandoCorpo
401 / 403Sem token, sem privilégio, ou módulo fiscal desligado{"error":"module_disabled","module":"focusnfe"}
500Falha interna{"error":"failed to lookup products","detail":"..."}
Produto desativado também aparece

A busca exclui apenas produtos apagados. Um produto desativado no catálogo continua sendo encontrado e vendável no balcão. Se o seu fluxo deve esconder desativados, filtre no seu lado.

Veja também

  • Vendas de balcão
  • Venda de balcão: visão geral
Anterior
Vendas de balcão
Próxima
Recibos da venda
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também