Criar Rastreabilidade

Descrição: Cria Rastreabilidade de uma ou mais Fazendas.

Endpoint

POST/api/v1/integration/traceability/-/commitments/{order_commitment_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
order_commitment_id	ID da Negociação	UUID	Sim

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "farm_id": "e168db8c-4fa2-4728-9ec3-945207fa474c",
    "producer_id": "8846b788-1438-40c8-84c3-28389063e6b8",
    "user_id": "4b5e9d45-da34-460f-98b9-bbd92f847c3b",
    "allocated_volume": 123.12,
    "unit_of_measurement": "SC"
  }' \
  "https://api.merx.tech/api/v1/integration/traceability/-/commitments/{order_commitment_id}"

Java

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

String body = "{\"farm_id\": \"e168db8c-4fa2-4728-9ec3-945207fa474c\", \"producer_id\": \"8846b788-1438-40c8-84c3-28389063e6b8\", \"user_id\": \"4b5e9d45-da34-460f-98b9-bbd92f847c3b\", \"allocated_volume\": 123.12, \"unit_of_measurement\": \"SC\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/traceability/-/commitments/{order_commitment_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/traceability/-/commitments/{order_commitment_id}',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      farm_id: 'e168db8c-4fa2-4728-9ec3-945207fa474c',
      producer_id: '8846b788-1438-40c8-84c3-28389063e6b8',
      user_id: '4b5e9d45-da34-460f-98b9-bbd92f847c3b',
      allocated_volume: 123.12,
      unit_of_measurement: 'SC',
    }),
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/traceability/-/commitments/{order_commitment_id}"

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

payload = {
    "farm_id": "e168db8c-4fa2-4728-9ec3-945207fa474c",
    "producer_id": "8846b788-1438-40c8-84c3-28389063e6b8",
    "user_id": "4b5e9d45-da34-460f-98b9-bbd92f847c3b",
    "allocated_volume": 123.12,
    "unit_of_measurement": "SC"
}

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

Parâmetros

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	Validações
farm_id	ID da Fazenda	UUID	Não	-
producer_id	ID do produtor	UUID	Sim	-
user_id	ID do usuário	UUID	Sim	-
allocated_volume	Volume alocado desejado	Number	Não	Valor decimal (tamanho total 13 com 2 casas decimais)
unit_of_measurement	Unidade de medida do volume alocado. Padrão: TON	Enum	Não	SC, KG e TON

Respostas

• 200 - Ok

{
    "id": "string"
}

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound