Loja e Catálogo

Consulte os dados públicos da loja, o catálogo de produtos e a busca de forma programática com a API Aprovei. É a base para montar vitrines externas, integrações de storefront e agentes de IA.

https://api.aproveicheckout.com.br/v1

Autenticação: todos os endpoints desta seção exigem token Bearer com a ability storefront:read e o header X-Store-Slug. Ver autenticação →

Endpoints

Identificadores e Preços

productId, variantId e id públicos usam o identificador público do produto — o ID interno do banco nunca é exposto. Use sempre o variantId retornado por Listar produtos ou Buscar produtos para montar o carrinho em Criar checkout. Preços são retornados em centavos. O slug da loja vai em X-Store-Slug; produtos são identificados por productId e variantId, não por slug de produto.

Dados sensíveis: custos, credenciais, gateways, billing e tokens nunca fazem parte do payload público. O formato completo do produto está em Objeto Produto.

Fluxo Recomendado

1. Consulte GET /store para os dados da loja.
2. Liste o catálogo em GET /products (ou busque por termo em GET /search).
3. Monte o carrinho com os variantId retornados e gere o link em POST /cart/create-checkout.

Rate limit: 300 requisições/min por token + loja nos endpoints de storefront. Ver erros e limites →