Documentação › Endpoints v1 › Listar produtos

Listar produtos

Retorna o catálogo público da loja, paginado. Apenas produtos ativos são listados.

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

Autenticação: token Bearer com a ability storefront:read + header X-Store-Slug. Ver autenticação → Limite de 300 requisições/min — ver erros e limites.

Parâmetros de Query

Parâmetro Padrão Descrição
page 1 Página da listagem
per_page 12 Itens por página (máximo 50)
sort_by created_at Campo de ordenação (created_at, title ou price)
sort_order desc Direção da ordenação (asc/desc)

Exemplo de Requisição

cURL
curl --location 'https://api.aproveicheckout.com.br/v1/products?page=1&per_page=12' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'X-Store-Slug: SLUG_DA_LOJA'

Resposta

Response 200
{
  "products": [
    {
      "id": "101",
      "productId": "101",
      "handle": "101",
      "title": "Camiseta Azul",
      "description": "Camiseta de algodão azul",
      "image": "https://loja.exemplo.com.br/storage/camiseta.jpg",
      "images": ["https://loja.exemplo.com.br/storage/camiseta.jpg"],
      "sku": "SKU123",
      "barcode": null,
      "productType": "physical",
      "availableForSale": true,
      "priceInCents": 5000,
      "compareAtPriceInCents": 7000,
      "inventoryQuantity": 12,
      "variants": [
        {
          "id": "102",
          "variantId": "102",
          "title": "Camiseta Azul M",
          "sku": "SKU123-M",
          "barcode": null,
          "image": null,
          "availableForSale": true,
          "priceInCents": 5000,
          "compareAtPriceInCents": null,
          "inventoryQuantity": 5
        }
      ],
      "createdAt": "2026-07-01T12:00:00-03:00",
      "updatedAt": "2026-07-01T12:00:00-03:00"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 12,
    "total": 1,
    "total_pages": 1
  }
}

Cada item de products segue o formato descrito em Objeto Produto. O bloco pagination traz page, per_page, total e total_pages.