Atualizar Endereço do Armazém
Descrição: Atualiza os dados de endereço de um armazém a partir do id do armazém.
Endpoint
PUT/api/v1/integration/warehouses/{warehouse_id}/address
Regras
| Atributos | Descrição | Tipo | Obrigatório | Validações |
|---|---|---|---|---|
| warehouse_id | Identificador do Armazém | UUID | Sim | - |
| street | Rua | String | Sim | Campo de preenchimento obrigatório. Até 255 caracteres. |
| number | Número | String | Sim | Campo de preenchimento obrigatório. Aceita texto livre (ex: S/N), até 10 caracteres. |
| complement | Complemento | String | Não | Campo opcional. Até 100 caracteres. |
| neighborhood | Bairro | String | Sim | Campo de preenchimento obrigatório. Até 100 caracteres. |
| zip_code | CEP | String | Sim | Campo de preenchimento obrigatório. Deve ter de 5 a 8 dígitos, opcionalmente seguidos de - e mais 3 dígitos (ex: 78890000 ou 78890-000). Outros separadores são recusados com 400 message.zipCode.invalid.format. |
| city | Cidade | String | Sim | Campo de preenchimento obrigatório. Até 100 caracteres. |
| state | Estado | String | Sim | Campo de preenchimento obrigatório. Sigla da UF, até 2 caracteres (ex: MT). |
| country | Pais | String | Sim | Campo de preenchimento obrigatório. Até 50 caracteres. |
| address_type | Tipo do endereço | String | Não | Ignorado. A API sempre grava o endereço como WAREHOUSE. |
Exemplo de Requisição
- cURL
- Java
- JavaScript
- Python
- SDK Java
curl -X PUT \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"street": "Av. das Indústrias",
"number": "1000",
"complement": "Galpão 3",
"neighborhood": "Distrito Industrial",
"zip_code": "78705-060",
"city": "Sorriso",
"state": "MT",
"country": "Brasil"
}' \
"https://api.merx.tech/api/v1/integration/warehouses/{warehouse_id}/address"
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
String body = "{\"street\": \"Av. das Indústrias\", \"number\": \"1000\", \"complement\": \"Galpão 3\", \"neighborhood\": \"Distrito Industrial\", \"zip_code\": \"78705-060\", \"city\": \"Sorriso\", \"state\": \"MT\", \"country\": \"Brasil\"}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.merx.tech/api/v1/integration/warehouses/{warehouse_id}/address"))
.header("Authorization", "{SUA_API_KEY}")
.header("Content-Type", "application/json")
.PUT(HttpRequest.BodyPublishers.ofString(body))
.build();
HttpClient client = HttpClient.newHttpClient();
try {
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
} catch (Exception e) {
e.printStackTrace();
}
const response = await fetch(
'https://api.merx.tech/api/v1/integration/warehouses/{warehouse_id}/address',
{
method: 'PUT',
headers: {
'Authorization': '{SUA_API_KEY}',
'Content-Type': 'application/json',
},
body: JSON.stringify({
street: 'Av. das Indústrias',
number: '1000',
complement: 'Galpão 3',
neighborhood: 'Distrito Industrial',
zip_code: '78705-060',
city: 'Sorriso',
state: 'MT',
country: 'Brasil',
}),
}
);
console.log(response.status);
import requests
url = "https://api.merx.tech/api/v1/integration/warehouses/{warehouse_id}/address"
headers = {
"Authorization": "{SUA_API_KEY}",
"Content-Type": "application/json"
}
payload = {
"street": "Av. das Indústrias",
"number": "1000",
"complement": "Galpão 3",
"neighborhood": "Distrito Industrial",
"zip_code": "78705-060",
"city": "Sorriso",
"state": "MT",
"country": "Brasil"
}
response = requests.put(url, json=payload, headers=headers)
print(response.status_code)
import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import com.merx.sdk.model.baseline.address.CreateAddressRequest;
import java.util.UUID;
MerxClient merx = MerxClient.builder()
.apiKey("{SUA_API_KEY}")
.environment(Environment.SANDBOX)
.build();
merx.warehouses().updateAddress(UUID.fromString("00000000-0000-0000-0000-000000000000"), CreateAddressRequest.builder()
.street("Rodovia BR-277")
.city("Guarapuava")
.state("PR")
.country("BR")
.build());
Parâmetros
Parâmetros de Caminho:
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| warehouse_id | Identificador do Armazém | UUID | Sim |
Parâmetros de Cabeçalho
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| Authorization | Chave de API obtida via support-api@merx.tech | String | Sim |
| Content-Type | application/json | String | Sim |
Parâmetros do Corpo
| Nome | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| street | Rua | String | Sim |
| number | Número | String | Sim |
| complement | Complemento | String | Não |
| neighborhood | Bairro | String | Sim |
| zip_code | CEP | String | Sim |
| city | Cidade | String | Sim |
| state | Estado | String | Sim |
| country | Pais | String | Sim |
| address_type | Tipo do endereço (ignorado) | String | Não |
Respostas
204 - No Content
400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
401 - Unauthorized
404 - NotFound