Criar uma nova Fazenda

Descrição: Criar uma nova Fazenda.

Endpoint

POST/api/v1/integration/farms/-/producers/{producer_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
producer_id	Identificador da Companhia Produtora	UUID	Sim	-
car	Cadastro Ambiental Rural	String	Sim	Campo de preenchimento obrigatório, até 255 caracteres. Não há validação de formato: o CAR precisa existir na base de CAR da Merx, caso contrário a requisição falha com message.farm.car.not-found.
state_subscription	Inscrição estadual	String	Não	Formato: inscrição-Estado. Ex: 123456-MS
name	Nome	String	Sim	Campo de preenchimento obrigatório, até 255 caracteres.
own	Tipo de propriedade	Boolean	Sim	true para própria, false para alugada
registration	Número de matricula	String	Não	Sem limite de tamanho definido pela API.
area	Área da fazenda	String	Não	Ignorado. A área é sempre derivada do CAR informado e sobrescreve o valor enviado.
latitude	Latitude da sede	String	Não	Enviada como recebida; a API não valida o formato na criação.
longitude	Longitude da sede	String	Não	Enviada como recebida; a API não valida o formato na criação.
address_type	Tipo do endereço	Enum	Não	Enumerador: FARM, WAREHOUSE, USER, COOPERATIVE, PRODUCER.
address	Endereço da fazenda	Objeto	Não	Ignorado. A API monta o endereço com a cidade e o estado obtidos do CAR.
address_id	Identificador de endereço existente	UUID	Não	Ignorado. A API cria um endereço novo a partir do CAR e sobrescreve este campo.

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "car": "MT-5107925-A1B2C3D4E5F6G7H8I9J0K1L2M3N4",
    "name": "Fazenda Boa Vista",
    "own": true,
    "state_subscription": "123456-MT",
    "registration": "REG-001",
    "area": "1500.00"
  }' \
  "https://api.merx.tech/api/v1/integration/farms/-/producers/{PRODUCER_ID}"

Java

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

String body = "{\"car\": \"MT-5107925-A1B2C3D4E5F6G7H8I9J0K1L2M3N4\", \"name\": \"Fazenda Boa Vista\", \"own\": true, \"state_subscription\": \"123456-MT\", \"registration\": \"REG-001\", \"area\": \"1500.00\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/farms/-/producers/{PRODUCER_ID}"))
    .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.body());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/farms/-/producers/{PRODUCER_ID}',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      car: 'MT-5107925-A1B2C3D4E5F6G7H8I9J0K1L2M3N4',
      name: 'Fazenda Boa Vista',
      own: true,
      state_subscription: '123456-MT',
      registration: 'REG-001',
      area: '1500.00',
    }),
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/farms/-/producers/{PRODUCER_ID}"

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

payload = {
    "car": "MT-5107925-A1B2C3D4E5F6G7H8I9J0K1L2M3N4",
    "name": "Fazenda Boa Vista",
    "own": True,
    "state_subscription": "123456-MT",
    "registration": "REG-001",
    "area": "1500.00"
}

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

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import com.merx.sdk.model.baseline.farm.CreateFarmRequest;
import com.merx.sdk.model.common.IdResponse;
import java.util.UUID;

MerxClient merx = MerxClient.builder()
    .apiKey("{SUA_API_KEY}")
    .environment(Environment.SANDBOX)
    .build();

IdResponse farm = merx.farms().create(UUID.fromString("00000000-0000-0000-0000-000000000000"), CreateFarmRequest.builder()
    .name("Fazenda Sede")
    .own(true)
    .car("PR-1234567890")
    .area("250.50")
    .build());
System.out.println(farm.getId());

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
producer_id	Identificador da Companhia Produtora	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
car	Cadastro Ambiental Rural	String	Sim
name	Nome da fazenda	String	Sim
own	Tipo de propriedade (própria/alugada)	Boolean	Sim
state_subscription	Inscrição estadual	String	Não
registration	Número de matrícula	String	Não
area	Área da fazenda	String	Não
latitude	Latitude da sede	String	Não
longitude	Longitude da sede	String	Não
address_type	Tipo do endereço	Enum	Não
address	Endereço (ignorado, derivado do CAR)	Objeto	Não
address_id	Endereço existente (ignorado)	UUID	Não

Respostas

• 200 - Ok

{
    "id": "string"
}

• 400 - Bad Request

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

• 401 - Unauthorized