v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Buscar um produto

Retorna os dados de um produto específico baseado em filtros, incluindo o campo cycle (assinatura ou avulso).

Você pode usar essa rota para buscar um produto por ID ou externalId.

get/products/get

Query parameters

idstring

Example:prod_abc123xyz

Identificador único público do produto

externalIdstring

Example:prod-123

Identificador único do produto no seu sistema

Response

Produto encontrado com sucesso.

errorstring nullable

successboolean

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

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
}