Consultar saldo de produção por produto do produtor

Descrição: Retorna o saldo de produção (em toneladas) agregado por produto e safra de um produtor, incluindo saldo estimado, saldo alocado em negociações e saldo disponível.

Endpoint

GET/api/v1/integration/producers/{producer_id}:balanceByProduct

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
producer_id	Identificador da Companhia Produtora	UUID	Sim	-

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/producers/{PRODUCER_ID}:balanceByProduct"

Java

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/producers/{PRODUCER_ID}:balanceByProduct"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .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/producers/{PRODUCER_ID}:balanceByProduct',
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

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

headers = {
    "Authorization": "{SUA_API_KEY}",
}

response = requests.get(url, headers=headers)
print(response.json())

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

Respostas

• 200 - Ok

[
  {
    "harvest_name": "string",
    "product_name": "string",
    "estimated_balance": 0.000,
    "allocated_balance": 0.000,
    "available_balance": 0.000
  }
]

Campo	Descrição	Tipo
harvest_name	Nome da safra	String
product_name	Nome do produto	String
estimated_balance	Saldo estimado de produção em toneladas, calculado com base na área e produtividade da safra	Decimal (3 casas)
allocated_balance	Saldo já alocado em negociações/compromissos, em toneladas	Decimal (3 casas)
available_balance	Saldo disponível para negociação (estimated_balance - allocated_balance), em toneladas	Decimal (3 casas)

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - Not Found