curl 'https://api.goatpay.com.br/v1/coupons/list?page=1&search=VERAO' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de cupons",
"data": {
"items": [{ "id": "clx_coupon", "code": "VERAO10", "discountType": "PERCENT", "discountValue": 10 }],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
Cupons
Listar cupons
Lista cupons com paginação.
GET
/
coupons
/
list
curl 'https://api.goatpay.com.br/v1/coupons/list?page=1&search=VERAO' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de cupons",
"data": {
"items": [{ "id": "clx_coupon", "code": "VERAO10", "discountType": "PERCENT", "discountValue": 10 }],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
URL:
GET https://api.goatpay.com.br/v1/coupons/list · Permissão: coupons/listcurl 'https://api.goatpay.com.br/v1/coupons/list?page=1&search=VERAO' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Lista de cupons",
"data": {
"items": [{ "id": "clx_coupon", "code": "VERAO10", "discountType": "PERCENT", "discountValue": 10 }],
"page": 1,
"pageSize": 50,
"total": 1,
"pages": 1
},
"requestId": "req_abc"
}
number
Página.
number
Tamanho (máx. 100).
string
Código do cupom.
string
Filtro de status quando aplicável.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100