Atualizar os dados de endereço de uma fazenda

Descrição: Atualiza os dados de endereço de uma fazenda a partir do id da fazenda.

Endpoint

PUT/api/v1/integration/farms/{farm_id}/address

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
farm_id	Identificador da fazenda	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	Não	Opcional. Só é aplicada quando a fazenda ainda não possui endereço; se já houver endereço, a API mantém a cidade atual e ignora o valor enviado.
state	Estado	String	Não	Opcional. Só é aplicado quando a fazenda ainda não possui endereço; se já houver endereço, a API mantém o estado atual e ignora o valor enviado.
country	País	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 FARM.

Exemplo de Requisição

cURL

curl -X PUT \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "street": "Estrada Rural km 10",
    "number": "10",
    "complement": "Galpão",
    "neighborhood": "Zona Rural",
    "zip_code": "78890-000",
    "city": "Sorriso",
    "state": "MT",
    "country": "Brasil"
  }' \
  "https://api.merx.tech/api/v1/integration/farms/{FARM_ID}/address"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String body = "{\"street\": \"Estrada Rural km 10\", \"number\": \"10\", \"complement\": \"Galpão\", \"neighborhood\": \"Zona Rural\", \"zip_code\": \"78890-000\", \"city\": \"Sorriso\", \"state\": \"MT\", \"country\": \"Brasil\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/farms/{FARM_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();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/farms/{FARM_ID}/address',
  {
    method: 'PUT',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      street: 'Estrada Rural km 10',
      number: '10',
      complement: 'Galpão',
      neighborhood: 'Zona Rural',
      zip_code: '78890-000',
      city: 'Sorriso',
      state: 'MT',
      country: 'Brasil',
    }),
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/farms/{FARM_ID}/address"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json"
}

payload = {
    "street": "Estrada Rural km 10",
    "number": "10",
    "complement": "Galpão",
    "neighborhood": "Zona Rural",
    "zip_code": "78890-000",
    "city": "Sorriso",
    "state": "MT",
    "country": "Brasil"
}

response = requests.put(url, json=payload, headers=headers)
print(response.status_code)

SDK Java

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.farms().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
farm_id	Identificador da fazenda	String	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	Não
state	Estado	String	Não
country	País	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