Cadastrar um endereço para a fazenda

Descrição: Cadastra um endereço para a fazenda.

Endpoint

POST/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	Até 255 caracteres
number	Número	Number	Não	Apenas números
complement	Complemento	String	Não	Até 100 caracteres
neighborhood	Bairro	String	Sim	Até 100 caracteres
zip_code	CEP	String	Sim	CEP com "-"
country	País	String	Sim	Até 50 caracteres

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "street": "Estrada Rural km 5",
    "number": "5",
    "complement": "Sede",
    "neighborhood": "Zona Rural",
    "zip_code": "78890-000",
    "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 5\", \"number\": \"5\", \"complement\": \"Sede\", \"neighborhood\": \"Zona Rural\", \"zip_code\": \"78890-000\", \"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")
    .POST(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: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      street: 'Estrada Rural km 5',
      number: '5',
      complement: 'Sede',
      neighborhood: 'Zona Rural',
      zip_code: '78890-000',
      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 5",
    "number": "5",
    "complement": "Sede",
    "neighborhood": "Zona Rural",
    "zip_code": "78890-000",
    "country": "Brasil"
}

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

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	Number	Não
complement	Complemento	String	Não
neighborhood	Bairro	String	Sim
zip_code	CEP	String	Sim
country	País	String	Sim

Respostas

• 204 - No Content

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized

• 404 - NotFound