v3

latestOpenAPI 3.1.02026-08-044524163.2 KB

Listar produtos

Retorna todos os produtos que você criou com suporte a paginação.

Você pode usar essa rota para visualizar todos os seus produtos, incluindo status, preços, ciclo de assinatura (quando aplicável) e demais informações.

Alternativa: Você também pode visualizar e gerenciar seus produtos pelo Dashboard da AbacatePay.

get/products/list

Query parameters

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger

Example:100

Quantidade de itens por página (1-100).

startDatestring date

Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date

Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring

Example:prod_abc123xyz

Filtrar por identificador único do produto

externalIdstring

Example:prod-123

Filtrar por identificador do produto no seu sistema

status'ACTIVE' | 'INACTIVE'

Filtrar por status do produto

Response

Lista de produtos retornada com sucesso.

successboolean

Se a requisição obteve sucesso ou não.

errorstring nullable

Example response

{
  "data": [
    {
      "externalId": "prod-123",
      "name": "Produto Exemplo",
      "description": "Descrição do produto",
      "price": 10000,
      "currency": "BRL",
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z",
      "status": "ACTIVE",
      "id": "prod_abc123xyz"
    }
  ],
  "success": true
}