Referência da API · Clientes · Endereços

Listar Endereços do Cliente

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

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

Descrição

Lista os endereços de um cliente da sua loja.

Parâmetros de Rota

Parâmetro	Tipo	Obrigatório	Descrição
`document`	string	Sim	CPF ou CNPJ do cliente.

Resposta · 200

Array com um objeto por endereço. Vem [] quando o cliente não tem endereço.

Campo	Tipo	Descrição
`id`	integer	Id do endereço. É o que a remoção pede.
`name`	string	Nome do endereço.
`zipcode`	string	CEP, formatado (`04543-000`).
`street` · `number` · `complement`	string	Rua, número e complemento.
`quarter` · `city` · `state`	string	Bairro, cidade e UF.
`principal`	boolean	Se é o endereço principal do cliente.
`addressType`	string	`RESIDENTIAL` ou `BUSINESS`.
`farmerStateRegistration`	string	Inscrição estadual de produtor rural. `null` quando não há.
`howToReachLocationDescription`	string	Instruções de acesso ao local. `null` quando não há.
`responsibleContact`	string	Contato responsável no endereço. `null` quando não há.
`attributes`	objeto	Atributos personalizados do endereço. Vem `{}` quando não há.
`dateCreated` · `lastUpdated`	string	Criação e última alteração, em UTC.

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/customer/addresses/:document' \
  --header 'Authorization: Bearer {{access_token}}'

Respostas de exemplo

200Sucesso: um endereço

[
  {
    "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"
  }
]

Usado em

Casos de usoCompras B2B e suprimentos: o caminho típico pela API

Endpoints relacionados

POST Adicionar Endereço ao Cliente /customer/:document/address
DELETE Remover Endereço do Cliente /customer/:document/address/:addressId
DELETE Remover Todos os Endereços do Cliente /deleteAllCustomerAddress/:document

← Ver o grupo: Clientes

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