Detalhe do cliente

GET

Markdown (LLM)

Retorna o detalhe de um cliente.

Escopo:customers:read

Limite:300 requisições a cada 3 minutos.

Parâmetros de path

customerIdinteger

ID do cliente.

123456

Parâmetros da resposta

customerIdstring

ID do cliente.

"123456"

customerNamestring

Nome completo / razão social.

"Mariana Souza"

documentNumberstring

CPF ou CNPJ.

"12345678900"

birthDatestring

Data de nascimento.

"2026-08-22T23:34:00.000-03:00"

tradeNamestring

Nome fantasia.

"Mariana Souza"

personTypestring

Pessoa física ou jurídica.

Enum

individualPessoa física
companyPessoa jurídica

"individual"

emailstring

E-mail.

"contato@exemplo.com"

observationsstring

Observações internas sobre o cliente.

"teste"

activeboolean

Indica se o cliente está ativo.

true

Linguagem

Produção

Requisição

GET /v1/customers/{customerId}

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/customers/{customerId}",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556{
  "customerId": "123456",
  "customerName": "Mariana Souza",
  "tradeName": "Mariana Souza",
  "personType": "individual",
  "documentNumber": "12345678900",
  "email": "contato@exemplo.com",
  "phone": {
    "number": "11999990000",
    "extension": "+55"
  },
  "observations": "teste",
  "active": true,
  "balance": {
    "cashback": [
      {
        "merchantId": 39202,
        "merchantName": "Restaurante Exemplo",
        "cashback": 0.8,
        "cashbackActive": true
      }
    ],
    "rewardPoints": [
      {
        "merchantId": 39202,
        "merchantName": "Restaurante Exemplo",
        "rewardPoints": 120,
        "rewardPointsActive": true
      }
    ],
    "storeCredit": -0.5
  },
  "addresses": [
    {
      "addressId": 11707136,
      "street": "Rua das Flores",
      "number": "123",
      "neighborhood": "Centro",
      "city": "Sorocaba",
      "state": "SP",
      "postalCode": "18040370",
      "latitude": -23.5015,
      "longitude": -47.4526
    },
    {
      "addressId": 11723846,
      "street": "Rua das Flores",
      "number": "123",
      "neighborhood": "Centro",
      "city": "Sorocaba",
      "state": "SP",
      "latitude": -23.5015,
      "longitude": -47.4526
    }
  ]
}