Listar produtos

GET /api/v1/valepix/products

Lista os produtos ativos disponíveis para uso na integração. Use o campo id retornado como product_id ao criar ou atualizar benefícios.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json

Path params

Esta rota não possui path params.

Query params

Parâmetro	Tipo	Obrigatório	Descrição
search	string	Não	Busca por nome do produto
page	number	Não	Página atual; padrão 1
limit	number	Não	Quantidade de itens por página; padrão 10

Exemplo curl

curl --request GET \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/products?search=alimentacao&page=1&limit=10"

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "products": [
      {
        "id": "00000000-0000-4000-8000-000000000201",
        "slug": "alimentacao",
        "name": "Alimentação",
        "description": "Benefício para alimentação",
        "icon": "utensils",
        "subtitle": "Alimentação diária",
        "caption": "Aceito em estabelecimentos do segmento",
        "keywords": "alimentacao, refeicao, mercado",
        "is_active": true,
        "created_at": "2026-05-08T12:00:00.000Z",
        "updated_at": "2026-05-08T12:00:00.000Z"
      }
    ],
    "meta": {
      "total": 1
    }
  }
}

meta.total informa o total encontrado. Mantenha no cliente os valores de page e limit usados na chamada.

Como usar o resultado

1. Chame GET /api/v1/valepix/products.
2. Escolha um produto retornado em data.products.
3. Envie o campo id desse produto como product_id em POST /api/v1/valepix/benefits ou PUT /api/v1/valepix/benefits/{benefit_id}.
4. Use o benefit_id retornado pela API para criar colaboradores ou confirmar lotes.

Erros comuns

HTTP	Quando acontece	Ação recomendada
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
429	Limite de chamadas excedido	Reduzir a frequência e aplicar backoff
500, 502, 503, 504	Falha temporária na consulta	Tentar novamente com backoff