curl 'https://api.goatpay.com.br/v1/products/list?page=1&pageSize=20&status=ACTIVE&search=curso' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de produtos",
"data": {
"items": [
{
"id": "clx_product",
"name": "Curso completo",
"sku": "CURSO-001",
"price": 197,
"status": "ACTIVE",
"salesCount": 12
}
],
"page": 1,
"pageSize": 20,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Produtos
Listar produtos
Lista o catálogo de produtos com paginação.
GET
/
products
/
list
curl 'https://api.goatpay.com.br/v1/products/list?page=1&pageSize=20&status=ACTIVE&search=curso' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de produtos",
"data": {
"items": [
{
"id": "clx_product",
"name": "Curso completo",
"sku": "CURSO-001",
"price": 197,
"status": "ACTIVE",
"salesCount": 12
}
],
"page": 1,
"pageSize": 20,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
URL:
GET https://api.goatpay.com.br/v1/products/list · Permissão: products/listcurl 'https://api.goatpay.com.br/v1/products/list?page=1&pageSize=20&status=ACTIVE&search=curso' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de produtos",
"data": {
"items": [
{
"id": "clx_product",
"name": "Curso completo",
"sku": "CURSO-001",
"price": 197,
"status": "ACTIVE",
"salesCount": 12
}
],
"page": 1,
"pageSize": 20,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Query
number
Página (padrão 1).
number
Itens por página (máx. 100).
string
Nome, SKU ou descrição.
string
ACTIVE ou INACTIVE.Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Available options:
ACTIVE, INACTIVE 
