Endereços da empresa
O endereço da empresa. Na tela Empresas, os campos de endereço ficam no formulário do cadastro (aba Dados de endereço). Esta página descreve os caminhos próprios de endereço, que servem ao mesmo registro. Cada empresa tem um único endereço: se ele já existir, a criação atualiza o existente, em vez de criar outro.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/customers/{customer_vendor_uuid}/addresses | Lista os endereços da empresa |
| POST | /administrative/customers/{customer_vendor_uuid}/addresses | Cadastra o endereço da empresa |
| GET | /administrative/customers/{customer_vendor_uuid}/addresses/{id} | Consulta um endereço |
| PUT | /administrative/customers/{customer_vendor_uuid}/addresses/{id} | Altera um endereço |
| DELETE | /administrative/customers/{customer_vendor_uuid}/addresses/{id} | Apaga um endereço |
| GET | /administrative/companies/{customer_vendor_uuid}/addresses | Lista os endereços da empresa (caminho equivalente) |
| POST | /administrative/companies/{customer_vendor_uuid}/addresses | Cadastra o endereço da empresa (caminho equivalente) |
| GET | /administrative/companies/{customer_vendor_uuid}/addresses/{id} | Consulta um endereço (caminho equivalente) |
| PUT | /administrative/companies/{customer_vendor_uuid}/addresses/{id} | Altera um endereço (caminho equivalente) |
| DELETE | /administrative/companies/{customer_vendor_uuid}/addresses/{id} | Apaga um endereço (caminho equivalente) |
O {customer_vendor_uuid} é o uuid da empresa. O {id} é o id numérico do endereço.
Endpoints de endereço
GET /administrative/customers/{customer_vendor_uuid}/addresses
GET /administrative/companies/{customer_vendor_uuid}/addresses
Lista os endereços da empresa. Aceita per_page e page.
Resposta: 200, lista de endereços com id, customer_vendor_id, zip_code,
street, number, complement, neighborhood, city, state e os nomes de quem
criou e alterou o registro.
POST /administrative/customers/{customer_vendor_uuid}/addresses
POST /administrative/companies/{customer_vendor_uuid}/addresses
Cadastra o endereço da empresa. Se a empresa já tiver endereço, o existente é reativado e atualizado com os campos enviados.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| zip_code | Não | Texto | CEP |
| street | Não | Texto | Endereço (rua) |
| number | Não | Texto | Número |
| complement | Não | Texto | Complemento |
| neighborhood | Não | Texto | Bairro |
| city | Não | Texto | Cidade |
| state | Não | Texto | Estado |
Resposta: 201, com o endereço.
GET /administrative/customers/{customer_vendor_uuid}/addresses/{id} e DELETE /administrative/customers/{customer_vendor_uuid}/addresses/{id}
GET /administrative/companies/{customer_vendor_uuid}/addresses/{id} e DELETE /administrative/companies/{customer_vendor_uuid}/addresses/{id}
Consultar e apagar um endereço. A exclusão é lógica.
Resposta: 200.
PUT /administrative/customers/{customer_vendor_uuid}/addresses/{id}
PUT /administrative/companies/{customer_vendor_uuid}/addresses/{id}
Altera um endereço. Envie somente os campos que mudam, com os mesmos campos da criação.
Resposta: 200, com o endereço alterado.