Obter cliente
curl --request GET \
--url https://apiv3.usecorvex.com.br/api/v1/customers/{documentNumber} \
--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/customers/{documentNumber}', 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/customers/{documentNumber}"
headers = {
"X-Store-Id": "<x-store-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"customer": {
"documentNumber": "12345678901",
"name": "Ana Silva",
"email": "ana@example.com",
"phone": "11999999999",
"documentType": "cpf",
"address": "Rua das Flores",
"addressNumber": "100",
"neighborhood": "Centro",
"complement": null,
"zipcode": "01001000",
"state": "SP",
"city": "São Paulo",
"totalOrders": 3,
"firstOrderDate": "2026-01-10T12:00:00.000Z",
"lastOrderDate": "2026-09-24T14:00:00.000Z",
"orderStats": {
"paid": 2,
"pending": 1,
"cancelled": 0,
"processing": 0,
"other": 0,
"totalSpent": 199.8
},
"lastOrder": {
"id": "66666666-6666-4666-8666-666666666666",
"status": "PAID",
"createdAt": "2026-09-24T14:00:00.000Z",
"total": 99.9,
"payment_method": "pix"
}
}
}
}{
"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
}Compradores
Obter cliente
O identificador público do cliente é o documento (CPF/CNPJ).
GET
/
api
/
v1
/
customers
/
{documentNumber}
Obter cliente
curl --request GET \
--url https://apiv3.usecorvex.com.br/api/v1/customers/{documentNumber} \
--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/customers/{documentNumber}', 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/customers/{documentNumber}"
headers = {
"X-Store-Id": "<x-store-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"customer": {
"documentNumber": "12345678901",
"name": "Ana Silva",
"email": "ana@example.com",
"phone": "11999999999",
"documentType": "cpf",
"address": "Rua das Flores",
"addressNumber": "100",
"neighborhood": "Centro",
"complement": null,
"zipcode": "01001000",
"state": "SP",
"city": "São Paulo",
"totalOrders": 3,
"firstOrderDate": "2026-01-10T12:00:00.000Z",
"lastOrderDate": "2026-09-24T14:00:00.000Z",
"orderStats": {
"paid": 2,
"pending": 1,
"cancelled": 0,
"processing": 0,
"other": 0,
"totalSpent": 199.8
},
"lastOrder": {
"id": "66666666-6666-4666-8666-666666666666",
"status": "PAID",
"createdAt": "2026-09-24T14:00:00.000Z",
"total": 99.9,
"payment_method": "pix"
}
}
}
}{
"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
Response
Cliente encontrado.