Pular para o conteúdo
platform
PT EN

Referência da API · Clientes · Endereços

Adicionar Endereço ao Cliente

Método
POST
Rota
/customer/:document/address
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

Acrescenta um endereço ao cadastro 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.

Corpo da Requisição (JSON)

Campo Tipo Obrigatório Descrição
name string Sim Nome do endereço. Não pode ser nulo.
zipcode string Sim CEP do endereço. É o que resolve rua e bairro, ver a regra dos Correios.
number string Sim Número.
complement string Não Complemento.
street string Condicional Rua. Ver a regra dos Correios.
quarter string Condicional Bairro. Ver a regra dos Correios.
city string Não Cidade.
state string Não UF.
addressType string Não RESIDENTIAL ou BUSINESS. Não diferencia maiúsculas.
farmerStateRegistration string Não Inscrição estadual de produtor rural.
principal boolean Não Marca o endereço como principal.
howToReachLocationDescription string Não Instruções de acesso ao local.
responsibleContact string Não Contato responsável no endereço.
enabled boolean Não Endereço ativo. Ausente vale true.
addressAttributes array Não Atributos personalizados. Cada um precisa existir na configuração da sua loja.

Regras de negócio

O CEP manda no endereço

O endereço é resolvido pelos Correios a partir do zipcode, e o que os Correios devolvem substitui o que você enviou em street, quarter, city e state. Do seu payload sobrevivem apenas number e complement.

Os campos que você envia funcionam como reserva: cada um é usado só quando os Correios não trazem aquele dado para o CEP. Depois do merge, street e quarter não podem ficar vazios, se ficarem, o endereço é recusado.

CEP não encontrado também é recusado, a menos que a sua loja tenha a validação de CEP desabilitada.

addressType só aceita dois valores

RESIDENTIAL ou BUSINESS, em qualquer caixa. Qualquer outro valor é recusado com Property addressType is type-mismatched.

Resposta · 200

O endereço criado. O código é 200, não 201.

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
400 name ausente (O nome do endereço (name) não pode ser nulo), addressType fora dos dois valores, ou addressAttributes com atributo que não existe na configuração da sua loja.
404 Documento sem cadastro na sua loja.
401 Token ausente, malformado ou expirado.

Exemplo de requisição

curl --request POST 'https://ws.autorei.net/customer/:document/address' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Escritório",
  "zipcode": "01310-100",
  "street": "Avenida Paulista",
  "number": "2000",
  "complement": "12º andar",
  "quarter": "Bela Vista",
  "city": "São Paulo",
  "state": "SP",
  "addressType": "BUSINESS",
  "principal": false,
  "howToReachLocationDescription": "Entrada pela portaria B",
  "responsibleContact": "Marcos Aurélio"
}'

Respostas de exemplo

200Sucesso: endereço acrescentado

{
  "id": 4470702,
  "name": "Escritório",
  "zipcode": "01310-100",
  "street": "Avenida Paulista",
  "number": "2000",
  "complement": "12º andar",
  "quarter": "Bela Vista",
  "city": "São Paulo",
  "state": "SP",
  "principal": false,
  "addressType": "BUSINESS",
  "farmerStateRegistration": null,
  "howToReachLocationDescription": "Entrada pela portaria B",
  "responsibleContact": "Marcos Aurélio",
  "attributes": {},
  "dateCreated": "2026-09-01T13:42:07Z",
  "lastUpdated": "2026-09-01T13:42:07Z"
}

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.