Obter cupom
curl --request GET \
--url https://apiv3.usecorvex.com.br/api/v1/coupons/{couponId} \
--header 'Authorization: Bearer <token>' \
--header 'X-Store-Id: <x-store-id>'const options = {
method: 'GET',
headers: {'X-Store-Id': '<x-store-id>', Authorization: 'Bearer <token>'}
};
fetch('https://apiv3.usecorvex.com.br/api/v1/coupons/{couponId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://apiv3.usecorvex.com.br/api/v1/coupons/{couponId}"
headers = {
"X-Store-Id": "<x-store-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"coupon": {
"id": "99999999-9999-4999-8999-999999999999",
"storeId": "11111111-1111-4111-8111-111111111111",
"name": "Black Friday",
"code": "BF10",
"totalAvailable": 0,
"usedCount": 12,
"startAt": "2026-09-24T14:00:00.000Z",
"endAt": null,
"discountType": "PERCENT",
"amount": 10,
"singleUsePerCustomer": true,
"automaticApply": false,
"status": "ACTIVE",
"createdAt": "2026-09-24T14:00:00.000Z",
"updatedAt": "2026-09-24T14:00:00.000Z"
}
}
}{
"success": false,
"error": {
"message": "X-Store-Id deve ser um UUID válido",
"code": "VALIDATION_ERROR"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 400
}
}{
"success": false,
"error": {
"message": "Esta rota exige uma API Key. Use Authorization: Bearer cvx_live_...",
"code": "AUTH_API_KEY_REQUIRED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 401
}
}{
"success": false,
"error": {
"message": "Sua API Key não tem o escopo necessário para esta operação.",
"code": "AUTH_SCOPE_DENIED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 403
}
}{
"success": false,
"error": {
"message": "Recurso não encontrado",
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 404
}
}{
"success": false,
"message": "Muitas requisições. Tente novamente em instantes.",
"error": "RATE_LIMITED",
"retryAfter": 12
}Cupons
Obter cupom
GET
/
api
/
v1
/
coupons
/
{couponId}
Obter cupom
curl --request GET \
--url https://apiv3.usecorvex.com.br/api/v1/coupons/{couponId} \
--header 'Authorization: Bearer <token>' \
--header 'X-Store-Id: <x-store-id>'const options = {
method: 'GET',
headers: {'X-Store-Id': '<x-store-id>', Authorization: 'Bearer <token>'}
};
fetch('https://apiv3.usecorvex.com.br/api/v1/coupons/{couponId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://apiv3.usecorvex.com.br/api/v1/coupons/{couponId}"
headers = {
"X-Store-Id": "<x-store-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"coupon": {
"id": "99999999-9999-4999-8999-999999999999",
"storeId": "11111111-1111-4111-8111-111111111111",
"name": "Black Friday",
"code": "BF10",
"totalAvailable": 0,
"usedCount": 12,
"startAt": "2026-09-24T14:00:00.000Z",
"endAt": null,
"discountType": "PERCENT",
"amount": 10,
"singleUsePerCustomer": true,
"automaticApply": false,
"status": "ACTIVE",
"createdAt": "2026-09-24T14:00:00.000Z",
"updatedAt": "2026-09-24T14:00:00.000Z"
}
}
}{
"success": false,
"error": {
"message": "X-Store-Id deve ser um UUID válido",
"code": "VALIDATION_ERROR"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 400
}
}{
"success": false,
"error": {
"message": "Esta rota exige uma API Key. Use Authorization: Bearer cvx_live_...",
"code": "AUTH_API_KEY_REQUIRED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 401
}
}{
"success": false,
"error": {
"message": "Sua API Key não tem o escopo necessário para esta operação.",
"code": "AUTH_SCOPE_DENIED"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 403
}
}{
"success": false,
"error": {
"message": "Recurso não encontrado",
"code": "RESOURCE_NOT_FOUND"
},
"meta": {
"timestamp": "2026-09-24T14:00:00.000Z",
"status": 404
}
}{
"success": false,
"message": "Muitas requisições. Tente novamente em instantes.",
"error": "RATE_LIMITED",
"retryAfter": 12
}Authorizations
API Key no formato cvx_live_..., criada no painel Corvex. Não use JWT de sessão nem x-api-key.
Headers
UUID da loja. A chave precisa ter esta loja autorizada.
Path Parameters
UUID do cupom.
Response
Sucesso.