Pular para o conteúdo
platform
PT EN

Referência da API · Clientes · Gestão de Clientes

Buscar Cliente por Documento

Método
GET
Rota
/v1/customer/document/:document
URL base
https://ws.autorei.net
Parâmetros de rota
:document
Token
Exige token Bearer
Testar no Postman

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

Busca um cliente da sua loja pelo documento e devolve o cadastro completo, com endereços e vínculos de preço.

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
document string Sim CPF ou CNPJ do cliente, sem pontuação. Ver a regra abaixo.

Regras de negócio

O documento vai sem pontuação

Envie só os dígitos: 70041364856, não 700.413.648-56. Um CNPJ pontuado carrega uma barra (29.893.264/0001-01), que parte o caminho em dois segmentos, a requisição não chega a este endpoint e você recebe 404 {"status":"NOT_FOUND","message":"Serviço não encontrado"}, que é a resposta de rota inexistente, não de cliente inexistente.

Resposta · 200

A resposta vem envelopada em customer, {"customer": { ... }}.

Campo Tipo Descrição
id integer Id do cliente na CWS.
document string CPF ou CNPJ do cliente.
documentType string pf ou pj.
name string Nome ou razão social.
tradingName string Nome fantasia.
contactName string Nome do contato.
email string E-mail de acesso do cliente.
phone string Telefone, já formatado ((31) 99999-9999).
dateCreated string Data e hora do cadastro.
active boolean Se o cliente está ativo.
passwordExpired boolean Se a senha está marcada como expirada.
stateRegistration string Inscrição estadual. Vem "isento" quando não informada.
cnae string CNAE do cliente.
paysIcms boolean Se é contribuinte de ICMS.
genre string Gênero.
birthdate string Data de nascimento.
politicallyExposedPerson boolean Se é pessoa politicamente exposta.
federalEmployee boolean Se é servidor público federal.
optinTracking boolean Se aceita acompanhamento por mensagem.
trackingPhone string Telefone do acompanhamento.
optinPath string Origem do consentimento.
address array Endereços do cliente, no mesmo formato de GET /customer/addresses/:document.
customerRegistrationAddress objeto Endereço de cadastro.
priceRuleTag array Tags de preço do cliente. Vem null quando não há vínculo.
customerTypeList array Tipos de cliente vinculados. null quando não há vínculo.
customerGroupList array Grupos de cliente vinculados. null quando não há vínculo.

Erros

Código Quando
404 Documento sem cadastro na sua loja.
401 Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request GET 'https://ws.autorei.net/v1/customer/document/:document' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: pessoa física

{
  "customer": {
    "id": 4470601,
    "document": "700.413.648-56",
    "documentType": "pf",
    "name": "Ana Paula Ribeiro",
    "tradingName": null,
    "contactName": "Ana Paula Ribeiro",
    "email": "ana.ribeiro@exemplo.com.br",
    "phone": "(11) 98765-4321",
    "dateCreated": "2026-09-01T13:42:07Z",
    "active": true,
    "passwordExpired": false,
    "stateRegistration": "isento",
    "cnae": null,
    "paysIcms": false,
    "genre": "F",
    "birthdate": "1988-04-12",
    "politicallyExposedPerson": false,
    "federalEmployee": false,
    "optinTracking": true,
    "trackingPhone": "(11) 98765-4321",
    "optinPath": "API",
    "address": [
      {
        "id": 4470701,
        "name": "Endereço de cadastro",
        "zipcode": "01310-100",
        "street": "Avenida Paulista",
        "number": "1578",
        "complement": "Conjunto 42",
        "quarter": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "principal": true,
        "addressType": "RESIDENTIAL",
        "farmerStateRegistration": null,
        "howToReachLocationDescription": null,
        "responsibleContact": null,
        "attributes": {},
        "dateCreated": "2026-09-01T13:42:07Z",
        "lastUpdated": "2026-09-01T13:42:07Z"
      }
    ],
    "customerRegistrationAddress": {
      "id": 4470701,
      "name": "Endereço de cadastro",
      "zipcode": "01310-100",
      "street": "Avenida Paulista",
      "number": "1578",
      "complement": "Conjunto 42",
      "quarter": "Bela Vista",
      "city": "São Paulo",
      "state": "SP",
      "principal": true,
      "addressType": "RESIDENTIAL",
      "farmerStateRegistration": null,
      "howToReachLocationDescription": null,
      "responsibleContact": null,
      "attributes": {},
      "dateCreated": "2026-09-01T13:42:07Z",
      "lastUpdated": "2026-09-01T13:42:07Z"
    },
    "priceRuleTag": null,
    "customerTypeList": null,
    "customerGroupList": null
  }
}

Usado em

Endpoints relacionados

← Ver o grupo: Clientes

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.